Komma igång med Klaviyo API
Du kommer att lära dig
Få en grundläggande förståelse för API-anrop och hur Klaviyo API:er kan gynna ditt företag. I den här guiden får du lära dig om REST API:er, HTTP-metoder och utvecklarverktyg för att förbereda dig för att testa Klaviyo API:er. Dina första API-anrop kan du genomföra på så lite som 10 minuter från början till slut. Om du redan är bekant med API-anrop och är redo att testa våra API:er kan du följa vår guide om hur du använder våra Postman-samlingar.
I den här guiden kommer vi att länka till en ordlista när nya tekniska termer introduceras. Om du är osäker på vad ett ord betyder någonstans i guiden kan du kolla in ordlistan för tekniska termer.
Vad är ett REST-API?
REST API är en uppsättning akronymer som står för Representational State Transfer och Application Programming Interface. Dessa termer kan enklast förstås som strukturerade förfrågningar som gör att ett program kan prata med ett annat och föra över information mellan dem. När du gör ett Klaviyo API-anrop skickar du en förfrågan till en server och får ett svar. Svaret innehåller en statuskod och, när slutpunkten returnerar data, en brödtext i JSON-format (JavaScript Object Notation). Vissa lyckade förfrågningar returnerar ingen brödtext.
Enklare uttryckt gör REST-API:er att du kan begära datalager i Klaviyo och få tillbaka dessa data i ett format som är läsbart för både dig och datorer.
En GET-begäran för att hämta data följer de här stegen:
- Skicka en strukturerad begäran om data via internet till API:et. Begäranden skickas via HTTP, en grundläggande typ av nätverksbegäran som stora delar av internet bygger på.
- API:et tar emot begäran, behandlar den och hämtar den begärda informationen från Klaviyos databaser.
- API:et svarar sedan klientapplikationen med JSON-strukturerat format.
- Du får JSON-svaret från ditt klientprogram.
Även om den här kunskapen är hjälpsam för att förstå hur dataöverföring fungerar behöver du den inte för att börja göra API-anrop och få värde av det som Klaviyo API:er har att erbjuda. Följande avsnitt förklarar grunderna, och den länkade Postman-guiden hjälper dig genom ditt första API-anrop.
HTTP-metoder
HTTP-metoder är de ”verb” som används för att skicka dina förfrågningar. Det finns 2 HTTP-metoder som vi kommer att ta upp i den här guiden: GET och POST.
Även om vi inte använder dem här är det värt att notera att de flesta REST-API:er har stöd för ytterligare HTTP-metoder, till exempel PUT, PATCH och DELETE.
HÄMTA
En GET-begäran kan enklast förstås som en ”läs”-begäran. GET-begäranden hämtar information från API- slutpunkten och returnerar den till dig i ett JSON-formaterat svar. Dessa begäranden låter dig bara läsa data, vilket gör dem till den säkraste typen av begäran eftersom dina data inte kan ändras eller skrivas över med den här metoden.
POSTA
En POST-begäran kan enkelt förstås som en ”skriv”-begäran. Med POST kan du skapa eller lägga till nya resurser. Till exempel kan en POST-begäran till Lists API användas för att skapa en ny lista i ditt Konto, medan GET-begäranden kan hämta dina listor sida för sida. Följ länken till nästa sida i varje svar tills det inte finns fler sidor.
Kontrollera slutpunktens referensdokumentation för dess framgångssvar. När du skapar en lista returneras 201 (Created) med den nya listans data. Vissa POST-begäranden, till exempel att skapa en händelse, returnerar 202 (Accepted) utan någon svarstext. Ett 202-svar innebär att begäran godkändes för bearbetning. Det bekräftar inte att bearbetningen är klar.
Nödvändiga verktyg
API:er ger dina arbetsflöden stor flexibilitet och kräver inte att du använder en specifik klientapplikation eller ett visst språkbibliotek för att uppnå önskat resultat. Eftersom API-anrop görs med HTTP-begäranden kan nästan alla programmeringsspråk skicka den här typen av begäran som standard eller via ett allmänt tillgängligt språkbibliotek. Dessutom kan du, beroende på din dator och ditt operativsystem, använda inbyggda applikationer som Apples Terminal eller Windows Terminal för att göra API-anrop från din dator. Dessa applikationer kräver dock förkunskaper om kommandoradsgränssnitt.
Vi använder ett kostnadsfritt webb- och skrivbordsprogram som heter Postman. Postman har en rad funktioner som gör det enklare att konfigurera och skicka en API-begäran genom att ange slutpunkten, parametrar och autentisering i ett användbart användargränssnitt.
Testa Klaviyo API:er
Använd ett Klaviyo-testkonto för att experimentera. POST-begäranden kan ändra data i kontot som är kopplat till dina autentiseringsuppgifter, även när du skickar dem från Postman.
För förfrågningar som använder en privat API-nyckel ska du skapa en nyckel med de behörigheter som krävs av de slutpunkter du planerar att testa. Till exempel kräver hämtning av listor lists:read, medan skapande av en lista kräver lists:write. Håll privata API-nycklar säkra och exponera dem aldrig i webbläsarkod.
Klaviyos API:er är användbara för att skicka data från andra plattformar eller servrar till Klaviyo-konton eller för att göra frågor om information i ett Klaviyo-konto. Nu när du har förstått hur API:er fungerar kan du börja testa våra API:er för ditt företags användningsfall. För en fullständig lista över Klaviyos tillgängliga API:er kan du läsa vår referensdokumentation för API. Följ vår guide om hur du använder våra Postman-samlingar för att göra ditt första Klaviyo API-anrop.
Ytterligare resurser
Resurser i utvecklarportalen
Klaviyos utvecklarportal innehåller API-guider och referensdokumentation som hjälper dig att få ut mesta möjliga av våra API:er. Ta del av resurserna nedan för att komma igång:
- Klaviyo API-referensdokumentation
- Komma igång med JavaScript-API
- Konfigurera API-baserade transaktionshändelser
Klaviyo-utvecklarkurser
Klaviyo Academy erbjuder utvecklarkurser som hjälper dig att komma igång med att bygga med Klaviyos API. Kolla in kurserna nedan: