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 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. nombre - Cadena - El nombre del participante que desea añadir. examId - Número entero - El ID del Examen.
Añadir un participante sin notificárselo
Añade un participante a tu examen sin enviarle una invitación. Las credenciales de inicio de sesión se incluirán en la respuesta.
Método HTTP: POST
Punto de conexión: https://dashboard.easy-lms.com/?r=api/exam/addParticipantWithoutNotifying
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 - Entero - El ID del examen. identifier - Cadena - 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 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
Punto de conexión: https://dashboard.easy-lms.com/?r=api/academy/addParticipant
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 quieres añadir. name - Cadena - El nombre del participante que quieres añadir. groups - Cadena - Los ID de los grupos a los que quieres añadir al participante. Separa los ID de grupo con una coma. academy - 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.
Añadir 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 Resumen de participantes de la Academia y al grupo Todos. Cuando inicie sesión en la academia, solo verá el grupo Todos si se le ha añadido contenido.
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-academy/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 ya se ha añadido un participante al examen o a la Academia, la API no dará error, pero actualizará los datos del participante si el identificador es el mismo.