Erste Schritte mit Klaviyo-APIs
Übersicht
Erhalte ein grundlegendes Verständnis von API-Aufrufen und davon, wie die Klaviyo-APIs deinem Unternehmen helfen können. In diesem Leitfaden erfährst du mehr über REST-APIs, HTTP-Methoden und Entwicklertools, um dich auf das Testen der Klaviyo-APIs vorzubereiten. Deine ersten API-Aufrufe kannst du in nur 10 Minuten von Anfang bis Ende erledigen. Wenn du bereits mit API-Aufrufen vertraut bist und unsere APIs testen möchtest, folge unserer Anleitung zur Verwendung unserer Postman-Collections.
In diesem Leitfaden verlinken wir auf ein Glossar, wenn neue technische Begriffe eingeführt werden. Wenn du dir an irgendeiner Stelle im Leitfaden über die Bedeutung eines Wortes unsicher bist, sieh dir das Glossar für technische Begriffe an.
Was ist eine REST-API?
REST API ist eine Reihe von Abkürzungen, die für „Representational State Transfer“ und „Application Programming Interface“ stehen. Diese Begriffe lassen sich einfacher als strukturierte Anfragen verstehen, die es einer Software ermöglichen, mit einer anderen zu kommunizieren und Informationen zwischen ihnen auszutauschen. Wenn du einen Klaviyo API-Aufruf machst, sendest du eine Anfrage an einen Server und erhältst eine Antwort. Die Antwort enthält einen Statuscode und, wenn der Endpunkt Daten zurückgibt, einen Body im JSON-Format (JavaScript Object Notation). Einige erfolgreiche Anfragen geben keinen Response-Body zurück.
Einfacher gesagt ermöglichen dir REST-APIs, Datenspeicher in Klaviyo abzufragen und diese Daten in einem Format zurückzubekommen, das für dich und für Computer lesbar ist.
Eine GET-Anfrage zum Abrufen von Daten umfasst die folgenden Schritte:
- Sende eine strukturierte Anfrage für Daten über das Internet an die API. Anfragen werden über HTTP gesendet, einen grundlegenden Netzwerk-Anfragetyp, auf dem das Internet weitgehend basiert.
- Die API empfängt die Anfrage, verarbeitet sie und ruft die angeforderten Informationen aus den Datenbanken von Klaviyo ab.
- Die API antwortet dann der Client-Anwendung in einem JSON-strukturierten Format.
- Du erhältst die JSON-Antwort von deiner Client-Anwendung.
Auch wenn dieses Wissen hilfreich ist, um zu verstehen, wie die Datenübertragung funktioniert, ist es nicht notwendig, um mit API-Aufrufen zu beginnen und einen Nutzen aus dem zu ziehen, was Klaviyo APIs zu bieten haben. In den folgenden Abschnitten werden die Grundlagen erklärt, und die verlinkte Postman-Anleitung führt dich durch deinen ersten API-Aufruf.
HTTP-Methoden
HTTP-Methoden sind die „Verben“, mit denen deine Anfragen gesendet werden. In diesem Leitfaden behandeln wir 2 HTTP-Methoden: GET und POST.
Obwohl wir sie hier nicht verwenden, solltest du wissen, dass die meisten REST-APIs zusätzliche HTTP-Methoden wie PUT, PATCH und DELETE unterstützen.
GET
Eine GET-Anfrage lässt sich am einfachsten als „Lesen“-Anfrage verstehen. GET-Anfragen rufen Informationen vom API- Endpunkt ab und geben sie in einer JSON-formatierten Antwort an dich zurück. Mit diesen Anfragen kannst du nur Daten lesen, was sie zur sichersten Anfrageart macht, weil deine Daten mit dieser Methode nicht geändert oder überschrieben werden können.
POST
Eine POST-Anfrage lässt sich einfach als „Schreib“-Anfrage verstehen. POST ermöglicht dir, neue Ressourcen zu erstellen oder hinzuzufügen. Zum Beispiel kann eine POST-Anfrage an die Lists API verwendet werden, um eine neue Liste in deinem Konto zu erstellen, während GET-Anfragen deine Listen Seite für Seite abrufen können. Folge in jeder Antwort dem Link zur nächsten Seite, bis es keine weiteren Seiten mehr gibt.
Sieh in der Referenzdokumentation des Endpunkts nach, um seine Erfolgsantwort zu prüfen. Das Erstellen einer Liste gibt 201 (Created) mit den Daten der neuen Liste zurück. Einige POST-Anfragen, wie z. B. das Erstellen eines Ereignisses, geben 202 (Accepted) ohne Antworttext zurück. Eine 202-Antwort bedeutet, dass die Anfrage zur Verarbeitung angenommen wurde. Sie bestätigt nicht, dass die Verarbeitung abgeschlossen ist.
Erforderliche Tools
APIs bieten deinem Workflow viel Flexibilität und erfordern nicht, dass du eine bestimmte Client-Anwendung oder Sprachbibliothek verwendest, um die gewünschten Ergebnisse zu erzielen. Da API-Aufrufe über HTTP-Anfragen ausgeführt werden, kann nahezu jede Programmiersprache diese Art von Anfrage nativ oder über eine weit verbreitete Sprachbibliothek senden. Außerdem kannst du je nach deinem Gerät und Betriebssystem native Anwendungen wie das Terminal von Apple oder das Terminal von Windows verwenden, um API-Aufrufe von deinem Computer aus durchzuführen. Diese Anwendungen erfordern jedoch Vorkenntnisse im Umgang mit Befehlszeilenschnittstellen.
Wir verwenden eine kostenlose Web- und Desktop-App namens Postman. Postman bietet eine Vielzahl von Funktionen, die das Einrichten und Senden einer API-Anfrage erleichtern, indem der Endpunkt, Parameter und Authentifizierung in eine hilfreiche Benutzeroberfläche eingegeben werden.
Teste Klaviyos API
Verwende ein Klaviyo-Testkonto zum Experimentieren. POST requests können Daten in dem Konto ändern, das mit deinen Anmeldedaten verknüpft ist, selbst wenn du sie über Postman sendest.
Für Anfragen, die einen privaten API-Schlüssel verwenden, erstelle einen Schlüssel mit den Berechtigungen, die für die Endpunkte erforderlich sind, die du testen möchtest. Zum Beispiel erfordert das Abrufen von Listen lists:read, während das Erstellen einer Liste lists:write erfordert. Bewahre private API-Schlüssel sicher auf und lege sie niemals in Browser-Code offen.
Klaviyos API sind nützlich, um Daten von anderen Plattformen oder Servern an Klaviyo-Konten zu senden oder Informationen innerhalb eines Klaviyo-Kontos abzufragen. Jetzt, da du verstehst, wie API funktionieren, kannst du damit beginnen, unsere API für die Anwendungsfälle deines Unternehmens zu testen. Eine vollständige Liste der verfügbaren API von Klaviyo findest du in unserer API-Referenzdokumentation. Folge unserer Anleitung zur Nutzung unserer Postman-Collections , um deinen ersten Klaviyo-API-Aufruf zu machen.
Weitere Ressourcen
Ressourcen im Entwicklerportal
Klaviyos Entwicklerportal enthält API-Leitfäden und Referenzdokumentation, damit du das Beste aus unseren API herausholen kannst. Sieh dir die unten stehenden Ressourcen an, um loszulegen:
- API-Referenzdokumentation von Klaviyo
- Erste Schritte mit der JavaScript API
- Einrichten von API-basierten Transaktionsereignissen
Klaviyo-Developers-Kurse
Die Klaviyo Academy bietet Entwickler*innen-Kurse, die dir den Einstieg in die Entwicklung mit Klaviyo-APIs erleichtern. Sieh dir die folgenden Kurse an: