Qui vi spieghiamo tutto sulle (nostre) API con alcuni esempi, come potete usarle e perché dovreste usarle.

API è l'acronimo di Application Programming Interface. È l'interfaccia che consente alle applicazioni software di comunicare tra loro. In pratica, consente di richiedere qualcosa o di porre una domanda, dopodiché la chiamata API esegue l'azione prevista, dopo che le sono state fornite le informazioni.

Immaginate di essere seduti al tavolo di un ristorante con un menu di scelte da cui ordinare. La cucina è la parte del "sistema" che prepara l'ordine. Manca il collegamento critico per comunicare l'ordine alla cucina e consegnare il cibo al tavolo. È qui che entra in gioco il cameriere, o API. Il cameriere è il messaggero - o API - che riceve la richiesta o l'ordine e dice alla cucina - il sistema - cosa fare. Poi il cameriere consegna la risposta all'utente; in questo caso, si tratta del cibo.

In sintesi, quando un'azienda offre un'API ai propri clienti, significa che ha creato una serie di URL dedicati che restituiscono risposte di dati puri, ovvero le risposte non contengono il tipo di overhead di presentazione che ci si aspetterebbe in un'interfaccia grafica come un sito web.

Abbiamo cinque chiamate API che svolgono funzioni diverse.

Una chiamata API è composta da tre elementi:

Il payload è l'informazione che viene 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 API ha avuto successo o meno.

I webhook possono essere utilizzati insieme alle chiamate API per avviare diverse azioni. Quando viene inviato un webhook che contiene il payload richiesto per il funzionamento di una determinata chiamata API, la chiamata API farà il suo lavoro e aggiungerà il partecipante. I webhook devono essere inviati dal vostro sistema al nostro endpoint e devono essere impostati nel vostro sistema.

I paragrafi seguenti fanno parte di un caso d'uso fittizio per spiegare come webhook e API possono lavorare insieme.

Un responsabile delle risorse umane ha creato un corso e un esame per i dipendenti appena assunti. Il responsabile delle risorse umane vuole che i dipendenti seguano il corso, ma vuole che accedano all'esame solo dopo aver completato il corso. Solo dopo aver superato l'esame, vuole che i dipendenti abbiano accesso all'academy, che contiene corsi ed esami di livello intermedio ed esperto. Quindi, come impostare questo sistema?

Per capire come impostarlo, abbiamo già stabilito che questi webhook e chiamate API saranno inviati internamente al sistema Easy LMS. Il processo è il seguente.

Il responsabile delle risorse umane deve creare un webhook che invia un payload all'API degli esami dopo che il dipendente ha completato il corso. Questo webhook deve contenere solo i dati necessari per attivare la chiamata all'API degli esami. In questo caso, si utilizza la chiamata API Add participant to Esame (invite). Quando questo webhook è stato inviato, 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 è per quando il dipendente supera con successo l'esame e ottiene l'accesso all'Academy. Anche in questo caso, il payload di questo webhook deve contenere solo le informazioni di cui la chiamata API dell'academy ha bisogno per aggiungere il partecipante e inviare un invito. Dopo l'invio di questo webhook, verrà attivata la chiamata API academy, che aggiungerà il partecipante all'Academy e invierà un invito.

Riassumendo:

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

Il cliente crea innanzitutto un webhook che invia un payload all'API Esame - aggiungi partecipante senza notifica. Quando un nuovo dipendente viene aggiunto al sistema, il webhook invia il payload all'API degli esami, 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 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 invii un payload all'API dell'esame e che attivi l'azione di aggiunta dei partecipanti senza notificare l'esame. Le credenziali di accesso restituite nella risposta della chiamata API possono essere inviate dal proprio sistema.

Un cliente crea esami nel nostro sistema e li vende ai propri clienti dal suo sito di e-commerce. Esame che vuole automatizzare dopo che i clienti hanno pagato un esame.

Per automatizzare il processo di vendita, dovrà utilizzare un webhook. Quando i clienti acquistano o pagano un esame sul loro sito di e-commerce, vengono aggiunti al loro sistema. Il webhook creato deve essere attivato dopo il pagamento. Questo webhook invierà quindi il relativo payload alla chiamata API degli esami e dovrà restituire una risposta di successo o di errore. Se la risposta è positiva, la chiamata API aggiunge e invita i clienti all'esame per cui hanno pagato.
​

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

Per saperne di più, consultare i seguenti articoli: