Con la nostra semplice API potete aggiungere automaticamente i partecipanti ai vostri esami e alla vostra academy e inviare loro un invito.
Linguaggio API
La nostra API accetta application/x-www-form-urlencoded o multipart/form-data e json.
API Esami
Aggiungi partecipante
Questa chiamata API funziona solo se l'accesso agli esami è impostato su Un gruppo predefinito di utenti.
Metodo HTTP: POST
Esame: https: //dashboard.easy-lms.com/?r=api/exam/addParticipant
Risposta di successo
{"success":true }
Risposta di errore
{"success":false, "error": "Esempio di errore" }
Campo - Tipo - Descrizione
- String - La chiave API generata per l'account. email - String - L'indirizzo e-mail del partecipante che si desidera aggiungere. name - String - Il nome del partecipante che si desidera aggiungere. examId - Integer - L'ID dell'esame.
Aggiungi un partecipante senza notificare
Aggiungere un partecipante all'esame senza inviargli un invito. Le credenziali di accesso saranno restituite nella risposta.
Metodo HTTP: POST
Risposta di successo
{"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": "EsameAuthenticationCode" }. }
Risposta all'errore
{"success":false, "error": "Esempio di errore"}
- Tipo - Descrizione apikey - Stringa - La chiave API generata per il proprio account. email - Stringa - L'indirizzo e-mail del partecipante che si desidera aggiungere. name - Stringa - Il nome del partecipante che si desidera aggiungere. examId - Integer - L'ID dell'esame. identifier - Stringa - L'identificativo del partecipante.
API Academy
Aggiungi partecipante
Questa chiamata API aggiunge un partecipante a un'Academy e attiva l'invio dell'e-mail di invito all'Academy. Si può anche usare questa chiamata API per aggiungere subito il partecipante a uno o più gruppi.
L'ID dell'academy e l'ID del gruppo si trovano alla fine dell'URL:
In questo esempio, l'ID dell'academy è 123 e l'ID del gruppo è 45678.
Se non viene specificato l'ID del gruppo, il partecipante viene aggiunto solo alla pagina di panoramica dei partecipanti dell'academy e del gruppo Tutti. Quando accedono all'academy, vedranno il gruppo Tutti solo se vi è stato aggiunto del contenuto.
Se non viene fornito alcun ID academy, verrà utilizzata la prima academy.
Metodo HTTP: POST
Punto finale: https: //dashboard.easy-lms.com/?r=api/academy/addParticipant
Risposta di successo
{"success":true}
Risposta di errore
{"success":false, "error": "Esempio di errore"}.
Campo - Tipo - Descrizione
apikey - Stringa - La chiave API generata per il proprio account. email - Stringa - L'indirizzo e-mail del partecipante che si desidera aggiungere. name - Stringa - Il nome del partecipante che si desidera aggiungere. groups - Stringa - Gli ID dei gruppi a cui si desidera aggiungere il partecipante. Separare gli ID dei gruppi con una virgola. Academy - Stringa - L'ID dell'academy a cui si desidera aggiungere il partecipante. Se non viene fornito alcun ID, l'impostazione predefinita è la prima academy.
Aggiungere un partecipante senza notificare
Questa chiamata API aggiunge un partecipante alla propria academy, ma non invia un invito. Il link all'invito verrà restituito nella risposta. È possibile utilizzare questa chiamata API anche per aggiungere un partecipante a uno o più gruppi della propria academy.
L'ID dell'academy e l'ID del gruppo si trovano nell'URL:
In questo esempio, l'ID dell'academy è 123 e l'ID del gruppo è 45678.
Se non viene specificato l'ID del gruppo, il partecipante viene aggiunto solo alla pagina di panoramica dei partecipanti dell'academy e al gruppo Tutti. Quando accedono all'academy, vedranno il gruppo Tutti solo se vi è stato aggiunto del contenuto.
Se non viene fornito alcun ID academy, verrà utilizzata la prima academy.
Metodo HTTP: POST
Punto finale: https: //dashboard.easy-lms.com/?r=api/academy/addParticipantWithoutNotifying
Risposta di successo
`` {
"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?..."} }``
Risposta all'errore
{"success":false, "error": "Esempio di errore" }``.
Campo - Tipo - Descrizione
- String - La chiave API generata per il proprio account. email - String - L'indirizzo email del partecipante che si desidera aggiungere. name - String - Il nome del partecipante che si desidera aggiungere. identifier - String - L'identificativo del partecipante nel proprio sistema. groups - String - Gli ID dei gruppi a cui si desidera aggiungere il partecipante. Separare gli ID dei gruppi con una virgola. Academy - Stringa - L'ID dell'academy a cui si vuole aggiungere il partecipante. Se non viene fornito alcun ID, l'impostazione predefinita è la prima academy.
Se un partecipante è già stato aggiunto all'esame o all'academy, l'API non fallirà, ma aggiornerà i dati del partecipante se l'identificatore è lo stesso.