Dela via


Eduframe

Eduframe is a complete solution for commercial training providers & business schools to attract more students, manage & automate the course administration, and deliver the ultimate learning experience. Eduframe seamlessly integrates with Canvas LMS. The connector opens up the opportunity to easily integrate your existing software applications with Eduframe, like your CRM and accounting software.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Eduframe Development Team
URL https://eduframe.co
Email dev@drieam.nl
Connector Metadata
Publisher Microsoft
Website https://eduframe.co
Privacy policy https://drieam.com/security-and-privacy/
Categories Data

Eduframe manages & automates course administration for commercial training providers and business schools. Using this connector it is possible to connect different tools together with Eduframe to automatically manage courses, users, invoices and more.

Prerequisites

To make use of this connector, you will need an Eduframe license. You can find more information about Eduframe and how to get a license here.

If you already have an Eduframe license, make sure that Azure Logic Apps are enabled for your environment. If you want to enable this integration, you can email support@eduframe.nl.

How to get credentials

If you use this connector for the first time, you will be asked to log in to Eduframe and authorize this connector. Once authorized, you will be able to use this connector and all of its features.

Get started with your connector

Eduframe provides webhooks that act as triggers for your automations. We can create a new flow that will trigger every time a new user is added to Eduframe. When creating a new flow, you can select this connector and choose 'Subscribe to webhook' as a trigger. Then under 'events Item' select 'user.created'. You can add more, but for now we are only interested in this one.

Next, we want to know which user was added to eduframe. To do this we can add a new step from this connector called 'Get a user'. This step will require an ID from a user. We can use the entity ID from the webhook.

Now that we know who the new user is in Eduframe, we can send this person an email. As an example we will use the outlook connector, but this could be any mail provider. Add a new step and select 'Send an email'. Here we can fill in the email from the user, a subject and the email that we want to send. Note that in the body of the email you can use other attributes from the user like the first name and last name.

When we're done writing the email, we can save this flow. Now every time a new user is added to Eduframe, this person will receive a welcome email.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add a category

Add a category to your administration.

Add a course

Add a course to your administration.

Add a user

Add a user to your administration.

Add an account

Add an account to your administration.

Add an authentication

Add an authentication method to an existing user

Add an invoice

Add an invoice to your administration.

Add an invoice vat

Add an invoice vat which can be used on the invoice.

Delete an authentication of a user

Delete one of the authentications of an user. Note that you cannot delete the last authentication!

Get a category

Get a category by id

Get a course

Get a single course by id

Get a user

Get a single user by id.

Get all catalog variants

Get all catalog variants.

Get an account

Get an account by id.

Get an invoice

Get a single invoice by id.

Get the authentications of a user

Get a list of authentications that belong to a specific user.

List all accounts

Get all accounts.

List all categories

Get all categories.

List all courses

Get all courses.

List all invoice vats

Get all invoice vats

List all invoices

Get all invoices.

List all labels

Get all labels.

List all users

Get all users.

Add a category

Add a category to your administration.

Parameters

Name Key Required Type Description
id
id integer

Unique identifier of the category.

Name
name True string

Title of the category.

Description
description string

The description of the category.

position
position number

Sorting position of the category. Lower is higher.

parent_id
parent_id number

Unique identifier of the parent category

avatar
avatar string

URL to the category avatar.

Published
is_published boolean

If the category should be published on the website.

courses_count
courses_count number

Number of courses directly linked to this category.

children_count
children_count number

Number of children categories directly linked to this category.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

avatar_url
avatar_url string

URL to a resized avatar image (300x200^).

Returns

Body
category

Add a course

Add a course to your administration.

Parameters

Name Key Required Type Description
id
id integer

Unique identifier of the course

name
name True string

The name of the course.

position
position number

Sorting position of the course. Lower is higher.

signup_url
signup_url string

URL to the signup page for this course.

slug_history
slug_history array of string

List of old slugs, old calls will be redirected.

avatar
avatar string

URL to a resized avatar image (300x200^).

certificate_template_id
certificate_template_id number

Identifier of the optionally linked certificate template.

Category
category_id True number

Identifier of the category of the course.

code
code True string

The code of the course.

cost
cost string

The price to be paid for this course.

cost_scheme
cost_scheme string

How should the course be paid by default.

is_published
is_published boolean

Boolean representing the publishable status of the course.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

Returns

Body
course

Add a user

Add a user to your administration.

Parameters

Name Key Required Type Description
First name
first_name True string

First name of the user.

Middle name
middle_name string

Middle name of the user.

Last name
last_name True string

Last name of the user.

Email
email True string

The e-mail of the user.

Phone number
phone string

The telephone number of the user.

Subscribe for newsletter
wants_newsletter boolean

Does the user want to receive newsletters?

Create authentication
with_authentication boolean

Create an authentication for the user, such that the user is able to login.

locale
locale string

The locale of the user.

label_ids
label_ids array of number
id
id integer

Unique identifier of the address.

addressee
addressee string

The addressee of the address.

address
address True string

Concatenation of the street and house number.

postal_code
postal_code True string

A string representing the postal code.

city
city True string

A string representing the city.

country
country True string

A string representing the country.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

notes_user
notes_user string

Short note about the user.

Returns

Body
user

Add an account

Add an account to your administration.

Parameters

Name Key Required Type Description
name
name True string

The account name.

email
email string

A string representing the billing e-mail of the account.

id
id integer

Unique identifier of the address.

addressee
addressee string

The addressee of the address.

address
address True string

Concatenation of the street and house number.

postal_code
postal_code True string

A string representing the postal code.

city
city True string

A string representing the city.

country
country True string

A string representing the country.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

Returns

Body
account

Add an authentication

Add an authentication method to an existing user

Parameters

Name Key Required Type Description
user_id
user_id True integer

The id of the user that this authentication belongs to.

authentication_provider_type
authentication_provider_type True string

The type of the authentication provider.

uid
uid True string

The unique identifier of this authentication that corresponds the a unique id from the IDP.

Returns

Add an invoice

Add an invoice to your administration.

Parameters

Name Key Required Type Description
Account
account_id True number

Identifier of the account.

account_name
account_name string

The name of the account that is paying. Is copied to the invoice and is thus not automatically updated if the account name changes.

currency
currency True string

The currency of the invoice.

id
id integer

Unique identifier of the invoice item.

Units
units True number

The number of units of the invoice item.

Description
name True string

The name of the invoice item.

Price
unit_price True string

The price of a single unit.

Vat
invoice_vat_id number

Identifier of the invoice vat.

Catalog Variant
catalog_variant_id number

Identifier of the catalog variant.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

feature
feature string

Some description of the invoice which is displayed on the invoice.

footnote
footnote string

The note displayed at the bottom of the invoice.

Returns

Body
invoice

Add an invoice vat

Add an invoice vat which can be used on the invoice.

Parameters

Name Key Required Type Description
id
id integer

Unique idenitfier of the invoice vat.

name
name True string

Name of the invoice vat.

percentage
percentage True string

Number representing the VAT percentage.

Returns

Delete an authentication of a user

Delete one of the authentications of an user. Note that you cannot delete the last authentication!

Parameters

Name Key Required Type Description
User id
user_id True integer

Identifier of the user.

Authentication id
authentication_id True integer

Identifier of the authentication.

Get a category

Get a category by id

Parameters

Name Key Required Type Description
Category Id
id True integer

Identifier of the category.

Returns

Body
category

Get a course

Get a single course by id

Parameters

Name Key Required Type Description
Course id
id True integer

Identifier of the course.

Returns

Body
course

Get a user

Get a single user by id.

Parameters

Name Key Required Type Description
User id
id True integer

Identifier of the user.

Returns

Body
user

Get all catalog variants

Get all catalog variants.

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

Returns

Get an account

Get an account by id.

Parameters

Name Key Required Type Description
Account id
id True integer

Identifier of the account.

Returns

Body
account

Get an invoice

Get a single invoice by id.

Parameters

Name Key Required Type Description
Invoice id
id True integer

Identifier of the invoice.

Returns

Body
invoice

Get the authentications of a user

Get a list of authentications that belong to a specific user.

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

User id
user_id True integer

Identifier of the user.

Returns

List all accounts

Get all accounts.

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

Returns

response
array of account

List all categories

Get all categories.

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

Sort
sort array

Sort the results. Change order by using <sort_by>:[asc|desc]

Returns

List all courses

Get all courses.

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

Sort
sort array

Sort the results. Change order by using <sort_by>:[asc|desc]

Returns

response
array of course

List all invoice vats

Get all invoice vats

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

Returns

List all invoices

Get all invoices.

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

Returns

response
array of invoice

List all labels

Get all labels.

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

Filter on model type of the label
model_type string

Filter labels based on model type.

Returns

response
array of label

List all users

Get all users.

Parameters

Name Key Required Type Description
Page number
page integer

Page number to get.

Records per page
per_page integer

Number of records per page.

Sort
sort array

Sort the results. Change order by using <sort_by>:[asc|desc]

Returns

response
array of user

Triggers

Subscribe to a webhook

Subscribe to a webhook to get notified on record updates.

Subscribe to a webhook

Subscribe to a webhook to get notified on record updates.

Parameters

Name Key Required Type Description
id
id string

Unique identifier of the webhook. (a UUID).

active
active boolean

State of webhook.

events
events True array of string

Array of events that should trigger this webhook.

Returns

Definitions

account

Name Path Type Description
id
id integer

Unique identifier of the account.

name
name string

The account name.

email
email string

A string representing the billing e-mail of the account.

account_type
account_type string

The account type.

address
address address
phone
phone string

A string representing the phone number of the account.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

signup_answers
signup_answers array of customField

List of signup answers for this account.

address

Name Path Type Description
id
id integer

Unique identifier of the address.

addressee
addressee string

The addressee of the address.

address
address string

Concatenation of the street and house number.

postal_code
postal_code string

A string representing the postal code.

city
city string

A string representing the city.

country
country string

A string representing the country.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

authentication

Name Path Type Description
id
id integer

Unique identifier of the authentication.

user_id
user_id integer

The id of the user that this authentication belongs to.

authentication_provider_id
authentication_provider_id integer

The id of the authentication provider.

uid
uid string

The unique identifier of this authentication that corresponds the a unique id from the IDP.

If OTP is enabled for this login.
otp_enabled

In case auth provider is Eduframe, indicates if one time password is enabled for this login, is false for any other providers.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

customField

Name Path Type Description
id
id integer

Unique identifier of the signup answer.

value
value string

The formatted value of the answer.

signup_question_id
signup_question_id integer

Unique identifier of the question.

category

Name Path Type Description
id
id integer

Unique identifier of the category.

Name
name string

Title of the category.

Description
description string

The description of the category.

position
position number

Sorting position of the category. Lower is higher.

parent_id
parent_id number

Unique identifier of the parent category

avatar
avatar string

URL to the category avatar.

Published
is_published boolean

If the category should be published on the website.

courses_count
courses_count number

Number of courses directly linked to this category.

children_count
children_count number

Number of children categories directly linked to this category.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

avatar_url
avatar_url string

URL to a resized avatar image (300x200^).

course

Name Path Type Description
id
id integer

Unique identifier of the course

name
name string

The name of the course.

position
position number

Sorting position of the course. Lower is higher.

signup_url
signup_url string

URL to the signup page for this course.

avatar
avatar string

URL to a resized avatar image (300x200^).

certificate_template_id
certificate_template_id number

Identifier of the optionally linked certificate template.

Category
category_id number

Identifier of the category of the course.

code
code string

The code of the course.

cost
cost string

The price to be paid for this course.

cost_scheme
cost_scheme string

How should the course be paid by default.

is_published
is_published boolean

Boolean representing the publishable status of the course.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

user

Name Path Type Description
id
id integer

Unique identifier of the user.

Employee number
employee_number string

The employee number of this user.

First name
first_name string

First name of the user.

Middle name
middle_name string

Middle name of the user.

Last name
last_name string

Last name of the user.

Email
email string

The e-mail of the user.

Phone number
phone string

The telephone number of the user.

labels
labels array of label
Subscribe for newsletter
wants_newsletter boolean

Does the user want to receive newsletters?

Create authentication
with_authentication boolean

Create an authentication for the user, such that the user is able to login.

locale
locale string

The locale of the user.

address
address address
Avatar
avatar_url string

The relative url path to the avatar.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

invoice

Name Path Type Description
id
id integer

Unique identifier of the invoice.

reference_id
reference_id string

Reference id of the Invoice. Is used to find the invoice.

Account
account_id number

Identifier of the account.

number
number string

The invoice number which is unique per educator. If left empty, it autoincrements.

number_int
number_int number

The invoice number converted to an integer value.

status
status string

The status of the invoice. The initial status will always be concept.

expiration_date
expiration_date string

The expiration date of the invoice. Is set when the invoice is set to open.

opened_at
opened_at string

The date when the invoice status was changed to open.

description
description string

Human readable description of the invoice.

account_name
account_name string

The name of the account that is paying. Is copied to the invoice and is thus not automatically updated if the account name changes.

currency
currency string

The currency of the invoice.

total_incl
total_incl string

The total cost of the invoice including VAT.

total_excl
total_excl string

The total cost of the invoice excluding VAT.

total_open
total_open string

The open cost of the invoice including VAT.

pdf_url
pdf_url string

Url to the download path of the invoice in PDF format.

xml_url
xml_url string

Url to the download path of the invoice in UML format.

feature
feature string

Some description of the invoice which is displayed on the invoice.

footnote
footnote string

The note displayed at the bottom of the invoice.

invoice_items
invoice_items array of invoice_item
updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

invoice_item

Name Path Type Description
id
id integer

Unique identifier of the invoice item.

Units
units number

The number of units of the invoice item.

Description
name string

The name of the invoice item.

Price
unit_price string

The price of a single unit.

Vat
invoice_vat_id number

Identifier of the invoice vat.

Catalog Variant
catalog_variant_id number

Identifier of the catalog variant.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

invoice_vat

Name Path Type Description
id
id integer

Unique idenitfier of the invoice vat.

name
name string

Name of the invoice vat.

percentage
percentage string

Number representing the VAT percentage.

catalog_variant

Name Path Type Description
id
id number

Unique identifier of the catalog variant

product_id
product_id number

Unique identifier of the catalog product

name
name string

The name of the course.

cost_scheme
cost_scheme string

How should the catalog variant be paid by default.

cost
cost string

The price to be paid for this catalog variant.

currency
currency string

The currency of the catalog variant.

variantable_type
variantable_type string

The currency of the invoice.

variantable_id
variantable_id number

Unique identifier of the variantable.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

Published
is_published boolean

If the category should be published on the website.

label

Name Path Type Description
id
id number

Unique identifier of the label

Name
name string

The name of the label.

Color
color string

Hex code of the color of the label.

Model
model_type string

The model type for which this label is made available.

updated_at
updated_at string

Timestamp of last update.

created_at
created_at string

Timestamp of creation.

webhook_payload

Name Path Type Description
educator
educator string

Slug of the educator.

event
event string

Type of event that triggerd the webhook.

entity_type
entity_type string

Type of the model that triggerd the webhook.

entity_id
entity_id number

Unique identifier of the model that triggerd the webhook.

tenant_id
tenant_id string

UUID of the educator.