Qui spieghiamo tutto ciò che c'è da sapere sulla (nostra) API con alcuni esempi chiari, come utilizzarla e perché dovresti usarla.

API è l'acronimo di Application Programming Interface (Interfaccia di programmazione dell'applicazione). È l’interfaccia che permette alle applicazioni software di comunicare tra loro. In sostanza, ti permette di richiedere qualcosa o di porre una domanda; a quel punto, la chiamata all’API esegue l’azione prevista, dopo che le hai fornito le informazioni necessarie.

Immagina di essere seduto a un tavolo in un ristorante con un menu tra cui scegliere. La cucina è la parte del "sistema" che preparerà la tua ordinazione. Ciò che manca è l’anello fondamentale per comunicare la vostra ordinazione alla cucina e farvi portare il cibo al tavolo. È qui che entra in gioco il cameriere, ovvero l’API. Il cameriere è il messaggero – ovvero l’API – che prende la vostra richiesta o il vostro ordine e comunica alla cucina – il sistema – cosa fare. Poi il cameriere vi consegna la risposta; in questo caso, si tratta del cibo.

Per riassumere, quando un’azienda offre un’API ai propri clienti, significa semplicemente che ha creato una serie di URL dedicati che restituiscono risposte costituite da dati puri — il che significa che le risposte non conterranno quel tipo di sovraccarico di presentazione che ci si aspetterebbe in un’interfaccia utente grafica come un sito web.

Abbiamo cinque chiamate API che svolgono diverse funzioni.

Una chiamata API è composta da tre elementi:

Il payload è l’informazione inviata a un endpoint, ovvero i dati necessari per aggiungere un partecipante.

L’endpoint è un indirizzo web a cui vengono inviate le informazioni, e la risposta indica se la chiamata all’API ha avuto esito positivo o meno.

I webhook possono essere utilizzati in combinazione con le chiamate API per avviare diverse azioni. Quando viene inviato un webhook contenente il payload necessario affinché una determinata chiamata API funzioni, la chiamata API eseguirà l’operazione e aggiungerà il partecipante. I webhook devono essere inviati dal proprio sistema al nostro endpoint e devono essere configurati autonomamente nel proprio sistema.

I paragrafi seguenti fanno parte di un caso d’uso fittizio per spiegare come i webhook e le API possano funzionare insieme.

Un responsabile delle risorse umane ha creato un corso di base e un esame per i dipendenti neoassunti. Il responsabile delle risorse umane desidera che i dipendenti seguano il corso, ma vuole che abbiano accesso all’esame solo dopo averlo completato. Solo dopo aver superato l’esame desidera che i dipendenti abbiano accesso all’Academy, che contiene corsi ed esami di livello intermedio e avanzato. Quindi, come si configura tutto questo?

Per capire come configurare il tutto, abbiamo già stabilito che questi webhook e queste chiamate API verranno inviati internamente all’interno del sistema Easy LMS. Il processo è il seguente.

Il responsabile delle risorse umane deve creare un webhook che invii un payload 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 Aggiungi partecipante all’esame (invito). Una volta inviato questo webhook, la chiamata API verrà attivata se la 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 serve per quando il dipendente supera con successo l’esame per ottenere l’accesso all’Academy. Anche in questo caso, il payload di questo webhook deve contenere solo le informazioni necessarie alla chiamata API dell’Academy per aggiungere il partecipante e inviare un invito. Dopo l’invio di questo webhook, verrà attivata la chiamata API dell’Academy, la quale aggiungerà il partecipante all’Academy e invierà un invito.

Riassumendo:

Un cliente desidera utilizzare il nostro strumento per la formazione dei propri (nuovi) dipendenti. Attualmente utilizza l’impostazione Un gruppo predefinito di partecipanti per inviare le e-mail di invito. Tuttavia, molti dipendenti considerano questi inviti come spam e alcune di queste e-mail finiscono anche nelle loro cartelle dello spam. Il cliente desidera invece inviare questi inviti dal proprio sistema.

Il cliente crea innanzitutto un webhook che invia un payload all’API degli esami - aggiungi partecipante senza notifica. Quando un nuovo dipendente viene aggiunto al proprio sistema, il webhook invia il payload all’API degli esami, che aggiunge il dipendente. La chiamata all’API non invia un invito a questo dipendente. Quando la chiamata all’API va a buon fine, la risposta include le credenziali di accesso. Queste credenziali di accesso devono quindi essere inviate al dipendente dal proprio sistema e dall’applicazione di posta elettronica.

Questo funziona anche per i dipendenti già presenti; è sufficiente creare un webhook che invii un payload all’API dell’esame, il quale attiva l’azione di aggiunta dei partecipanti senza notifica all’esame. Le credenziali di accesso restituite nella risposta alla chiamata API possono quindi essere inviate dal proprio sistema.

Un cliente crea esami nel nostro sistema e li vende ai propri clienti tramite il proprio sito di e-commerce. Desidera automatizzare questo processo dopo che i clienti hanno pagato un esame.

Per automatizzare il processo di vendita, dovrà utilizzare un webhook. Quando i suoi clienti acquistano o pagano un esame sul suo sito di e-commerce, vengono aggiunti al suo sistema. Il webhook che creano deve essere attivato dopo che hanno effettuato il pagamento. Questo webhook invierà quindi il payload pertinente alla chiamata API dell’esame e dovrà restituire una risposta di successo o di errore. Se la risposta è positiva, la chiamata API aggiunge e invita i clienti all’esame che hanno pagato.
​

La nostra API accetta application/x-www-form-urlencoded o multipart/form-data e json.

Scopri di più nei seguenti articoli: