Primi passi con le API di Klaviyo
Cosa imparerai
Ottieni una comprensione di base delle chiamate API e di come le API di Klaviyo possono essere utili per la tua attività. In questa guida scoprirai le API REST, i metodi HTTP e gli strumenti per sviluppatori per prepararti a testare le API di Klaviyo. Le tue prime chiamate API possono essere completate in soli 10 minuti dall’inizio alla fine. Se conosci già le chiamate API e sei pronto a testare le nostre API, segui la nostra guida su come usare le nostre raccolte Postman.
In questa guida, inseriremo link a un glossario quando vengono introdotti nuovi termini tecnici. Se in qualsiasi momento della guida non sei sicuro del significato di una parola, consulta il glossario dei termini tecnici.
Che cos’è un’API REST?
REST API è un insieme di acronimi che sta per Representational State Transfer e Application Programming Interface. Questi termini possono essere compresi più semplicemente come richieste strutturate che consentono a un software di comunicare con un altro e di passare informazioni tra i due. Quando effettui una chiamata API di Klaviyo, invii una richiesta a un server e ricevi una risposta. La risposta include un codice di stato e, quando l’endpoint restituisce dati, un corpo in formato JSON (JavaScript Object Notation). Alcune richieste andate a buon fine non restituiscono alcun corpo di risposta.
In modo più semplice, le API REST ti consentono di richiedere i dati archiviati in Klaviyo e di riceverli in un formato leggibile sia da te sia dai computer.
Una richiesta GET per recuperare i dati segue questi passaggi:
- Invia una richiesta di dati strutturata tramite internet all’API. Le richieste vengono inviate tramite HTTP, un tipo di richiesta di rete di base su cui si basa in gran parte internet.
- L'API riceverà la richiesta, la elaborerà e otterrà le informazioni richieste dai database di Klaviyo.
- L’API risponde quindi all’applicazione client utilizzando il formato strutturato JSON.
- Riceverai la risposta JSON dalla tua applicazione client.
Anche se queste conoscenze sono utili per capire come funziona il trasferimento dei dati, non sono necessarie per iniziare a effettuare chiamate API e ottenere valore da ciò che le API di Klaviyo hanno da offrire. Le sezioni seguenti spiegano le nozioni di base e la guida Postman collegata ti accompagna nella tua prima chiamata API.
Metodi HTTP
I metodi HTTP sono i “verbi” con cui vengono inviate le tue richieste. In questa guida tratteremo 2 metodi HTTP: GET e POST.
Anche se qui non li useremo, vale la pena notare che la maggior parte delle API REST supporta metodi HTTP aggiuntivi come PUT, PATCH e DELETE.
OTTIENI
Una richiesta GET può essere compresa più facilmente come una richiesta di "lettura". Le richieste GET recuperano informazioni dall'endpoint API e te le restituiscono in una risposta JSON formattata. Queste richieste ti consentono solo di leggere i dati, quindi sono il tipo di richiesta più sicuro perché con questo metodo i dati non possono essere modificati o sovrascritti.
PUBBLICA
Una richiesta POST può essere semplicemente intesa come una richiesta di "scrittura". POST ti consente di creare o aggiungere nuove risorse. Ad esempio, una richiesta POST all’API Lists può essere utilizzata per creare una nuova lista nel tuo account, mentre le richieste GET possono recuperare le tue liste pagina per pagina. Segui il link alla pagina successiva in ogni risposta finché non ci sono più pagine.
Controlla la documentazione di riferimento dell’endpoint per la risposta in caso di esito positivo. La creazione di una lista restituisce 201 (Created) con i dati della nuova lista. Alcune richieste POST, ad esempio la creazione di un evento, restituiscono 202 (Accepted) senza un corpo di risposta. Una risposta 202 significa che la richiesta è stata accettata per l'elaborazione. Non conferma che l’elaborazione sia completata.
Strumenti necessari
Le API offrono molta flessibilità al tuo flusso di lavoro e non richiedono l’uso di una specifica applicazione client o di una libreria di linguaggio per ottenere i risultati desiderati. Poiché le chiamate API vengono effettuate tramite richieste HTTP, quasi tutti i linguaggi di programmazione sono in grado di inviare questo tipo di richiesta in modo nativo o tramite una libreria di linguaggio ampiamente disponibile. Inoltre, a seconda della tua macchina e del sistema operativo, puoi usare applicazioni native come Terminal di Apple o Terminal di Windows per effettuare chiamate API dal tuo computer. Tuttavia, queste applicazioni richiedono una conoscenza preliminare delle interfacce a riga di comando.
Usiamo un'applicazione web e desktop gratuita chiamata Postman. Postman offre una varietà di funzionalità che rendono più semplice configurare e inviare una richiesta API inserendo endpoint, parametri e autenticazione in un'interfaccia utente utile.
Testa le API di Klaviyo
Usa un account di test Klaviyo per fare esperimenti. Le richieste POST possono modificare i dati nell'account associato alle tue credenziali, anche quando le invii da Postman.
Per le richieste che usano una chiave API privata, crea una chiave con le autorizzazioni richieste dagli endpoint che prevedi di testare. Ad esempio, per recuperare gli elenchi sono necessari lists:read, mentre per creare un elenco sono necessari lists:write. Mantieni al sicuro le chiavi API private e non esporle mai nel codice del browser.
Le API di Klaviyo sono utili per inviare dati da altre piattaforme o server agli account Klaviyo o per interrogare informazioni all'interno di un account Klaviyo. Ora che hai capito come funzionano le API, puoi iniziare a testare le nostre API per i casi d'uso della tua azienda. Per un elenco completo delle API disponibili di Klaviyo, consulta la nostra documentazione di riferimento delle API. Segui la nostra guida su come usare le nostre raccolte Postman per effettuare la tua prima chiamata API di Klaviyo.
Risorse aggiuntive
Risorse del portale di sviluppo
Il portale di sviluppo di Klaviyo contiene guide alle API e documentazione di riferimento per aiutarti a sfruttare al massimo le nostre API. Esplora le risorse qui sotto per muovere i primi passi:
- Documentazione di riferimento per le API di Klaviyo
- Primi passi con l'API JavaScript
- Configurazione di eventi transazionali basati su API
Corsi Klaviyo Developers
Klaviyo Academy offre corsi per sviluppatori per aiutarti a iniziare a creare con le API di Klaviyo. Dai un'occhiata ai corsi sotto: