How to automate processes on the EduMe platform 

Intro

This guide will give you an overview of how to automate common tasks on the EduMe platform.

Background

Create users

There are 3 ways to create users:

  • Manually in our admin panel (users can be added individually or in batch with a CSV file)
  • Use our API
  • Share an open link which will allow anyone to sign up

Assign content to users

There are 2 ways to assign content to users:

  • Team assignment: courses and users can both be assigned to teams. Users have access to all courses in the teams they're assigned to
  • Individual enrolment: users can be directly enrolled on a course. To do this the course must be marked as such (contact us to set this up) and a course link must be shared with the user - when they use the link they'll be automatically enrolled

Share content with users

If your learners use our app, they will get a notification whenever a new course becomes available to them. If your learners use web, you should share a course link with them (described below).

Using our API

Detailed documentation for our endpoints is available here

To authenticate with our API you will need to set an X-API-KEY header. Contact us to get an api key.

Create a user

Example usage:

curl -X POST https://edume-api.herokuapp.com/public/team/1/user \
-H "X-API-KEY: my-api-key" \
-d "firstName=Api&lastName=Testing&email=api@testing.com&sendInvite=true"

This will assign the user to the team that was specified.

By default we will send the user an invite email or SMS once created. If you'd prefer to handle the initial communication yourself, you can disable our invite by setting sendInvite to false. Then you can share a course link with them which will allow them to activate (see next section).

Details: https://edume.docs.apiary.io/#reference/users/user-creation/create-a-user

You can use our courseLink endpoint to get a link for a user to go to a course. If the user is new they will be prompted to set up a password when they click the link. If they've already activated then they'll be dropped straight into the course.

Example of endpoint usage:

curl -X GET https://edume-api.herokuapp.com/user/1/course/1/courseLink \
-H "X-API-KEY: my-api-key"

Details: https://edume.docs.apiary.io/#reference/links/course-links/generate-a-course-link-for-a-user

View group details

You can get a breakdown of your group details & teams. Example usage:

curl -X GET https://edume-api.herokuapp.com/public/groups \
-H "X-API-KEY: my-api-key"

This will give you the ids of your groups and teams which can be used in other endpoints.

Details: https://edume.docs.apiary.io/#reference/groups/get-group/get-group-details,-with-teams

View courses

You can retrieve a list of all your courses. Example usage:

curl -X GET https://edume-api.herokuapp.com/public/courses \
-H "X-API-KEY: my-api-key"

This will give you details on all your courses, including their title, whether they've been published, their id and courseKey and the teams they're assigned to.

Details: https://edume.docs.apiary.io/#reference/courses/list-courses/list-courses

View user progress stats

You can retrieve user completion results for a course. Example usage:

curl -X GET https://edume-api.herokuapp.com/v2/public/stats/course/my-course-key \
-H "X-API-KEY: my-api-key"

This returns a CSV with rows for each user, including the datetime they completed each lesson & their scores.

Details: https://edume.docs.apiary.io/#reference/stats/progress-stats/progress-csv-for-course

Update a user

Example usage:

curl -X PUT https://edume-api.herokuapp.com/public/users/1 \
-H "X-API-KEY: my-api-key" \
-d "firstName=Api2&lastName=Testing&email=api@testing.com"

Details: https://edume.docs.apiary.io/#reference/users/user-management/update-a-user

Delete a user

Example usage:

curl -X DEL https://edume-api.herokuapp.com/public/users/1 \
-H "X-API-KEY: my-api-key"

Details: https://edume.docs.apiary.io/#reference/users/user-management/delete-a-user

Non-API options

An open course link allows anyone to sign themselves up to the platform. When a person clicks the link they're prompted to enter their details (name & email or phone) and they're automatically assigned to a team & enrolled on the course if required. Once they've created their account they'll immediately start on a course. If they're an existing user, they log straight in.

This greatly simplifies your workflow as all you have to do is share a link with your users - no management of them is required. Share the link in an SMS, put it on your website, write it as grafitti in your office toilet block - it's up to you. But you don't have as much control over who accesses your learning materials - if someone gets hold of the link, they can sign up.

To get an open course link contact us.

Webhooks

Webhooks can be configured for course completion events. Events get triggered when a user completes every lesson in a course, and every time they redo a lesson in a course after that.

The event contains details of the user, course, group and timestamp.

To set this up, let us know the webhook url you'd like to use.

Our requests are signed with an X-EduMe-Signature header, to enable you to verify the webhooks originate from EduMe. You'll be sent a secret when your webhooks are first configured. The signature is a MAC, and can be verified using the secret and the request body.