Con nuestra sencilla API puede añadir automáticamente participantes a su examen y academia y enviarles una invitación.
Lenguaje de la API
Nuestra API acepta application/x-www-form-urlencoded o multipart/form-data y json.
API de exámenes
Añadir participante
Esta llamada a la API sólo funciona si el acceso a su examen está configurado para Un grupo predefinido de usuarios.
Método HTTP: POST
Punto final: https: //dashboard.easy-lms.com/?r=api/exam/addParticipant
Respuesta de éxito
{ "success":true }
Respuesta de error
{ "success":false, "error": "Ejemplo de error" }
Campo - Tipo - Descripción
- String - La clave API generada para su cuenta. email - String - La dirección de correo electrónico del participante que desea añadir. name - String - El nombre del participante que desea añadir. examId - Integer - El ID del Examen.
Añadir participante sin notificar
Agregue un participante a su examen sin enviarle una invitación. Las credenciales de inicio de sesión se devolverán en la respuesta.
Método HTTP: POST
Punto final: https: //dashboard.easy-lms.com/?r=api/exam/addParticipantWithoutNotifying
Respuesta de éxito
{ "éxito":true, "datos": {"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": "Error de ejemplo"}
- Tipo - Descripción apikey - Cadena - La clave de API generada para su cuenta. email - Cadena - La dirección de correo electrónico del participante que desea añadir. name - Cadena - El nombre del participante que desea 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 puede utilizar esta llamada a la API para añadir al participante a uno o varios grupos inmediatamente.
El ID de academia y el ID de grupo pueden encontrarse al final de la URL:
En este ejemplo, el ID de academia es 123 y el ID de grupo es 45678.
Si no se especifica un ID de grupo, el participante sólo se añadirá a la página de resumen de participantes de la academia y al grupo Todos. Cuando inicien sesión en la academia, sólo verán el grupo Todos si se le ha añadido contenido.
Si no se proporciona un ID de academia, se utilizará la primera academia.
Método HTTP: POST
Punto final: https: //dashboard.easy-lms.com/?r=api/academy/addParticipant
Respuesta de éxito
{"éxito":true}
Respuesta de error
{ "success":false, "error": "Error de ejemplo"}
Campo - Tipo - Descripción
apikey - Cadena - La clave API generada para su cuenta. email - Cadena - La dirección de correo electrónico del participante que desea añadir. name - Cadena - El nombre del participante que desea añadir. groups - Cadena - Los ID de los grupos a los que desea añadir el participante. Separe los ID de grupo con una coma. academia - Cadena - El ID de la academia a la que desea añadir el participante. Por defecto es la primera academia si no se proporciona ningún ID.
Añadir participante sin notificar
Esta llamada a la API añade un participante a su academia, pero no envía una invitación. El enlace de invitación se devolverá en la respuesta. También puede utilizar esta llamada a la API para añadir un participante a uno o varios grupos de su academia.
El ID de la academia y el ID del grupo pueden encontrarse en la URL:
En este ejemplo, el ID de academia es 123 y el ID de grupo es 45678.
Si no se especifica un ID de grupo, el participante sólo se añadirá a la página de resumen de participantes de la academia y al grupo Todos. Cuando inicien sesión en la academia, sólo verán el grupo Todos si se le ha añadido contenido.
Si no se proporciona un ID de academia, se utilizará la primera academia.
Método HTTP: POST
Punto final: https: //dashboard.easy-lms.com/?r=api/academy/addParticipantWithoutNotifying
Respuesta satisfactoria
`` {
"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": "Error de ejemplo" }
Campo - Tipo - Descripción
- Cadena - La clave API generada para su cuenta. email - Cadena - La dirección de correo electrónico del participante que desea añadir. name - Cadena - El nombre del participante que desea añadir. identifier - Cadena - El identificador del participante en su sistema. groups - Cadena - Los ID de los grupos a los que desea añadir el participante. Separe los IDs de grupo con una coma.academia - Cadena - El ID de la academia a la que quiere añadir el participante. Por defecto es la primera academia si no se proporciona un ID.
Si ya se ha añadido un participante al examen o academia, la API no fallará, pero actualizará los datos del participante si el identificador es el mismo.