Con nuestra sencilla API, puedes añadir automáticamente participantes a tu examen y a tu academia, y enviarles una invitación.
Idioma de la API
Nuestra API admite los formatos application/x-www-form-urlencoded, multipart/form-data y JSON.
API de exámenes
Añadir participante
Esta llamada a la API solo funciona si el acceso a tu examen está configurado como «Un grupo predefinido de usuarios».
Método HTTP: POST
Respuesta de éxito
{ "success":true }
Respuesta de error
{ "success":false, "error":"Ejemplo de error" }
Campo - Tipo - Descripción
- Cadena - La clave API generada para tu cuenta. email - Cadena - La dirección de correo electrónico del participante que deseas añadir. name - Cadena - El nombre del participante que deseas añadir. examId - Número entero - El ID del examen.
Añadir participante sin notificarlo
Añade un participante a tu examen sin enviarle una invitación. Las credenciales de inicio de sesión se devolverán en la respuesta.
Método HTTP: POST
Respuesta de éxito
{ "success":true, "data": { "playUrl":"[https://the.url/to/your/exam]([https://the.url/to/your/exam](https://the.url/to/your/exam))", "email":"[john@doe.com](mailto:john@doe.com)", "authenticationCode":"ExampleAuthenticationCode" } }
Respuesta de error
{ "success":false, "error":"Ejemplo de error"}
- Tipo - Descripción apikey - Cadena - La clave API generada para tu cuenta. email - Cadena - La dirección de correo electrónico del participante que deseas añadir. name - Cadena - El nombre del participante que deseas añadir. examId - Número entero - El ID del examen. identifier - Cadena de caracteres - El identificador del participante.
API de la Academia
Añadir participante
Esta llamada a la API añade un participante a una academia y activa el envío del correo electrónico de invitación a la academia. También puedes utilizar esta llamada a la API para añadir al participante a uno o varios grupos de inmediato.
El ID de la academia y el ID del grupo se encuentran al final de la URL:
En este ejemplo, el ID de la academia es 123 y el ID del grupo es 45678.
Si no se especifica ningún ID de grupo, el participante solo se añade a la página de resumen de participantes de la academia y al grupo «Todos ». Cuando inicie sesión en la academia, solo verá el grupo «Todos» si se ha añadido contenido al mismo.
Si no se proporciona ningún ID de academia, se utilizará la primera academia.
Método HTTP: POST
Respuesta de éxito
{ "success":true}
Respuesta de error
{ "success":false, "error":"Ejemplo de error"}
Campo - Tipo - Descripción
apikey - Cadena - La clave API generada para tu cuenta. email - Cadena - La dirección de correo electrónico del participante que deseas añadir. name - Cadena - El nombre del participante que deseas añadir. groups - Cadena - Los ID de los grupos a los que deseas añadir al participante. Separa los ID de grupo con una coma. academia - Cadena - El ID de la academia a la que quieres añadir al participante. Si no se proporciona ningún ID, se utiliza por defecto la primera academia.
Añadir un participante sin notificarlo
Esta llamada a la API añade un participante a tu academia, pero no envía una invitación. El enlace de invitación se incluirá en la respuesta. También puedes utilizar esta llamada a la API para añadir un participante a uno o varios grupos de tu academia.
El ID de la academia y el ID del grupo se pueden encontrar en la URL:
En este ejemplo, el ID de la academia es 123 y el ID del grupo es 45678.
Si no se especifica ningún ID de grupo, el participante solo se añade a la página de resumen de participantes de la academia y al grupo «Todos ». Cuando inicie sesión en la academia, solo verá el grupo «Todos» si se ha añadido contenido al mismo.
Si no se proporciona ningún ID de academia, se utilizará la primera academia.
Método HTTP: POST
Respuesta de éxito
`` {
"success":true, "data":{ "playUrl":"https://participant.easy-lms.com/your-academy", "email":"john@doe.com", "inviteLink":"https://participant.easy-lms.com/your-academia/set-new-password?..." } }``
Respuesta de error
{ "success":false, "error":"Ejemplo de error" }
Campo - Tipo - Descripción
- Cadena - La clave API generada para tu cuenta. email - Cadena - La dirección de correo electrónico del participante que deseas añadir. name - Cadena - El nombre del participante que deseas añadir. identifier - Cadena - El identificador del participante en tu sistema. grupos - Cadena - Los ID de los grupos a los que quieres añadir al participante. Separa los ID de los grupos con una coma.academia - Cadena - El ID de la academia a la que quieres añadir al participante. Si no se proporciona ningún ID, se utilizará por defecto la primera academia.
Si un participante ya se ha añadido al examen o a la academia, la API no dará error, pero actualizará los datos del participante si el identificador es el mismo.