Cosa significa API?

Un'API, abbreviazione di Application Programming Interface, indica un insieme di codici funzione che consentono alle applicazioni di accedere a dati specifici e interagire con componenti di applicazioni software esterne, sistemi operativi o microservizi.

Per semplificare, un'API fornisce una risposta dell'utente a un sistema e invia la risposta del sistema a un utente. Fai clic su "aggiungi al carrello"; un'API comunica al sito che hai aggiunto un prodotto al carrello; il sito web inserisce il prodotto nel carrello e il carrello viene aggiornato.

Potresti sentire il termine "microservizi" in relazione all'API. Questi però non sono la stessa cosa. I microservizi sono uno stile o un'architettura che divide le funzionalità all'interno di un'applicazione web. Mentre l'API è il framework con cui gli sviluppatori interagiscono con un'applicazione web. I microservizi possono effettivamente utilizzare l'API per comunicare tra di loro.

L'API consente a uno sviluppatore di effettuare una "chiamata" o "richiesta" specifica per inviare o ricevere informazioni. Questa comunicazione viene effettuata utilizzando un linguaggio di programmazione chiamato "JSON". Può anche essere utilizzato per eseguire un'azione definita come l'aggiornamento o l'eliminazione dei dati. Esistono quattro metodi di richiesta di base che possono essere effettuati con l'API:

GET – Raccoglie informazioni (estraendo tutti i codici coupon)

PUT – Aggiorna i dati (Aggiornamento dei prezzi del prodotto)

POST – Crea (Creazione di una nuova categoria di prodotto)

DELETE – (Eliminazione di un post sul blog)

Cos'è JSON e perché viene utilizzato?

JSON (JavaScript Object Notation) viene utilizzato per rappresentare i dati su un server. È abbastanza facile da leggere per gli esseri umani e facile da comprendere per le macchine/applicazioni. Diamo un'occhiata ad un esempio di JSON da un prodotto su BigCommerce:

Questo è facile da capire poiché viene generato in coppie chiave/valore, con la chiave a sinistra e un valore a destra. Le chiavi sono un oggetto fisso definito dall'applicazione e rimarranno le stesse della "categoria". Mentre i valori saranno univoci, come "Camicie".

Cos'è una richiesta API?

Esistono diversi componenti di una richiesta API affinché funzioni. Esaminiamoli singolarmente e come possono essere utilizzati per creare una richiesta.

Cos'è l'Endpoint?

Esistono due parti fondamentali di un endpoint che vengono utilizzate quando si effettua una richiesta API. Uno dei quali è l'URL. BigCommerce utilizza https://api.bigcommerce.com/stores/ come URL per tutte le richieste API. Potrebbe sembrare un normale URL ma se lo colleghi a un browser web, riceverai un messaggio di errore 404.

La seconda parte è il percorso. Il percorso varierà a seconda di ciò che stai cercando di realizzare. Puoi trovare un elenco dei percorsi disponibili per BigCommerce visitando la nostra documentazione per sviluppatori: https://developer.bigcommerce.com/api-reference. Per questo esempio utilizzeremo il percorso del prodotto che è /v3/catalog/products.

Quando mettiamo insieme queste due parti, otteniamo un endpoint completo https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Ora potresti chiederti "Cos'è {store_hash}?" "Da dove viene?" Questo è ciò che è noto come variabile. Le variabili sono componenti univoci di un endpoint e varieranno in base alle informazioni del tuo negozio. Puoi individuare una variabile dalle parentesi aperte e chiuse "{ }".

Cos'è l'intestazione?

Le intestazioni forniscono informazioni al client e al server. Esempi comuni di intestazione sarebbero le credenziali di autenticazione come un "Token di autenticazione" o un "ID cliente". Queste credenziali ti vengono fornite automaticamente quando crei un account API. Un'altra intestazione comune è denominata "Tipo di contenuto", che informa il server sul tipo di contenuto che verrà inviato. Ad esempio, un tipo di contenuto comunemente utilizzato è "application/json" che informa il server che stiamo inviando dati JSON.

Cos'è il metodo?

I metodi sono le azioni intraprese quando si invia una richiesta. Ripensa all'inizio quando abbiamo discusso di GET, PUT, POST e DELETE. Questi sono tutti metodi API.

Che cosa sono i dati?

I dati della richiesta, comunemente definiti anche "corpo", sono informazioni che verranno inviate o restituite da un server. Nella discussione precedente su JSON, puoi vedere un esempio di dati API. Il corpo di una richiesta a volte richiederà informazioni specifiche prima di poter essere consegnato. Un esempio di ciò è se stai modificando un singolo prodotto, l'ID prodotto sarà richiesto prima di poter apportare qualsiasi modifica.

Per saperne di più qui.