Grazie alla nostra semplice API puoi aggiungere automaticamente i partecipanti al tuo esame e alla tua academy e inviare loro un invito.
Linguaggio API
La nostra API accetta i formati application/x-www-form-urlencoded, multipart/form-data e JSON.
API per gli esami
Aggiungi partecipante
Questa chiamata API funziona solo se l’accesso al tuo esame è impostato su “Un gruppo predefinito di utenti”.
Metodo HTTP: POST
Risposta di successo
{ "success":true }
Risposta di errore
{ "success":false, "error":"Esempio di errore" }
Campo - Tipo - Descrizione
- Stringa - La chiave API generata per il tuo account. email - Stringa - L'indirizzo email del partecipante che desideri aggiungere. name - Stringa - Il nome del partecipante che desideri aggiungere. examId - Numero intero - L'ID dell'Esame.
Aggiungi partecipante senza inviare notifica
Aggiungi un partecipante al tuo esame senza inviargli un invito. Le credenziali di accesso verranno 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":"ExampleAuthenticationCode" } }
Risposta di errore
{ "success":false, "error":"Esempio di errore"}
- Tipo - Descrizione apikey - Stringa - La chiave API generata per il tuo account. email - Stringa - L'indirizzo e-mail del partecipante che desideri aggiungere. name - Stringa - Il nome del partecipante che desideri aggiungere. examId - Numero intero - L’ID dell’Esame. identifier - Stringa - L’identificatore del partecipante.
API Academy
Aggiungi partecipante
Questa chiamata API aggiunge un partecipante a un'academy e fa sì che gli venga inviata l'e-mail di invito all'academy. Puoi anche utilizzare questa chiamata API per aggiungere immediatamente il partecipante a uno o più gruppi.
The academy ID and group ID are displayed at the end of the URL:
In questo esempio, l’ID dell’academy è 123 e l’ID del gruppo è 45678.
Se non viene specificato alcun ID gruppo, il partecipante viene aggiunto solo alla pagina di panoramica dei partecipanti dell’academy e al gruppo “Tutti ”. Quando effettuerà l’accesso all’academy, vedrà solo il gruppo “Tutti ” se sono stati aggiunti contenuti al gruppo stesso.
Se non viene fornito alcun ID dell’academy, verrà utilizzata la prima academy.
Metodo HTTP: POST
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 tuo account. email - Stringa - L'indirizzo e-mail del partecipante che desideri aggiungere. name - Stringa - Il nome del partecipante che desideri aggiungere. groups - Stringa - Gli ID dei gruppi a cui desideri 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, il valore predefinito è la prima academy.
Aggiungi un partecipante senza inviare una notifica
Questa chiamata API aggiunge un partecipante alla tua academy, ma non invia un invito. Il link di invito verrà restituito nella risposta. Puoi anche utilizzare questa chiamata API per aggiungere un partecipante a uno o più gruppi della tua academy.
The academy ID and group ID are displayed in the URL:
In questo esempio, l’ID dell’academy è 123 e l’ID del gruppo è 45678.
Se non viene specificato alcun ID gruppo, il partecipante viene aggiunto solo alla pagina Panoramica dei partecipanti dell’academy e al gruppo Tutti. Quando effettuerà l’accesso all’academy, vedrà solo il gruppo Tutti se sono stati aggiunti contenuti al gruppo stesso.
Se non viene fornito alcun ID dell’academy, verrà utilizzata la prima academy.
Metodo HTTP: POST
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 di errore
{ "success":false, "error":"Esempio di errore" }
Campo - Tipo - Descrizione
- Stringa - La chiave API generata per il tuo account. email - Stringa - L'indirizzo e-mail del partecipante che desideri aggiungere. name - Stringa - Il nome del partecipante che desideri aggiungere. identifier - Stringa - L'identificatore del partecipante nel tuo sistema. groups - Stringa - Gli ID dei gruppi a cui desideri aggiungere il partecipante. Separa gli ID dei gruppi con una virgola.academy - Stringa - L'ID dell'academy a cui desideri aggiungere il partecipante. Se non viene fornito alcun ID, viene utilizzata per impostazione predefinita la prima academy.
Se un partecipante è già stato aggiunto all’esame o all’academy, l’API non genererà un errore, ma aggiornerà i dati del partecipante se l’identificatore è lo stesso.