Connetti alle API senza codice: 8 passaggi

2024 Autore: John Day | [email protected]. Ultima modifica: 2024-01-30 10:00

Questa guida è progettata per le persone che desiderano realizzare qualcosa che richiede l'utilizzo di un'API, ma non sono abbastanza sicure di come iniziare. Sai già perché essere in grado di lavorare con un'API è utile e questa guida ti mostrerà come farlo.

Se suona come te, sei fortunato! Siamo qui per spiegare come lavorare con le API, come leggere i documenti API e come utilizzare effettivamente i dati di ritorno da un'API.

Abbiamo portato con noi un amico per rendere il viaggio molto più facile.

Incontra Slash

Slash è l'adorabile e adorabile cane di Michelle (nella foto sopra). Michelle è un ingegnere del software che crea API. A Michelle piace molto il suo lavoro e ha tratto ispirazione dal suo lavoro di creazione di API nella formazione di Slash.

Come forse saprai, un'API è una raccolta di comandi che un utente può fornire a un servizio Web insieme a una serie di risposte che corrispondono alla richiesta. Michelle ha addestrato Slash a fare lo stesso. Slash è un bravo ragazzo, conosce una varietà di comandi e risponde sempre correttamente finché gli fai una richiesta che gli è stata insegnata. Quando diventa più eccitato, la sua coda impazzisce - questo non è qualcosa che Michelle gli ha insegnato riguardo alle API, è solo perché è un cucciolo adorabile e si gode davvero il suo addestramento!

Passaggio 1: decidi di quale API hai bisogno

Quali informazioni stai cercando o vuoi cambiare?

Stai cercando di catturare tutti i post su Instagram di @dougthepug? Forse vuoi twittare automaticamente a chiunque segua il twitter del tuo cane (perché anche se i cani non possono parlare, hanno molto da dire, sappiamo di sicuro che Slash lo fa).

Se conosci già il sito o l'API a cui stai tentando di connetterti, vai direttamente al passaggio 2. Se stai cercando di trovare dati, ma non sai da dove cominciare, Google è tuo amico. Cerca "[cose che ti interessano] API" e guarda cosa viene fuori. Potresti essere sorpreso di quante informazioni ci sono là fuori.

Se desideri una semplice API di esempio, puoi utilizzare quella creata da Michelle durante l'addestramento di Slash. Ha alcuni dei suoi comandi preferiti come recuperare le palle e scavare buche. Lo useremo per il resto dei nostri esempi.

Passaggio 2: trova i documenti API

Le API fornite da aziende note dovrebbero avere una documentazione completa su come usarle.

Per trovarli, google "documentazione API [Insert Company]" o "sviluppatore [Insert Company]".

I risultati dovrebbero portarti al portale per sviluppatori. Cerca un collegamento che dica "Documenti", "Documentazione", "Riferimento" o "Riferimento tecnico".

All'interno dei documenti, potresti dover cercare l'API specifica che desideri poiché a volte possono esserci molte opzioni. Facebook, ad esempio, ha API separate per marketing, annunci, pagine e altro.

Se l'API a cui vuoi connetterti non è ben nota (come quella di Slash) potresti dover chiedere la documentazione allo sviluppatore. Potrebbero avere un PDF contenente le informazioni necessarie o una documentazione online che non è elencata sul loro sito web.

Se hai perso il collegamento nel passaggio precedente, i documenti API di Slash possono essere trovati qui.

Passaggio 3: trova l'endpoint

I documenti API possono sembrare scoraggianti, ma una volta che sai cosa cercare sono generalmente ben strutturati e piuttosto standardizzati.

La prima cosa da cercare è l'endpoint appropriato. Dovrebbe esserci un endpoint corrispondente a ciascun tipo di dati che desideri. Un endpoint potrebbe assomigliare a questo:

slashtheapidog.com/api/bones/{id}

o semplicemente

/ossatura

La documentazione dovrebbe avere un elenco di endpoint. Possono essere di primo livello nei documenti o in una sezione chiamata "riferimento", "endpoint" o "metodi". Per trovare l'endpoint corretto, cerca il nome che corrisponde ai dati che stai cercando. Ad esempio, se vuoi un elenco di tutti i buchi che Slash ha scavato, /holes è probabilmente quello giusto. In ogni caso, ogni endpoint dovrebbe avere una descrizione per aiutare a spiegare cosa fa.

Dai suoi documenti, questi sono gli endpoint nell'API di Slash relativi ai buchi:

OTTIENI

OTTIENI

POST

METTI

POST

Passaggio 4: determina il tipo di richiesta

Ora che hai trovato l'endpoint giusto, devi determinare il tipo di richiesta per inviarlo.

Ci sono 4 diversi tipi di richieste:

OTTENERE

Una richiesta GET è il modo in cui chiedi all'API di rispondere con qualcosa che ha, molto spesso i dati. È possibile richiedere informazioni specifiche su un elemento o un gruppo di elementi in base all'endpoint e ai parametri. Questo è l'equivalente di chiedere a Slash di portarti una delle sue ossa o tutte le sue ossa.

INVIARE

Una richiesta POST è il modo in cui dici all'API di creare qualcosa di nuovo. È come chiedere a Slash di scavare (creare) una nuova buca per te.

METTERE

Una richiesta PUT è il modo in cui dici all'API di aggiornare qualcosa che è stato precedentemente creato. Questo è simile a chiedere a Slash di scavare più a fondo (aggiornare) nel buco che ha scavato.

ELIMINA

Una richiesta DELETE è il modo in cui dici all'API di eliminare qualcosa che è stato precedentemente creato. Questo è simile a chiedere a Slash di coprire (eliminare) un buco che ha scavato in precedenza.

Pensa a questi quattro tipi. Stai ricevendo informazioni, creando una nuova voce, modificando una voce esistente o eliminandone una? Quella risposta ti dice esattamente di quale tipo di richiesta hai bisogno.

Passaggio 5: comprendere i parametri

Molte richieste richiedono parametri aggiuntivi. I parametri sono i dettagli della tua richiesta. Ad esempio, se vuoi che Slash ti porti tutte le palline rosse, devi specificare il colore. Se vuoi che crei un nuovo buco, devi dirgli dove metterlo e quanto in profondità scavare.

La documentazione API a cui fai riferimento dovrebbe avere una sezione chiamata "Parametri" o "Opzioni" per ogni endpoint e tipo di richiesta. Prestare attenzione a quali parametri sono richiesti poiché alcuni sono facoltativi. Se un parametro è contrassegnato come facoltativo, i documenti possono fornire un esempio che è anche l'impostazione predefinita.

I parametri API di Slash potrebbero assomigliare a questo per recuperare le palle:

OTTIENI

Passaggio 6: formatta la tua richiesta

Abbiamo tutte le informazioni che ci servono, ora non ci resta che fare la richiesta!

Ecco due modi diversi per connettersi a un'API che non richiedono codice. Connettiamoci all'API di Slash per ottenere la sua lista di palline facendo una richiesta GET a

Parabola - se vuoi connetterti e lavorare con i dati senza codice

Parabola è un'app Web che ti consente di connetterti facilmente alle API e quindi lavorare con i dati tramite uno strumento visivo di trascinamento della selezione.