🔑 Prerequisites
Understand how a REST API works: Here's a video that summarizes the concept in 4 minutes. ⏲️
Generate your API key. You can follow this article from our Help Center!
Note : The Edusign API key can be used in an automated system (a custom application), or via an API graphical client, like Postman
1️⃣ Add your resources (learners, trainers, form a group)
First step, add the people you want to train, the trainers who will deliver the training, create a group with the learners already created; etc.
To do this, follow our articles:
Create a learner
Create a trainer
Create a group
Add the people you want to train,
2️⃣ Create your attendance sheets
Once your contacts and learner groups are created, let's move on to creating your attendance sheets!
We will use Add a course to create our first sheet.
In the essential information to provide, we have:
The name of the sheet
The ID of the trainer. The trainer's ID is returned to you after creating your group, otherwise use Get all professors to find it.
The ID of the group(s) to attach to this sheet. The group ID is returned to you after creating your group, otherwise use Get all groups to find it.
3️⃣ Retrieve signature links and/or Send signature emails
Now, your learners and your trainer must sign. 1 problem? 2 solutions!
Send signature emails
Retrieve signature links
4️⃣ Archive your sheet
Archive your attendance sheet with the API call Lock a course. The API will then respond with success and return the link to your attendance sheet.
Go further
To go further, you have the documentation of our external API.
Feel free to try it more thoroughly on your side, or contact support for more specific requests.