With our simple API you can automatically add participants to your exam and academy and send them an invitation.
API Language
Our API accepts application/x-www-form-urlencoded or multipart/form-data and json.
Exam API
Add participant
This API call only works if the access to your exam is set to A predefined group of users.
HTTP method: POST
Success response
{
"success":true
}
Error response
{
"success":false,
"error":"Example error"
}
Field - Type - Description
- String - The generated API key for your account. email - String - The email address of the participant you want to add. name - String - The name of the participant you want to add. examId - Integer - The ID of the Exam.
Add participant without notifying
Add a participant to your exam without sending them an invitation. The login credentials will be returned in the response.
HTTP method: POST
Success response
{
"success":true,
"data":
{
"playUrl":"[https://the.url/to/your/exam]([https://the.url/to/your/exam](https://the.url/to/your/exam))",
"email":"[[email protected]](mailto:[email protected])",
"authenticationCode":"ExampleAuthenticationCode"
}
}
Error response
{
"success":false,
"error":"Example error"
}
- Type - Description apikey - String - The generated API key for your account. email - String - The email address of the participant you want to add. name - String - The name of the participant you want to add. examId - Integer - The ID of the Exam. identifier - String - The identifier for the participant.
Academy API
Add participant
This API call adds a participant to an academy and triggers that the academy invitation email is sent to them. You can also use this API call to add the participant to one or more groups right away.
The academy ID and group ID can be located at the end of the URL:
In this example, the academy ID is 123, and the group ID is 45678.
If no Group ID is specified, the participant is only added to the Participant overview page of the academy and the Everyone group. When they log in to the academy, they will only see the Everyone group if content has been added to it.
If no academy ID is provided, the first academy will be used.
HTTP method: POST
Success response
{
"success":true
}
Error response
{
"success":false,
"error":"Example error"
}
Field - Type - Description
apikey - String - The generated API key for your account. email - String - The email address of the participant you want to add. name - String - The name of the participant you want to add. groups - String - The IDs of the groups you want to add the participant to. Separate group IDs with a comma. academy - String - The ID of the academy you want to add the participant to. Defaults to the first academy if no ID is provided.
Add participant without notifying
This API call adds a participant to your academy, but doesn't send an invitation. The invitation link will be returned in the response. You can also use this API call to add a participant to one or more groups in your academy.
The academy ID and group ID can be located in the URL:
In this example, the academy ID is 123, and the group ID is 45678.
If no Group ID is specified, the participant is only added to the Participant overview page of the academy and the Everyone group. When they log in to the academy, they will only see the Everyone group if content has been added to it.
If no academy ID is provided, the first academy will be used.
HTTP method: POST
Success response
`` {
"success":true, "data":{ "playUrl":"https://participant.easy-lms.com/your-academy", "email":"[email protected]", "inviteLink":"https://participant.easy-lms.com/your-academy/set-new-password?..." } }``
Error response
{ "success":false, "error":"Example error" }
Field - Type - Description
- String - The generated API key for your account. email - String - The email address of the participant you want to add. name - String - The name of the participant you want to add. identifier - String - The identifier for the participant in your system. groups - String - The IDs of the groups you want to add the participant to. Separate group IDs with a comma. academy - String - The ID of the academy you want to add the participant to. Defaults to the first academy if no ID is provided.
If a participant has already been added to the exam or academy, the API won’t fail, but it will update the participant data if the identifier is the same.