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.
In deze gids linken we naar een woordenlijst wanneer er nieuwe technische termen worden geïntroduceerd. Als je op enig moment in de gids niet zeker weet wat een woord betekent, bekijk dan de woordenlijst met technische termen.
Wat is een REST API?
De REST API is een set acroniemen die staat voor Representational State Transfer en Application Programming Interface. Deze termen kun je eenvoudiger begrijpen als gestructureerde verzoeken waarmee een stukje software met een ander kan communiceren en informatie tussen beide kan uitwisselen. Wanneer je een API-call doet, dien je een verzoek in bij een server waar informatie is opgeslagen. Die geeft vervolgens een reactie terug met de door jou gevraagde gegevens in JSON-formaat (JavaScript Object Notation).
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 standaard API-aanroep gebeurt binnen enkele seconden. Achter de schermen zal je aanroep het volgende doen:
- 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.
- De API ontvangt het verzoek, verwerkt het en haalt de gevraagde informatie op uit de databases van Klaviyo.
- De API reageert vervolgens op de clientapplicatie met behulp van JSON-gestructureerde indeling.
- 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 API-calls en waarde te halen uit wat Klaviyo API's te bieden hebben. Alles wat je moet weten om aan de slag te gaan met je eerste API-calls wordt in de volgende secties behandeld.
HTTP-methoden
HTTP-methoden zijn de "werkwoorden" waarmee je verzoeken worden verzonden. In deze gids behandelen we 2 HTTP-methoden: GET en POST.
Hoewel we ze hier niet zullen gebruiken, is het goed om te weten dat de meeste REST-API's extra HTTP-methoden ondersteunen, zoals PUT, PATCH en DELETE.
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-verzoek kun je eenvoudig zien als een "schrijf"-verzoek. Met POST kun je nieuwe resources maken of toevoegen. Zo kan een POST-verzoek naar de List API worden gebruikt om een nieuwe lijst in je account te maken, terwijl een GET-verzoek kan worden gebruikt om alle beschikbare lijsten op te halen. Houd er rekening mee dat wanneer je gegevens post, reacties variëren afhankelijk van wanneer Klaviyo je verzoek kan voltooien.
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 bereiken. Omdat API-aanroepen worden gedaan via HTTP-verzoeken, heeft vrijwel elke programmeertaal de mogelijkheid om dit type verzoek standaard te verzenden, of via een algemeen beschikbare taalbibliotheek. Daarnaast kun je, afhankelijk van je machine en besturingssysteem, systeemeigen applicaties zoals Apple's Terminal of Windows Opdrachtregel gebruiken om client-side API-aanroepen te doen. Deze applicaties vereisen echter 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
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: