Questo articolo è disponibile anche in:
Qui spieghiamo tutto sulle (nostre) API con alcuni simpatici esempi, come potete usarle e perché dovreste usarle.

1. Cos'è l'API?

API sta per Application Programming Interface. È l'interfaccia che permette alle applicazioni software di comunicare tra loro. Fondamentalmente permette di richiedere qualcosa, o di fare una domanda, dopo di che la chiamata API esegue l'azione che si suppone debba fare, dopo averle fornito le informazioni. Nel nostro caso si tratterebbe di chiedere di aggiungere un partecipante a un esame, a un corso o all'Accademia che richiede dati specifici sul partecipante.

Esempio 1

Quando si va su Facebook nel browser, una richiesta viene inviata al server remoto di Facebook. Una volta che il browser riceve la risposta, interpreta il codice e visualizza la pagina.

Per il browser, noto anche come client, il server di Facebook è un API. Ciò significa che ogni volta che si visita una pagina sul Web, si interagisce con l'API di qualche server remoto.

Una API non è la stessa della - rather server  è la parte del server che riceve le richieste e invia le risposte.

Esempio 2

Immaginate di essere seduti a un tavolo di un ristorante con un menu a scelta da cui ordinare. La cucina è la parte del "sistema" che preparerà il vostro ordine. Quello che manca è l'anello critico per comunicare il vostro ordine alla cucina e riconsegnare il cibo al vostro tavolo. È qui che entra in gioco il cameriere o l'API. Il cameriere è il messaggero - o API - che prende la vostra richiesta o ordine e dice alla cucina - il sistema - cosa fare. Poi il cameriere vi restituisce la risposta; in questo caso, è il cibo.

Per riassumere, quando un'azienda offre un'API ai propri clienti, significa semplicemente che hanno costruito un insieme di URL dedicati che restituiscono dati puri responses - meaning le risposte non conterranno il tipo di overhead di presentazione che ci si aspetterebbe in un'interfaccia utente grafica come un sito web.

2. A cosa mi serve?

Gli sviluppatori possono usare diverse API in modi diversi per costruire cose diverse. Facebook è un buon esempio; il sito ha lanciato la sua piattaforma di sviluppo chiamata F8 a maggio e ora ospita una sorprendente 10.900 applicazioni, dal famigerato Scrabulous ai giochi di messaggistica istantanea e di lotta al cibo.

Il vantaggio per il sito ospitante è che riceve molte nuove e interessanti funzionalità gratuitamente, mentre gli sviluppatori possono promuovere il loro lavoro su un sito di più alto profilo e costruire sul lavoro di qualcun altro. La maggior parte di queste applicazioni sono costruite da aziende con un proprio sito web - spesso piccole aziende con meno traffico che beneficiano del crossover. Il sito di recensioni di film Flixster, ad esempio, ha una popolare applicazione Facebook, così come Last.fm e il sito di condivisione di foto Flickr.

3. Quali sono le chiamate API di Easy LMS?

Easy LMS ha cinque chiamate API che servono diverse funzioni:

Aggiungi il partecipante all'esame (invito)
Aggiungi il partecipante all'esame Esame senza preavviso (no invito)
Aggiungi il partecipante a Corso (invito)
Aggiungi il partecipante a Academy (invito)
Aggiungi il partecipante a Academy senza preavviso (no invito)

L'API richiede che l'esame funzioni solo quando l'accesso è impostato su Un gruppo predefinito di partecipanti, o per un Corso che è solo su invito. Questo è autoesplicativo per l'Accademia. Inoltre, non è possibile utilizzare nessuna di queste chiamate per lo stesso Esame, Corso o Accademia quando un partecipante vi è già stato aggiunto. Questo perché lo scopo di queste chiamate API è quello di aggiungere partecipanti, quindi se sono già state aggiunte, la chiamata API non funziona.

Una chiamata API è composta da tre cose:

Il carico utile (i dati effettivi che vengono inviati)
Il punto finale (l'indirizzo a cui vengono inviati i dati)
La risposta (risposta di successo o di errore)

Il carico utile è l'informazione che viene inviata ad un endpoint, il che significa che i dati sono necessari per aggiungere un partecipante all'esame, al corso o all'accademia.

L'endpoint è un indirizzo web a cui vengono inviate le informazioni e la risposta indica se la chiamata API ha avuto successo o meno.

4. Webhooks

I Webhooks possono essere utilizzati insieme alle chiamate API per avviare diverse azioni. Quando viene inviato un webhook che contiene il carico utile richiesto per far funzionare una certa chiamata API, la chiamata API farà il suo lavoro e aggiungerà il partecipante. I webhooks devono essere inviati dal vostro sistema al nostro endpoint. Questo è qualcosa che dovresti impostare tu stesso nel tuo sistema.

Esempio 1 - Corso, esame, Accademia

I paragrafi che seguono fanno parte di un caso d'uso immaginario per spiegare come webhooks e API possono lavorare insieme.

Un responsabile delle risorse umane ha creato un corso ed un esame di base per i nuovi assunti. Il responsabile delle risorse umane vuole che i dipendenti seguano il corso, ma vuole che abbiano accesso all'esame solo dopo aver completato il corso. Solo dopo aver superato l'Esame vuole che i dipendenti abbiano accesso all'Accademia, che contiene Corsi ed Esami di livello intermedio ed esperto. Come si organizzano?

Per capire come impostare tutto questo abbiamo già stabilito che questi webhooks e le chiamate API saranno inviate internamente all'interno del sistema Easy LMS. Il processo è il seguente:

Il responsabile delle risorse umane deve creare un webhook che invia un carico utile all'API dell'esame dopo che il dipendente ha completato il corso. Questo webhook deve contenere solo i dati necessari per attivare la chiamata all'API dell'esame. In questo caso, utilizziamo la chiamata API Add participant to Exam (invite). Quando questo webhook è stato inviato, la chiamata API verrà attivata in caso di risposta positiva. La chiamata API aggiunge il partecipante e invia automaticamente l'invito all'esame.

Il secondo webhook che il responsabile delle risorse umane deve creare è per quando il dipendente supera l'esame con successo per accedere all'Accademia. Anche in questo caso, il carico utile di questo webhook dovrebbe contenere solo le informazioni di cui la chiamata all'API dell'Accademia necessita per aggiungere il partecipante e inviare un invito. Dopo l'invio di questo webhook ''Exam passed''', la chiamata Academy API verrà attivata, dopodiché aggiunge il partecipante e invia un invito per l'Academy.

Per riassumere:

1. Creare un webhook per il completamento del corso che viene inviato alla chiamata API dell'esame.
2. Creare un webhook per il superamento dell'esame che viene inviato alla chiamata API dell'Accademia.
3. Il dipendente segue il corso e lo completa.
4. Il webhook per il completamento del corso viene inviato a Aggiungi il partecipante all'esame (invito) endpoint della chiamata API e aggiunge e invita il partecipante all'esame.
5. Il dipendente sostiene l'esame e lo supera.
6. Il Webhook per il superamento dell'esame viene inviato all'indirizzo . Aggiungere il partecipante all'Accademia (invito).



Esempio 2 - Invio di inviti dal proprio sistema

Un cliente vuole utilizzare il nostro strumento per la formazione dei suoi (nuovi) dipendenti. Attualmente utilizzano l'impostazione predefinita Un gruppo predefinito di partecipanti per l'invio di e-mail di invito. Tuttavia, molti dipendenti percepiscono questi inviti come spam e alcune di queste e-mail finiscono anche nelle loro cartelle di spam. Il cliente vuole invece inviare questi inviti dal proprio sistema.

Il cliente crea prima di tutto un webhook che invia un carico utile all'API dell'esame - aggiungere il partecipante senza notificare. Quando un nuovo dipendente viene aggiunto al sistema, il webhook invia il carico utile all'API dell'esame che aggiunge il dipendente. La chiamata API non invia un invito a questo dipendente. Quando la chiamata API ha successo, la risposta include le credenziali di accesso. Queste credenziali di accesso devono poi essere inviate al dipendente dal proprio sistema e dall'applicazione di posta elettronica.

Questo funziona anche per i dipendenti esistenti, basta creare un webhook che invia un carico utile all'API dell'esame che attiva l'azione di aggiungere partecipanti senza notificarlo all'esame. Le credenziali di accesso restituite in risposta alla chiamata API possono poi essere inviate dal proprio sistema.

Esempio 3 - Esami di vendita

Un cliente crea gli Esami nel nostro sistema e li vende ai propri clienti dal loro sito di e-commerce. Vuole automatizzare tutto questo dopo che i suoi clienti pagano un esame.

Per automatizzare il suo processo di vendita dovrà utilizzare un webhook. Quando i suoi clienti acquistano o pagano un esame sul suo sito web di e-commerce, vengono aggiunti al suo sistema. Il webhook che crea deve essere attivato dopo che hanno pagato. Questo webhook invierà quindi il relativo carico utile alla chiamata API dell'esame e dovrà restituire una (n) risposta di successo o di errore. Se la risposta è positiva, la chiamata API aggiunge e invita i suoi clienti all'esame per il quale hanno pagato.



5. Quando utilizziamo ciascuna delle chiamate API e quali sono le loro specifiche?

Poiché ogni chiamata API ha una funzione diversa, può essere utilizzata per ottenere cose diverse. Ad esempio, Add participant to Exam (invite) può essere utilizzato per aggiungere un partecipante e inviare automaticamente un invito per un esame quando questo trigger viene attivato.

La nostra API accetta applicazioni/x-wwww-form-urlencoded o multipart/form-data e json.

Per saperne di più sulle nostre chiamate API per esami e accademia, consultare questo articolo.

Per saperne di più sulla nostra chiamata API del corso, consultare questo articolo.
È stato utile questo articolo?
Annulla
Grazie!