Come utilizzare l’API?

8 min di lettura

Abitualmente lavoravo nel servizio clienti di un’azienda tecnologica dove le connessioni API che estraggono i dati degli utenti da altri programmi facevano parte integrante del prodotto. Quando spiegavo ai clienti perché non potevamo accedere a un particolare elemento di dati, gli sviluppatori raccomandavano spesso la risposta: « Non è disponibile tramite l’API ».

All’epoca, pensavo che un’API fosse come una porta USB e che collegandosi a questa porta avremmo avuto accesso a tutto in un altro programma. Si è rivelato che mi sbagliavo.

A lire en complément : Come ottimizzare l'uso del vostro Intranet IAD?

Leggi anche: Zapier vs IFTTT: il miglior strumento per l’automazione delle attività

Le API sono meno simili a porte USB o tubi antincendio e più simili a una persona in un centro assistenza in un paese straniero. Un’API non ti darà tutte le informazioni o il codice di un programma (come un tubo antincendio), perché cosa ti impedirebbe di replicare l’intero codice sorgente? Invece, un’API ti fornisce dati che i suoi programmatori hanno reso disponibili agli utenti esterni. Anche così, devi sapere come porre le domande giuste per fare qualcosa con questi dati.

A lire en complément : Come Utilizzare la C Cediglia Maiuscola nel Tuo Testo?

Che cos’è un’API?

API significa interfaccia di programmazione delle applicazioni. La parte più importante di questo nome è « interfaccia », poiché un’API parla essenzialmente a un programma per te. Devi sempre conoscere la lingua per comunicare con il programma, ma senza API non andresti lontano.

Quando i programmatori decidono di rendere accessibili alcune delle loro informazioni al pubblico, « espongono i punti di accesso », il che significa che pubblicano una parte del linguaggio che hanno utilizzato per creare il loro programma. Altri programmatori possono quindi estrarre dati dall’applicazione creando URL o utilizzando client HTTP (programmi speciali che creano gli URL per te) per richiedere dati da questi punti di accesso.

I punti di accesso restituiscono testo destinato ai computer da leggere, quindi non avrà senso se non comprendi il codice informatico utilizzato per scriverlo.

TL; DR: Un’API consente a un programma di richiedere dati da un altro.

Perché utilizzare un’API

I computer semplificano molte cose, in particolare le attività che comportano la raccolta e l’ordinamento di tonnellate di dati. Supponiamo che tu voglia sapere quante volte un terzo ha inviato fatture alla tua azienda. È possibile accedere ai registri delle fatture della tua azienda, scansionare l’entrata dati « da » e stampare ogni fattura individualmente per la tua revisione.

D’altra parte, se tutte le fatture sono state caricate in un database centrale, puoi scrivere un programma semplice che accede a questo database e trova tutte le istanze del nome del partner. Ci vorrebbe molto meno tempo ed sarebbe molto più preciso.

Architettura di un’API

Le API sono composte da tre parti:

  • Utente: la persona che fa una richiesta
  • Client: computer che invia la richiesta al server
  • Server: l’computer che risponde alla richiesta

Qualcuno costruirà prima il server, poiché acquisisce e detiene i dati. Una volta che questo server è in esecuzione, i programmatori pubblicano documentazione, inclusi i punti di accesso dove possono essere trovati dati specifici. Questa documentazione indica ai programmatori esterni la struttura dei dati sul server. Un utente esterno può quindi interrogare (o cercare) i dati sul server, o creare un programma che esegue ricerche nel database e trasforma queste informazioni in un formato diverso e utilizzabile.

È molto confuso, quindi prendiamo un esempio reale: una rubrica.

All’epoca analogica, ricevevi una copia dell’elenco telefonico delle Pagine Bianche, che elencava tutte le persone della tua città per nome e indirizzo, in ordine alfabetico. Se avevi bisogno dell’indirizzo di un amico, potevi cercarli per cognome, trovare l’indirizzo e poi cercare la loro strada sulle mappe incluse sul retro. Si trattava di una quantità limitata di informazioni, e ci voleva molto tempo per accedervi. Ora, grazie alla magia della tecnologia, tutte queste informazioni possono essere trovate in un database.

Costruiamo un database contenente le Pagine Bianche per una città fittizia chiamata Happyville. Le persone di HappyVille_WP hanno deciso che durante la costruzione del loro database, avrebbero creato alcune categorie di informazioni con dati annidati sotto. Questi sono i nostri punti di accesso, e includeranno tutte le informazioni che l’API pubblicherà a un programma esterno.

Ecco i punti di accesso elencati nella documentazione di HappyVille_WP:

  • /nomi
    • /first_name, /last_name
  • /indirizzi
    • /street_address, /email_address/
  • /telefoni
    • /home_phone, /mobile_phone

Ovviamente, queste non sono tutte le informazioni che possono essere raccolte su una persona. Anche se HappyVille_WP raccogliesse informazioni più private sui residenti di Happyville (come le date di nascita e i numeri di previdenza sociale), questi dati non sarebbero disponibili per i programmatori esterni senza conoscere la lingua di questi punti di accesso.

Questi punti di accesso ti indicano la lingua che devi utilizzare per richiedere informazioni dal database. Se desideri un elenco di tutte le persone di Happyville con il cognome Smith, puoi fare una delle due cose seguenti:

  1. Fai una richiesta di URL in un browser per queste informazioni. Questo utilizza il tuo browser Internet come client, e riceverai un documento di testo in linguaggio di codifica da ordinare. Questo URL potrebbe apparire così: http://api.happyville_wp.com/names?last_name=smith
  2. Utilizza un programma che richiede le informazioni e le traduce in una forma utilizzabile. Puoi codificare il tuo programma o utilizzare un client HTTP preconfezionato.

La prima opzione è ideale per fare richieste semplici con solo poche risposte (tutte le persone in Happyville con il cognome Xarlax, ad esempio — sono abbastanza sicuro che ci siano solo sei famiglie con quel nome a Happyville). La seconda opzione richiede più fluidità nella codifica, ma è ideale per i programmatori che vogliono utilizzare il database di un altro programma per migliorare le proprie applicazioni.

Molte aziende utilizzano le API aperte di grandi aziende come Google e Facebook per accedere a dati che potrebbero non essere disponibili altrimenti. In questo caso, le API riducono notevolmente le barriere all’ingresso per le piccole imprese che altrimenti avrebbero dovuto compilare i propri dati.

Azioni che puoi intraprendere tramite un’API

Wow! Ok, quindi un’API è il modo in cui due computer parlano tra loro. Il server possiede i dati e definisce la lingua, mentre il client utilizza questa lingua per richiedere informazioni al server (per tua informazione, i server non inviano dati senza che un client richieda dati, ma gli sviluppatori hanno trovato modi per aggirare questo con i webhook). Le API possono fare tutto!

Non così in fretta. Il linguaggio e la sintassi delle API limitano severamente le loro capacità. Ci sono quattro tipi di azioni che un’API può eseguire:

  • GET: richiede dati da un server — può essere uno stato o specifiche (come last_name)
  • POST: invia le modifiche del client al server; pensa a questo come aggiungere informazioni al server, come fare una nuova entrata
  • PUT: rivede o aggiunge informazioni esistenti
  • DELETE: elimina le informazioni esistenti

Quando combini i punti di accesso con queste azioni, puoi cercare o aggiornare tutte le informazioni disponibili tramite un’API. Dovrai controllare la documentazione dell’API per sapere come codificare queste azioni, poiché sono tutte diverse.

Mentre parliamo di linguaggio e sintassi, copriremo i modi in cui puoi fare una richiesta a un server:

HTTP: protocollo di trasferimento ipertestuale. È così che sei arrivato al nostro sito in primo luogo, digitando un URL nella barra di ricerca del tuo browser. È un modo davvero facile per accedere ai dati, ma non ti tornerà in un formato carino se richiedi molte informazioni. Ci arriveremo tra un secondo.

Formati di testo: XML, JSON. Queste sono le principali lingue per accedere ai dati tramite un’API. Quando ricevi i tuoi dati, dovrai esaminare il codice XML o JSON per capire cosa ti ha dato il server.

Iniziare a utilizzare un’API

La maggior parte degli utilizzi dell’API che vedrai nella tua vita professionale quotidiana sposta informazioni da un programma a campi di modulo simili in un altro programma. Questo è particolarmente utile quando cerchi di condividere informazioni che altrimenti dovresti inserire ripetutamente — ad esempio, la condivisione di lead tra la tua piattaforma di automazione marketing e il tuo CRM.

Le applicazioni e gli esempi che elencheremo qui sono molto più basilari e sfruttano molto meno di quanto la tua API standard sia in grado di fare. Ma ti daranno una buona idea dei passaggi del processo API.

  1. La maggior parte delle API richiede una chiave API. Una volta trovata un’API con cui vuoi giocare, consulta la documentazione per conoscere le condizioni di accesso. La maggior parte delle API ti chiederà di procedere a una verifica dell’identità, come accedere con il tuo account Google. Otterrai una stringa unica di lettere e numeri da utilizzare quando accedi all’API, invece di dover semplicemente inserire la tua email e la tua password ogni volta (il che non è molto sicuro – per ulteriori informazioni su autorizzazioni e verifiche, leggi questo).
  2. Il modo più semplice per iniziare a utilizzare un’API è trovare un client HTTP online, come REST-Client, Postman o Paw. Questi strumenti pronti all’uso (e spesso gratuiti) ti aiutano a strutturare le tue richieste di accesso alle API esistenti con la chiave API che hai ricevuto. Avrai sempre bisogno di conoscere una parte della sintassi della documentazione, ma ci sono poche conoscenze di codifica richieste.
  3. Il modo migliore per estrarre dati da un’API è creare un URL dalla documentazione esistente dell’API. Questo video di YouTube spiega come estrarre i dati di localizzazione da Google Maps tramite l’API e poi utilizzare queste coordinate per trovare foto nelle vicinanze su Instagram.

In generale, una richiesta API non sembra molto diversa da un normale URL del browser, ma i dati restituiti saranno in una forma facilmente leggibile per i computer. Ecco cosa è successo quando ho richiesto informazioni dal database OpenWeather nel mio browser web:

Esempio di URL dalla documentazione — richiede il meteo per una città particolare:

api.openweathermap.org/data/2.5/weather?q={nome della città}

Digita nel tuo browser:

api.openweathermap.org/data/2.5/weather?q=Nashville, TN&APIID={numeri_lettere_numeri_lettere}

Conclusioni e letture supplementari

Un’API è utile per estrarre informazioni specifiche da un altro programma. Se sai leggere la documentazione e scrivere le richieste, puoi recuperare molti buoni dati, ma può essere opprimente analizzare tutto ciò. È qui che entrano in gioco gli sviluppatori. Possono creare programmi che visualizzano dati direttamente in un’applicazione o in una finestra del browser in un formato facilmente consumabile.

Questo articolo sfiora appena la superficie della tecnologia API. Ho fatto un po’ di ricerche online per saperne di più sulle API. Ecco gli articoli e i video che mi hanno aiutato di più:

  • Utilizzo delle API: non è così difficile come sembra
  • Come utilizzare le API con JavaScript
  • API Web per non programmatori
  • Corsi Zapier API
  • Concetti ed esempi dell’API REST
  • Che cos’è un’API e perché è importante

Vuoi connettere i tuoi programmi, ma non hai tempo per creare un client? Ci sono molte aziende che collegheranno API esistenti o costruiranno connessioni personalizzate per te. Queste possono variare da applicazioni semplici attivate da dati come Zapier a integrazioni di Business Intelligence su larga scala che estraggono enormi quantità di dati da più fonti per l’analisi. Sapere come funziona un’API è il primo passo per costruire grandi integrazioni.

Leggi di più su blog-introduction.fr

Come utilizzare l’API?