共用方式為

Eduframe

Eduframe 是商業培訓提供商和商學院的完整解決方案，可吸引更多學生、管理和自動化課程管理並提供終極學習體驗。 Eduframe 與 Canvas LMS 無縫整合。 該連接器提供了輕鬆將現有軟體應用程式與 Eduframe 整合的機會，例如 CRM 和會計軟體。

此連接器適用於以下產品和區域：

服務 Class Regions
副駕駛工作室 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 （DoD）
Power Apps 進階 除下列區域外的所有 Power Apps 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
連絡人​​
名稱 Eduframe 開發團隊
URL https://eduframe.co
Email dev@drieam.nl
連接器中繼資料
Publisher Microsoft
網站 https://eduframe.co
隱私策略 https://drieam.com/security-and-privacy/
類別 資料

Eduframe 管理和自動化商業培訓提供商和商學院的課程管理。 使用此連接器，可以將不同的工具與 Eduframe 連接在一起，以自動管理課程、用戶、發票等。

先決條件

要使用此連接器，您需要 Eduframe 許可證。 您可以在 此處找到有關 Eduframe 以及如何獲得許可證的更多信息。

如果您已經擁有 Eduframe 授權，請確定已針對您的環境啟用 Azure Logic Apps。 如果您想啟用此整合，您可以傳送電子郵件至 support@eduframe.nl。

如何取得認證

如果您是第一次使用此連接器，系統會要求您登入 Eduframe 並授權此連接器。 獲得授權後，您將能夠使用此連接器及其所有功能。

開始使用連接器

Eduframe 提供 Webhook 作為自動化的觸發器。 我們可以建立一個新流程，每次將新使用者新增至 Eduframe 時都會觸發該流程。 建立新流程時，您可以選取此連接器，然後選擇 [訂閱 Webhook] 作為觸發程序。 然後在「事件項目」下選擇「user.created」。 您可以添加更多，但目前我們只對這個感興趣。

接下來，我們想知道哪個用戶被添加到 eduframe。 為此，我們可以從此連接器新增一個名為「取得使用者」的新步驟。 此步驟將需要使用者的 ID。 我們可以使用 Webhook 中的實體 ID。

現在我們知道 Eduframe 中的新用戶是誰，我們可以向此人發送電子郵件。 例如，我們將使用 Outlook 連接器，但這可以是任何郵件提供者。 新增步驟並選擇「傳送電子郵件」。 在這裡我們可以填寫來自用戶的電子郵件、主題和我們要發送的電子郵件。 請注意，在電子郵件正文中，您可以使用使用者的其他屬性，例如名字和姓氏。

當我們寫完電子郵件後，我們可以儲存此流程。 現在，每次將新用戶添加到 Eduframe 時，此人都會收到一封歡迎電子郵件。

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

列出所有使用者

取得所有使用者。
列出所有帳戶

取得所有帳戶。
列出所有標籤

取得所有標籤。
列出所有發票

取得所有發票。
列出所有發票大桶

取得所有發票大桶
列出所有課程

獲取所有課程。
列出所有類別

獲取所有類別。
刪除使用者的驗證

刪除使用者的其中一個驗證。 請注意，您無法刪除上次的身份驗證！
取得使用者

依 ID 取得單一使用者。
取得使用者的驗證

取得屬於特定使用者的驗證清單。
取得帳戶

通過 ID 獲取帳戶。
取得所有目錄子類

取得所有目錄變體。
取得發票

通過 ID 獲取單個發票。
取得課程

通過 id 獲取單門課程
取得類別

依 ID 取得類別
新增使用者

將使用者新增至您的管理。
新增帳戶

將帳戶新增至您的管理。
新增發票

將發票新增至您的管理。
新增發票加值稅

新增可用於發票的發票增值稅。
新增課程

將課程新增至您的管理。
新增類別

將類別新增至您的管理。
新增驗證

將驗證方法新增至現有使用者

列出所有使用者

作業識別碼：
Get_users

取得所有使用者。

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。
排序
 sort array

對結果進行排序。 使用 <sort_by>:[asc|desc]

傳回

response
array of user

列出所有帳戶

作業識別碼：
Get_accounts

取得所有帳戶。

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。

傳回

response
array of account

列出所有標籤

作業識別碼：
Get_labels

取得所有標籤。

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。
根據標籤的型號類型進行篩選
 model_type string

根據模型類型篩選標籤。

傳回

response
array of label

列出所有發票

作業識別碼：
Get_invoices

取得所有發票。

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。

傳回

response
array of invoice

列出所有發票大桶

作業識別碼：
Get_invoice_vats

取得所有發票大桶

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。

傳回

response
array of invoice_vat

列出所有課程

作業識別碼：
Get_courses

獲取所有課程。

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。
排序
 sort array

對結果進行排序。 使用 <sort_by>:[asc|desc]

傳回

response
array of course

列出所有類別

作業識別碼：
Get_categories

獲取所有類別。

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。
排序
 sort array

對結果進行排序。 使用 <sort_by>:[asc|desc]

傳回

response
array of category

刪除使用者的驗證

作業識別碼：
Delete_authentication_by_user_id

刪除使用者的其中一個驗證。 請注意，您無法刪除上次的身份驗證！

參數

名稱 機碼 必要 類型 Description
使用者識別碼
 user_id True integer

使用者的識別碼。
驗證ID
 authentication_id True integer

驗證的識別碼。

取得使用者

作業識別碼：
Get_users_id

依 ID 取得單一使用者。

參數

名稱 機碼 必要 類型 Description
使用者識別碼
 id True integer

使用者的識別碼。

傳回

身體
user

取得使用者的驗證

作業識別碼：
Get_authentications_by_user_id

取得屬於特定使用者的驗證清單。

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。
使用者識別碼
 user_id True integer

使用者的識別碼。

傳回

response
array of authentication

取得帳戶

作業識別碼：
Get_accounts_id

通過 ID 獲取帳戶。

參數

名稱 機碼 必要 類型 Description
帳戶標識碼
 id True integer

帳戶的識別碼。

傳回

身體
account

取得所有目錄子類

作業識別碼：
Get_catalog_variants

取得所有目錄變體。

參數

名稱 機碼 必要 類型 Description
頁碼
 page integer

要取得的頁碼。
每頁記錄數
 per_page integer

每頁的記錄數。

傳回

response
array of catalog_variant

取得發票

作業識別碼：
Get_invoices_id

通過 ID 獲取單個發票。

參數

名稱 機碼 必要 類型 Description
發票識別碼
 id True integer

發票的識別碼。

傳回

身體
invoice

取得課程

作業識別碼：
Get_courses_id

通過 id 獲取單門課程

參數

名稱 機碼 必要 類型 Description
課程標識碼
 id True integer

課程的標識符。

傳回

身體
course

取得類別

作業識別碼：
Get_categories_id

依 ID 取得類別

參數

名稱 機碼 必要 類型 Description
類別識別碼
 id True integer

類別的識別碼。

傳回

身體
category

新增使用者

作業識別碼：
Post_users

將使用者新增至您的管理。

參數

名稱 機碼 必要 類型 Description
名字
 first_name True string

使用者的名字。
中間名
 middle_name string

使用者的中間名。
姓氏
 last_name True string

使用者的姓氏。
Email
 email True string

使用者的電子郵件。
電話號碼
 phone string

使用者的電話號碼。
訂閱電子報
 wants_newsletter boolean

用戶想要接收電子報嗎？
建立驗證
 with_authentication boolean

為使用者建立驗證，讓使用者能夠登入。
地區設定
 locale string

使用者的地區設定。
label_ids
 label_ids array of number
識別碼
 id integer

地址的唯一識別碼。
收件人
 addressee string

地址的收件人。
address
 address True string

街道和門牌號的串聯。
郵遞區號
 postal_code True string

代表郵遞區號的字串。
city
 city True string

代表城市的字串。
country
 country True string

代表國家/地區的字串。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。
notes_user
 notes_user string

關於用戶的簡短說明。

傳回

身體
user

新增帳戶

作業識別碼：
Post_accounts

將帳戶新增至您的管理。

參數

名稱 機碼 必要 類型 Description
名稱
 name True string

帳戶名稱。
電子郵件
 email string

代表帳戶帳單電子郵件的字串。
識別碼
 id integer

地址的唯一識別碼。
收件人
 addressee string

地址的收件人。
address
 address True string

街道和門牌號的串聯。
郵遞區號
 postal_code True string

代表郵遞區號的字串。
city
 city True string

代表城市的字串。
country
 country True string

代表國家/地區的字串。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

傳回

身體
account

新增發票

作業識別碼：
Post_invoices

將發票新增至您的管理。

參數

名稱 機碼 必要 類型 Description
Account
 account_id True number

帳戶的識別碼。
account_name
 account_name string

正在付款的帳戶名稱。 會複製到發票中，因此如果帳戶名稱變更，則不會自動更新。
貨幣
 currency True string

發票的貨幣。
識別碼
 id integer

發票項目的唯一識別碼。
單位
 units True number

發票項目的單位數。
Description
 name True string

發票項目的名稱。
價格
 unit_price True string

單個單位的價格。
大桶
 invoice_vat_id number

發票增值稅的識別碼。
目錄變體
 catalog_variant_id number

目錄變體的識別碼。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。
功能
 feature string

發票上顯示的發票的一些描述。
註
 footnote string

發票底部顯示的附註。

傳回

身體
invoice

新增發票加值稅

作業識別碼：
Post_invoice_vats

新增可用於發票的發票增值稅。

參數

名稱 機碼 必要 類型 Description
識別碼
 id integer

發票增值稅的獨特識別器。
名稱
 name True string

發票增值稅的名稱。
百分比
 percentage True string

代表增值稅百分比的數字。

傳回

身體
invoice_vat

新增課程

作業識別碼：
Post_courses

將課程新增至您的管理。

參數

名稱 機碼 必要 類型 Description
識別碼
 id integer

課程的唯一標識符
名稱
 name True string

課程名稱。
位置
 position number

課程的排序位置。 越低越高。
signup_url
 signup_url string

本課程註冊頁面的 URL。
slug_history
 slug_history array of string

舊 slug 列表，舊呼叫將被重定向。
頭像
 avatar string

調整大小的頭像影像 （300x200^） 的 URL。
certificate_template_id
 certificate_template_id number

選擇性連結憑證範本的識別碼。
類別
 category_id True number

課程類別的識別碼。
字碼
 code True string

課程的代碼。
成本
 cost string

本課程要支付的費用。
cost_scheme
 cost_scheme string

課程默認應如何支付。
is_published
 is_published boolean

布林值代表課程的可發佈狀態。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

傳回

身體
course

新增類別

作業識別碼：
Post_categories

將類別新增至您的管理。

參數

名稱 機碼 必要 類型 Description
識別碼
 id integer

類別的唯一識別碼。
名稱
 name True string

類別的標題。
Description
 description string

類別的描述。
位置
 position number

類別的排序位置。 越低越高。
parent_id
 parent_id number

父類別的唯一識別碼
頭像
 avatar string

類別頭像的URL。
發布
 is_published boolean

該類別是否應在網站上發布。
courses_count
 courses_count number

直接連結到此類別的課程數量。
children_count
 children_count number

直接連結至此類別的子類別數目。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。
avatar_url
 avatar_url string

調整大小的頭像影像 （300x200^） 的 URL。

傳回

身體
category

新增驗證

作業識別碼：
Post_authentication

將驗證方法新增至現有使用者

參數

名稱 機碼 必要 類型 Description
user_id
 user_id True integer

此驗證所屬使用者的 ID。
authentication_provider_type
 authentication_provider_type True string

驗證提供者的類型。
uid
 uid True string

此身份驗證的唯一識別碼，對應於IDP中的唯一ID。

傳回

身體
authentication

觸發程序

訂閱 Webhook

訂閱 Webhook 以取得記錄更新的通知。

訂閱 Webhook

作業識別碼：
Post_webhooks

訂閱 Webhook 以取得記錄更新的通知。

參數

名稱 機碼 必要 類型 Description
識別碼
 id string

Webhook 的唯一識別碼。 （UUID）。
活動中
 active boolean

Webhook 的狀態。
events
 events True array of string

應該觸發此 Webhook 的事件陣列。

傳回

身體
webhook_payload

定義

帳戶

名稱 路徑 類型 Description
識別碼
 id integer

帳戶的唯一識別碼。
名稱
 name string

帳戶名稱。
電子郵件
 email string

代表帳戶帳單電子郵件的字串。
account_type
 account_type string

帳戶類型。
address
 address address
phone
 phone string

代表帳戶電話號碼的字串。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。
signup_answers
 signup_answers array of customField

此帳戶的註冊答案清單。

address

名稱 路徑 類型 Description
識別碼
 id integer

地址的唯一識別碼。
收件人
 addressee string

地址的收件人。
address
 address string

街道和門牌號的串聯。
郵遞區號
 postal_code string

代表郵遞區號的字串。
city
 city string

代表城市的字串。
country
 country string

代表國家/地區的字串。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

認證

名稱 路徑 類型 Description
識別碼
 id integer

驗證的唯一識別碼。
user_id
 user_id integer

此驗證所屬使用者的 ID。
authentication_provider_id
 authentication_provider_id integer

驗證提供者的識別碼。
uid
 uid string

此身份驗證的唯一識別碼，對應於IDP中的唯一ID。
如果為此登入啟用了 OTP。
 otp_enabled

如果身份驗證提供者是 Eduframe，則表示是否為此登入啟用了一次性密碼，對於任何其他提供者來說是 false。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

自訂欄位

名稱 路徑 類型 Description
識別碼
 id integer

註冊答案的唯一識別碼。
value
 value string

答案的格式化值。
signup_question_id
 signup_question_id integer

問題的唯一識別碼。

分類

名稱 路徑 類型 Description
識別碼
 id integer

類別的唯一識別碼。
名稱
 name string

類別的標題。
Description
 description string

類別的描述。
位置
 position number

類別的排序位置。 越低越高。
parent_id
 parent_id number

父類別的唯一識別碼
頭像
 avatar string

類別頭像的URL。
發布
 is_published boolean

該類別是否應在網站上發布。
courses_count
 courses_count number

直接連結到此類別的課程數量。
children_count
 children_count number

直接連結至此類別的子類別數目。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。
avatar_url
 avatar_url string

調整大小的頭像影像 （300x200^） 的 URL。

課程

名稱 路徑 類型 Description
識別碼
 id integer

課程的唯一標識符
名稱
 name string

課程名稱。
位置
 position number

課程的排序位置。 越低越高。
signup_url
 signup_url string

本課程註冊頁面的 URL。
頭像
 avatar string

調整大小的頭像影像 （300x200^） 的 URL。
certificate_template_id
 certificate_template_id number

選擇性連結憑證範本的識別碼。
類別
 category_id number

課程類別的識別碼。
字碼
 code string

課程的代碼。
成本
 cost string

本課程要支付的費用。
cost_scheme
 cost_scheme string

課程默認應如何支付。
is_published
 is_published boolean

布林值代表課程的可發佈狀態。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

使用者

名稱 路徑 類型 Description
識別碼
 id integer

使用者的唯一識別碼。
員工編號
 employee_number string

此使用者的員工編號。
名字
 first_name string

使用者的名字。
中間名
 middle_name string

使用者的中間名。
姓氏
 last_name string

使用者的姓氏。
Email
 email string

使用者的電子郵件。
電話號碼
 phone string

使用者的電話號碼。
labels
 labels array of label
訂閱電子報
 wants_newsletter boolean

用戶想要接收電子報嗎？
建立驗證
 with_authentication boolean

為使用者建立驗證，讓使用者能夠登入。
地區設定
 locale string

使用者的地區設定。
address
 address address
阿凡達
 avatar_url string

虛擬人偶的相對網址路徑。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

發票

名稱 路徑 類型 Description
識別碼
 id integer

發票的唯一識別碼。
reference_id
 reference_id string

發票的參考 ID。 用於尋找發票。
Account
 account_id number

帳戶的識別碼。
數字
 number string

每個教育工作者唯一的發票號碼。 如果留空，它會自動遞增。
number_int
 number_int number

發票號碼轉換為整數值。
狀態
 status string

發票的狀態。 初始狀態將始終是概念。
expiration_date
 expiration_date string

發票的到期日。 在發票設定為開啟時設定。
opened_at
 opened_at string

發票狀態變更為未結的日期。
描述
 description string

發票的人類可讀描述。
account_name
 account_name string

正在付款的帳戶名稱。 會複製到發票中，因此如果帳戶名稱變更，則不會自動更新。
貨幣
 currency string

發票的貨幣。
total_incl
 total_incl string

包含增值稅的發票總成本。
total_excl
 total_excl string

不包括增值稅的發票總成本。
total_open
 total_open string

包含增值稅的發票未結成本。
pdf_url
 pdf_url string

PDF 格式發票下載路徑的 URL。
xml_url
 xml_url string

UML 格式發票下載路徑的 URL。
功能
 feature string

發票上顯示的發票的一些描述。
註
 footnote string

發票底部顯示的附註。
invoice_items
 invoice_items array of invoice_item
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

invoice_item

名稱 路徑 類型 Description
識別碼
 id integer

發票項目的唯一識別碼。
單位
 units number

發票項目的單位數。
Description
 name string

發票項目的名稱。
價格
 unit_price string

單個單位的價格。
大桶
 invoice_vat_id number

發票增值稅的識別碼。
目錄變體
 catalog_variant_id number

目錄變體的識別碼。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

invoice_vat

名稱 路徑 類型 Description
識別碼
 id integer

發票增值稅的獨特識別器。
名稱
 name string

發票增值稅的名稱。
百分比
 percentage string

代表增值稅百分比的數字。

catalog_variant

名稱 路徑 類型 Description
識別碼
 id number

目錄變體的唯一識別碼
product_id
 product_id number

目錄產品的唯一識別碼
名稱
 name string

課程名稱。
cost_scheme
 cost_scheme string

目錄變體預設應如何付款。
成本
 cost string

此目錄變體要支付的價格。
貨幣
 currency string

目錄變體的貨幣。
variantable_type
 variantable_type string

發票的貨幣。
variantable_id
 variantable_id number

可變體的唯一識別碼。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。
發布
 is_published boolean

該類別是否應在網站上發布。

標籤

名稱 路徑 類型 Description
識別碼
 id number

標籤的唯一識別碼
名稱
 name string

標籤的名稱。
顏色
 color string

標籤顏色的十六進位代碼。
型號
 model_type string

提供此標籤的型號類型。
updated_at
 updated_at string

上次更新的時間戳記。
建立於
 created_at string

建立時間戳記。

webhook_payload

名稱 路徑 類型 Description
教育家
 educator string

教育者的蛞蝓。
事件
 event string

觸發 Webhook 的事件類型。
entity_type
 entity_type string

觸發 Webhook 的模型類型。
entity_id
 entity_id number

觸發 Webhook 之模型的唯一識別碼。
租戶_ID
 tenant_id string

教育者的 UUID。