Introduzione alle API

Benvenuti nel grande mondo delle API!

In questo articolo imparerete:* Che cos'è un'API* Cos'è un'API RESTful* Come lavorare con le API di Tulip

Che cos'è un'API?

Un'API (Application Programming Interface) è un insieme di protocolli che consentono a diversi componenti software di comunicare e trasferire dati.

Gli sviluppatori utilizzano le API per colmare le lacune tra piccoli pezzi di codice discreti, al fine di creare applicazioni potenti, resilienti, sicure e in grado di soddisfare le esigenze degli utenti.

Le parti fondamentali di un'API sono quattro: 1. API Client - il modo in cui è possibile avviare una richiesta API.2. API Request - una richiesta di API per eseguire un'azione o fornire informazioni all'utente.3. API Server - conferma la provenienza della richiesta, se la richiesta è ben formata e recupera o manipola i dati richiesti.4. API Response - la risposta all'utente (il client).

Richiesta API

Una richiesta API è composta da cinque elementi principali:

• Endpoint: Si tratta di un URL dedicato che fornisce l'accesso a una risorsa specifica. Ad esempio, l'endpoint /tables consente di ottenere tutte le tabelle Tulip o di creare una nuova tabella Tulip.
• Metodo: È il tipo di operazione che si desidera far eseguire all'API. Poiché Tulip utilizza le API REST, queste sono limitate a GET, PUT, POST e DELETE.
• Parametri: Variabili che vengono passate a un endpoint API per fornire istruzioni specifiche che l'API deve elaborare. In base agli esempi precedenti dell'endpoint /tables, è possibile specificare l'ID di una tabella specifica tramite /tables/{tableId}. Inoltre, esistono delle query che possono modificare ulteriormente i parametri.
• Intestazioni della richiesta: Coppie chiave-valore che forniscono dettagli sulla richiesta, come il tipo di contenuto o le credenziali di autenticazione.
• Corpo della richiesta: Parte principale della richiesta che dettaglia i dati necessari per creare, aggiornare o cancellare una risorsa. Ad esempio, nell'URL Stations, è possibile craete una nuova stazione e specificare di quale gruppo di stazioni deve far parte e quali applicazioni può contenere.

Risposta API

Quando si compone e si invia con successo una richiesta REST, i server rispondono con quanto segue:

• Un codice di stato: Codice a tre cifre che indica l'esito di una richiesta API.
• Intestazioni della risposta: Forniscono informazioni aggiuntive sulla risposta del server.
• Corpo della risposta: il corpo della risposta include i dati o i contenuti effettivi richiesti dal client o un messaggio di errore se qualcosa è andato storto.

I codici di stato HTTP più comuni sono:

200 OK: Indica che la richiesta è andata a buon fine e che il corpo della risposta contiene la risorsa richiesta**.404 Not Found**: Indica che il server non riesce a trovare la risorsa richiesta, spesso a causa di un URL digitato male o di una risorsa che è stata spostata o cancellata**.400 Bad Request**: Indica che il server non è in grado di elaborare la richiesta a causa di un errore del client, come una sintassi non valida o la mancanza di parametri obbligatori nella richiesta**.500 Internal Server Error**: Indica che il server ha riscontrato una condizione inaspettata che gli ha impedito di soddisfare la richiesta, in genere un problema lato server al di fuori del controllo del client**.302 Found (Moved Temporarily): Indica che la risorsa richiesta è stata temporaneamente spostata su un URL diverso. Il client deve inviare un'altra richiesta al nuovo URL fornito nell'intestazione della risposta.401 Unauthorized**: Indica che la richiesta richiede l'autenticazione dell'utente, ma il client non ha fornito credenziali valide o non si è ancora autenticato.

Per saperne di più sui codici di errore HTTP, vedere qui.

Che cos'è un'API RESTful?

Tulip utilizza API RESTful. Altri tipi di API sono SOAP, GraphQL, Webbhooks o gRPC.

Un'API REST, nota anche come API RESTful, è un'interfaccia semplice e uniforme utilizzata per rendere disponibili dati, contenuti, algoritmi, media e altre risorse digitali tramite URL web. Le API REST sono le API più comuni utilizzate oggi sul Web.

Le API REST utilizzano quattro metodi chiave:1. GET: Questo metodo consente al server di trovare i dati richiesti e di inviarli all'utente.2. PUT: Se si esegue la richiesta PUT, il server aggiorna una voce nel database.3. POST: Questo metodo permette al server di creare una nuova voce nel database.4. DELETE: Questo metodo permette al server di cancellare una voce nel database.

Come lavorare con l'API di Tulip

Leggete i seguenti articoli per iniziare a usare e testare le API con Tulip:

• Cosa sono i connettori?
• Come creare e configurare una funzione connettore HTTP
• Impostazione di un'API Tulip

Avete trovato quello che cercavate?

Potete anche andare su community.tulip.co per postare la vostra domanda o vedere se altri hanno affrontato una domanda simile!