Grazie alla nostra semplice API puoi aggiungere automaticamente i partecipanti al tuo esame e alla tua Academy e inviare loro un invito.
Lingua dell'API
La nostra API accetta application/x-www-form-urlencoded o multipart/form-data e json.
API dell’esame
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 e-mail del partecipante che desideri aggiungere. nome - Stringa - Il nome del partecipante che desideri aggiungere. examId - Numero intero - L’ID dell’Esame.
Aggiungi un partecipante senza avvisarlo
Aggiungi un partecipante al tuo esame senza inviargli un invito. Le credenziali di accesso verranno restituite nella risposta.
Metodo HTTP: POST
Endpoint: https://dashboard.easy-lms.com/
r=api/esami/addParticipantWithoutNotifying" target="_blank" class="intercom-content-link">https://dashboard.easy-lms.com/?r=api/esami/addParticipantWithoutNotifying
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 dell’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. È inoltre possibile utilizzare questa chiamata API per aggiungere immediatamente il partecipante a uno o più gruppi.
L’ID dell’Academy e l’ID del gruppo sono riportati alla fine dell’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 vi sono stati aggiunti dei contenuti.
Se non viene fornito alcun ID dell’Academy, verrà utilizzata la prima Academy.
Metodo HTTP: POST
Endpoint: https://dashboard.easy-lms.com/
r=api/academy/addParticipant" target="_blank" class="intercom-content-link">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 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 specificato alcun ID, il valore predefinito è la prima Academy.
Aggiungi partecipante senza inviare notifica
Questa chiamata API aggiunge un partecipante alla tua Academy, ma non invia un invito. Il link di invito verrà restituito nella risposta. È inoltre possibile utilizzare questa chiamata API per aggiungere un partecipante a uno o più gruppi della propria Academy.
L'ID dell'Academy e l'ID del gruppo sono riportati nell'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à il gruppo Tutti solo se vi sono stati aggiunti dei contenuti.
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. gruppi - 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.