Eduframe

Eduframe 是商业培训提供商和商学院的完整解决方案，用于吸引更多学生、管理和自动化课程管理，并提供最终的学习体验。 Eduframe 与 Canvas LMS 无缝集成。 连接器提供了将现有软件应用程序与 Eduframe（例如 CRM 和会计软件）轻松集成的机会。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有 逻辑应用区域 ：      - Azure 政府区域      - Azure 中国区域      - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）

联系人​​
Name	Eduframe 开发团队
URL	https://eduframe.co
Email	dev@drieam.nl

连接器元数据
发布者	Microsoft
网站	https://eduframe.co
隐私策略	https://drieam.com/security-and-privacy/
类别	Data

Eduframe 管理并自动管理商业培训提供商和商学院的课程管理。 使用此连接器，可以将不同的工具与 Eduframe 连接，以便自动管理课程、用户、发票等。

先决条件

若要使用此连接器，需要 Eduframe 许可证。 可以在此处找到有关 Eduframe 以及如何 获取许可证的详细信息。

如果已有 Eduframe 许可证，请确保已为环境启用 Azure 逻辑应用。 如果要启用此集成，可以发送电子邮件 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 获取单个课程

列出所有发票

操作 ID:

Get_invoices

获取所有发票。

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。

返回

response

array of invoice

列出所有发票增值税

操作 ID:

Get_invoice_vats

获取所有发票增值税

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。

返回

response

array of invoice_vat

列出所有帐户

操作 ID:

Get_accounts

获取所有帐户。

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。

返回

response

array of account

列出所有标签

操作 ID:

Get_labels

获取所有标签。

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。
根据标签的模型类型进行筛选	model_type		string	根据模型类型筛选标签。

返回

response

array of label

列出所有用户

操作 ID:

Get_users

获取所有用户。

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。
排序	sort		array	对结果进行排序。 使用 更改订单

返回

response

array of user

列出所有类别

操作 ID:

Get_categories

获取所有类别。

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。
排序	sort		array	对结果进行排序。 使用 更改订单

返回

response

array of category

列出所有课程

操作 ID:

Get_courses

获取所有课程。

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。
排序	sort		array	对结果进行排序。 使用 更改订单

返回

response

array of course

删除用户的身份验证

操作 ID:

Delete_authentication_by_user_id

删除用户身份验证之一。 请注意，无法删除最后一次身份验证！

参数

名称	密钥	必需	类型	说明
用户 ID	user_id	True	integer	用户的标识符。
身份验证 ID	authentication_id	True	integer	身份验证的标识符。

添加发票

操作 ID:

Post_invoices

向管理添加发票。

参数

名称	密钥	必需	类型	说明
帐户	account_id	True	number	帐户的标识符。
account_name	account_name		string	正在付款的帐户的名称。 复制到发票，因此，如果帐户名称发生更改，则不会自动更新。
货币	currency	True	string	发票的货币。
id	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	发票底部显示的便笺。

返回

Body

invoice

添加发票增值税

操作 ID:

Post_invoice_vats

添加可在发票上使用的发票增值税。

参数

名称	密钥	必需	类型	说明
id	id		integer	发票增值税的唯一标识器。
姓名	name	True	string	发票增值税的名称。
百分比	percentage	True	string	表示增值税百分比的数字。

返回

Body

invoice_vat

添加帐户

操作 ID:

Post_accounts

将帐户添加到管理。

参数

名称	密钥	必需	类型	说明
姓名	name	True	string	帐户名称。
电子邮件	email		string	一个字符串，表示帐户的计费电子邮件。
id	id		integer	地址的唯一标识符。
收件人	addressee		string	地址的寻址者。
address	address	True	string	街道和房屋编号的串联。
postal_code	postal_code	True	string	一个表示邮政编码的字符串。
城市	city	True	string	一个表示城市的字符串。
country	country	True	string	表示国家/地区的字符串。
updated_at	updated_at		string	上次更新的时间戳。
创建时间	created_at		string	创建时间戳。

返回

Body

account

添加用户

操作 ID:

Post_users

将用户添加到管理。

参数

名称	密钥	必需	类型	说明
名字	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	id		integer	地址的唯一标识符。
收件人	addressee		string	地址的寻址者。
address	address	True	string	街道和房屋编号的串联。
postal_code	postal_code	True	string	一个表示邮政编码的字符串。
城市	city	True	string	一个表示城市的字符串。
country	country	True	string	表示国家/地区的字符串。
updated_at	updated_at		string	上次更新的时间戳。
创建时间	created_at		string	创建时间戳。
notes_user	notes_user		string	有关用户的简短说明。

返回

Body

user

添加类别

操作 ID:

Post_categories

向管理添加类别。

参数

名称	密钥	必需	类型	说明
id	id		integer	类别的唯一标识符。
Name	name	True	string	类别的标题。
Description	description		string	类别的说明。
position	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	重设大小虚拟形象的 URL（300x200^）。

返回

Body

category

添加课程

操作 ID:

Post_courses

向管理添加课程。

参数

名称	密钥	必需	类型	说明
id	id		integer	课程的唯一标识符
姓名	name	True	string	课程的名称。
position	position		number	课程的排序位置。 较低是更高的。
signup_url	signup_url		string	本课程注册页面的 URL。
slug_history	slug_history		array of string	旧唠叨列表，旧调用将被重定向。
化身	avatar		string	重设大小虚拟形象的 URL（300x200^）。
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	创建时间戳。

返回

Body

course

添加身份验证

操作 ID:

Post_authentication

向现有用户添加身份验证方法

参数

名称	密钥	必需	类型	说明
user_id	user_id	True	integer	此身份验证所属的用户的 ID。
authentication_provider_type	authentication_provider_type	True	string	身份验证提供程序的类型。
uid	uid	True	string	此身份验证的唯一标识符，该标识符对应于 IDP 中的唯一 ID。

返回

Body

authentication

获取发票

操作 ID:

Get_invoices_id

按 ID 获取单个发票。

参数

名称	密钥	必需	类型	说明
发票 ID	id	True	integer	发票的标识符。

返回

Body

invoice

获取帐户

操作 ID:

Get_accounts_id

按 ID 获取帐户。

参数

名称	密钥	必需	类型	说明
帐户 ID	id	True	integer	帐户的标识符。

返回

Body

account

获取所有目录变体

操作 ID:

Get_catalog_variants

获取所有目录变体。

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。

返回

response

array of catalog_variant

获取用户

操作 ID:

Get_users_id

按 ID 获取单个用户。

参数

名称	密钥	必需	类型	说明
用户 ID	id	True	integer	用户的标识符。

返回

Body

user

获取用户的身份验证

操作 ID:

Get_authentications_by_user_id

获取属于特定用户的身份验证列表。

参数

名称	密钥	必需	类型	说明
页码	page		integer	要获取的页码。
每页记录数	per_page		integer	每页记录数。
用户 ID	user_id	True	integer	用户的标识符。

返回

response

array of authentication

获取类别

操作 ID:

Get_categories_id

按 ID 获取类别

参数

名称	密钥	必需	类型	说明
类别 ID	id	True	integer	类别的标识符。

返回

Body

category

获取课程

操作 ID:

Get_courses_id

按 ID 获取单个课程

参数

名称	密钥	必需	类型	说明
课程 ID	id	True	integer	课程的标识符。

返回

Body

course

触发器

订阅 Webhook

订阅 Webhook 以获取记录更新的通知。

订阅 Webhook

操作 ID:

Post_webhooks

订阅 Webhook 以获取记录更新的通知。

参数

名称	密钥	必需	类型	说明
id	id		string	Webhook 的唯一标识符。 （UUID）。
活跃	active		boolean	Webhook 的状态。
events	events	True	array of string	应触发此 Webhook 的事件数组。

返回

Body

webhook_payload

定义

帐户

名称	路径	类型	说明
id	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

名称	路径	类型	说明
id	id	integer	地址的唯一标识符。
收件人	addressee	string	地址的寻址者。
address	address	string	街道和房屋编号的串联。
postal_code	postal_code	string	一个表示邮政编码的字符串。
城市	city	string	一个表示城市的字符串。
country	country	string	表示国家/地区的字符串。
updated_at	updated_at	string	上次更新的时间戳。
创建时间	created_at	string	创建时间戳。

身份验证

名称	路径	类型	说明
id	id	integer	身份验证的唯一标识符。
user_id	user_id	integer	此身份验证所属的用户的 ID。
authentication_provider_id	authentication_provider_id	integer	身份验证提供程序的 ID。
uid	uid	string	此身份验证的唯一标识符，该标识符对应于 IDP 中的唯一 ID。
如果为此登录名启用了 OTP。	otp_enabled		如果身份验证提供程序为 Eduframe，则指示是否为此登录名启用了一次密码，对于任何其他提供程序都为 false。
updated_at	updated_at	string	上次更新的时间戳。
创建时间	created_at	string	创建时间戳。

customField

名称	路径	类型	说明
id	id	integer	注册答案的唯一标识符。
value	value	string	答案的格式值。
signup_question_id	signup_question_id	integer	问题的唯一标识符。

分类

名称	路径	类型	说明
id	id	integer	类别的唯一标识符。
Name	name	string	类别的标题。
Description	description	string	类别的说明。
position	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	重设大小虚拟形象的 URL（300x200^）。

课程

名称	路径	类型	说明
id	id	integer	课程的唯一标识符
姓名	name	string	课程的名称。
position	position	number	课程的排序位置。 较低是更高的。
signup_url	signup_url	string	本课程注册页面的 URL。
化身	avatar	string	重设大小虚拟形象的 URL（300x200^）。
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	创建时间戳。

用户

名称	路径	类型	说明
id	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	avatar_url	string	虚拟形象的相对 URL 路径。
updated_at	updated_at	string	上次更新的时间戳。
创建时间	created_at	string	创建时间戳。

发票

名称	路径	类型	说明
id	id	integer	发票的唯一标识符。
reference_id	reference_id	string	发票的引用 ID。 用于查找发票。
帐户	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

名称	路径	类型	说明
id	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

名称	路径	类型	说明
id	id	integer	发票增值税的唯一标识器。
姓名	name	string	发票增值税的名称。
百分比	percentage	string	表示增值税百分比的数字。

catalog_variant

名称	路径	类型	说明
id	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	如果应该在网站上发布该类别。

标签

名称	路径	类型	说明
id	id	number	标签的唯一标识符
Name	name	string	标签的名称。
颜色	color	string	标签颜色的十六进制代码。
型号	model_type	string	此标签可用的模型类型。
updated_at	updated_at	string	上次更新的时间戳。
创建时间	created_at	string	创建时间戳。

webhook_payload

名称	路径	类型	说明
教育家	educator	string	教师的污点。
事件	event	string	触发 Webhook 的事件的类型。
entity_type	entity_type	string	触发 Webhook 的模型的类型。
entity_id	entity_id	number	触发 Webhook 的模型的唯一标识符。
租户ID	tenant_id	string	教师的 UUID。