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 Akronymen, 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 API-Aufruf machst, sendest du eine Anfrage an einen Server, auf dem Informationen gespeichert sind. Der Server gibt dann eine Antwort zurück, die deine angeforderten Daten im JSON-Format (JavaScript Object Notation) enthält.
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.
Ein standardmäßiger API-Aufruf erfolgt in Sekunden. Hinter den Kulissen wird dein Aufruf:
- 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.
Dieses Wissen ist zwar hilfreich, um zu verstehen, wie die Datenübertragung funktioniert, aber es ist nicht nötig, um mit den ersten API-Aufrufen zu beginnen und von dem zu profitieren, was die Klaviyo-APIs zu bieten haben. Alles, was du wissen musst, um mit deinen ersten API-Aufrufen zu starten, wird in den folgenden Abschnitten behandelt.
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 kann man einfach als „Schreib“-Anfrage verstehen. POST ermöglicht es dir, neue Ressourcen zu erstellen oder hinzuzufügen. Ein POST-Request an die Listen-API kann beispielsweise verwendet werden, um in deinem Konto eine neue Liste zu erstellen, während ein GET-Request verwendet werden kann, um alle verfügbaren Listen abzurufen. Beachte, dass die Antworten beim Posten von Daten je nachdem variieren, wann Klaviyo deine Anfrage abschließen kann.
Erforderliche Tools
API bieten viel Flexibilität für deine Workflow und erfordern nicht, dass eine bestimmte Client-Anwendung oder Sprachbibliothek verwendet wird, um die gewünschten Ergebnisse zu erzielen. Da API-Aufrufe über HTTP-Anfragen erfolgen, kann nahezu jede Programmiersprache diese Art von Anfrage nativ oder über eine weit verbreitete Sprachbibliothek senden. Außerdem können – je nach Maschine und Betriebssystem – native Anwendungen wie das Apple- Terminal oder die Windows- Befehlszeile verwendet werden, um clientseitige API-Aufrufe durchzuführen. Diese Anwendungen erfordern jedoch Vorkenntnisse zu Befehlszeilen-Schnittstellen.
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
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: