Aan de slag met Klaviyo API's

Wat je leert

Krijg een basisbegrip van API-aanroepen en hoe de Klaviyo API’s je bedrijf kunnen helpen.  In deze gids leer je over REST API’s, HTTP-methoden en ontwikkeltools, zodat je je kunt voorbereiden op het testen van Klaviyo’s API’s. Je eerste API-aanroepen kun je in slechts 10 minuten van begin tot eind uitvoeren. Als je al bekend bent met API-aanroepen en klaar bent om onze API’s te testen, volg dan onze gids over het gebruik van onze Postman-collecties.

Wat is een REST API?

REST API is een set acroniemen die staan voor Representational State Transfer en Application Programming Interface. Deze termen kun je eenvoudiger begrijpen als gestructureerde verzoeken waarmee een stuk software met een ander stuk software kan praten en informatie tussen beide kan doorgeven. Wanneer je een Klaviyo API-call doet, stuur je een verzoek naar een server en ontvang je een antwoord. Het antwoord bevat een statuscode en, wanneer het eindpunt gegevens retourneert, een body in JSON-indeling (JavaScript Object Notation). Sommige succesvolle verzoeken leveren geen response body op.

Simpeler gezegd: met REST-API's kun je gegevens opvragen die in Klaviyo zijn opgeslagen, en krijg je die gegevens terug in een indeling die voor jou en voor computers leesbaar is.

Een GET request om gegevens op te halen volgt deze stappen:

1. Stuur een gestructureerd verzoek om data via internet naar de API. Verzoeken worden verstuurd via HTTP, een basistype netwerkverzoek waarop het internet grotendeels is gebouwd.
2. De API ontvangt het verzoek, verwerkt het en haalt de gevraagde informatie op uit de databases van Klaviyo.
3. De API reageert vervolgens op de clientapplicatie met behulp van JSON-gestructureerde indeling.
4. Je ontvangt het JSON-antwoord van je clientapplicatie.

Hoewel deze kennis handig is om te begrijpen hoe gegevensoverdracht werkt, is het niet nodig om te beginnen met het maken van API-calls en waarde te halen uit wat de Klaviyo API te bieden heeft. In de volgende secties worden de basisprincipes uitgelegd en leidt de gekoppelde Postman-handleiding je door je eerste API-call.

HTTP-methoden

HTTP-methoden zijn de "werkwoorden" waarmee je verzoeken worden verzonden. In deze gids behandelen we 2 HTTP-methoden: GET en POST. 

OPHALEN

Een GET-verzoek kun je het beste zien als een "lees"-verzoek. GET-verzoeken halen informatie op uit het API- eindpunt en sturen die naar je terug in een JSON-geformatteerde respons. Met deze verzoeken kun je alleen data lezen, waardoor ze het veiligste type verzoek zijn, omdat je data met deze methode niet kan worden aangepast of overschreven.

POSTEN

Een POST-request kun je eenvoudig opvatten als een "write"-request. Met POST kun je nieuwe resources maken of toevoegen. Zo kun je bijvoorbeeld met een POST-request naar de Lists API een nieuwe lijst maken in je account, terwijl je met GET-requests je lijsten pagina voor pagina kunt ophalen. Volg de link naar de volgende pagina in elke response totdat er geen pagina's meer zijn.

Bekijk de referentiedocumentatie van het eindpunt voor de succesrespons. Als je een lijst aanmaakt, krijg je 201 (Created) terug met de gegevens van de nieuwe lijst. Sommige POST-verzoeken, zoals het aanmaken van een event, retourneren 202 (Accepted) zonder response-body. Een 202-response betekent dat het verzoek is geaccepteerd voor verwerking. Het bevestigt niet dat de verwerking is voltooid.

Benodigde tools

API's bieden je workflows veel flexibiliteit en vereisen niet dat je een specifieke clientapplicatie of taalbibliotheek gebruikt om de gewenste resultaten te behalen. Omdat API-aanroepen worden gedaan via HTTP-verzoeken, kan vrijwel elke programmeertaal dit type verzoek standaard versturen, of via een algemeen beschikbare taalbibliotheek. Daarnaast kun je, afhankelijk van je computer en besturingssysteem, native applicaties zoals Apple’s Terminal of Windows Terminal gebruiken om API-aanroepen te doen vanaf je computer. Deze applicaties vereisen echter wel voorkennis van command line-interfaces.

We gebruiken een gratis web- en desktopapplicatie met de naam Postman. Postman heeft verschillende functies die het makkelijker maken om een API-request in te stellen en te versturen door het eindpunt, parameters en authenticatie in te voeren in een handige gebruikersinterface.

Test Klaviyo's API's

Gebruik een Klaviyo test account om te experimenteren. POST requests kunnen gegevens wijzigen in het account dat is gekoppeld aan je inloggegevens, zelfs wanneer je ze vanuit Postman verstuurt.

Voor verzoeken die een privé-API-sleutel gebruiken, maak je een sleutel aan met de machtigingen die vereist zijn voor de eindpunten die je wilt testen. Zo vereist het ophalen van lijsten bijvoorbeeld lists:read, terwijl het aanmaken van een lijst lists:write vereist. Houd privé-API-sleutels veilig en stel ze nooit bloot in browsercode.

De API's van Klaviyo zijn handig om data van andere platforms of servers naar Klaviyo-accounts te sturen of informatie binnen een Klaviyo-account op te vragen. Nu je begrijpt hoe API's werken, kun je beginnen met het testen van onze API's voor de use cases van je bedrijf. Voor een volledige lijst met beschikbare API's van Klaviyo kun je onze API-referentiedocumentatie bekijken. Volg onze handleiding over hoe je onze Postman-collecties gebruikt om je eerste Klaviyo API-call te doen.

Extra hulpbronnen

Resources voor het ontwikkelaarsportaal

Klaviyo's ontwikkelaarsportaal bevat API-handleidingen en referentiedocumentatie om je te helpen het maximale uit onze API te halen. Bekijk de onderstaande bronnen om aan de slag te gaan:

• API-referentiedocumentatie van Klaviyo
• Aan de slag met de JavaScript API
• API-gebaseerde transactionele gebeurtenissen instellen

Klaviyo Developers-cursus

Klaviyo Academy biedt cursussen voor developers om je op weg te helpen met bouwen met Klaviyo API's. Bekijk de cursussen hieronder:

• API-basisprincipes voor marketeers
• Klaviyo Developers-certificaat
• Veelgebruikte API-termen definiëren