So erstellst oder klonst du einen privaten API-Schlüssel

Übersicht

Erfahre, wie du einen privaten API-Schlüssel erstellst oder klonst und Bereiche auswählst, die steuern, worauf eine Anwendung in deinem Klaviyo-Konto zugreifen kann.

Sowohl private API-Schlüssel als auch Scopes helfen dir, deine Daten und die Daten deiner Kund*innen zu schützen, indem sie einschränken, worauf Dritte zugreifen können.

Informationen zu privaten API-Schlüsseln und Scopes

Ein API-Aufruf ermöglicht es einer Anwendung, Informationen in einer anderen Anwendung anzufordern, hinzuzufügen oder zu bearbeiten.

Ein privater API-Schlüssel identifiziert dein Klaviyo Konto und autorisiert API-Anfragen mithilfe der dem Schlüssel zugewiesenen Berechtigungsbereiche. Jede Person, die den Schlüssel hat, kann diese Berechtigungen nutzen – behandle ihn daher wie ein Passwort.

Wenn du einen Umfang für einen privaten API-Schlüssel einbeziehst, fügst du eine zusätzliche Autorisierungsebene hinzu und schränkst ein, auf welche spezifischen Elemente ein*e Dritte*r zugreifen kann. Umfänge sind wie ein Hotelschlüssel: Du erhältst nur Zugriff auf bestimmte Bereiche (wie dein Zimmer oder das Fitnessstudio) und nicht auf das gesamte Gebäude.

Zugriffsstufen für Bereiche

Wenn du einen privaten API-Schlüssel erstellst, wähle für jede API-Berechtigung eine Zugriffsstufe aus. Diese Zugriffsstufen bestimmen, ob eine Drittpartei Folgendes kann:

• Du hast keinen Zugriff auf die Daten oder Aktionen, die von diesem Bereich abgedeckt werden.
• Daten anzeigen, die von diesem Geltungsbereich abgedeckt sind, ohne Änderungen vorzunehmen (Lesezugriff).
• Daten anzeigen und andere Änderungen vornehmen, erstellen oder löschen, die vom jeweiligen Bereich abgedeckt sind (Lese-/Schreibzugriff).

Du kannst zum Beispiel Profile für Marketing abonnieren und sie aus einer anderen Anwendung zu einer Klaviyo-Liste hinzufügen, indem du Profile gesammelt abonnieren verwendest. Dieser Endpunkt erfordert lists:write, profiles:write und subscriptions:write. Das Gewähren von Lese-/Schreibzugriff für diese Scopes deckt diese Anfrage ab; du musst keinen Zugriff auf nicht zusammenhängende Scopes gewähren.

Im Entwicklerportal kannst du mehr über Klaviyos API erfahren und die verfügbaren Scopes für jeden Endpunkt ansehen.

Bevor du anfängst

Beachte Folgendes:

• Nachdem du einen privaten API-Schlüssel erstellt hast, kannst du nicht:
  • Sieh dir den vollständigen privaten API-Schlüssel erneut an, nachdem du die Bestätigungsseite verlassen hast.
    • Tipp: Speichere private API-Schlüssel sicher und notiere dir, wofür du sie verwenden möchtest, zum Beispiel in einem Passwort-Manager.
  • seine Scopes hinzufügen oder bearbeiten.
    • Wenn du andere Berechtigungsumfänge benötigst, erstelle einen neuen privaten API-Schlüssel mit dem erforderlichen Zugriff. Aktualisiere alle Integrationen, die den alten Schlüssel verwenden, und bestätige, dass sie funktionieren, bevor du ihn löschst.
• Die Erstellungsseite wird mit ausgewähltem benutzerdefinierten Schlüssel geöffnet. Wähle Zugriff für mindestens 1 API-Berechtigung aus, bevor du den Schlüssel erstellst.

Wenn du dir nicht sicher bist, welche API-Endpunkte, Scopes oder Berechtigungen du benötigst, wende dich bitte an eine*n Entwickler*in oder kontaktiere eine*n Klaviyo Partner, um Hilfe zu erhalten.

Privaten API-Schlüssel erstellen

1. Klicke unten links auf den Namen deiner Organisation.
2. Navigiere zu Einstellungen.
3. Click API-Schlüssel.
   

4. Klicke auf Privaten API-Schlüssel erstellen.
5. Den API-Schlüssel benennen.
6. Wähle unter Zugriffsebene auswählen den Zugriff aus, den deine Integration benötigt:
   • Schreibgeschützter Schlüssel: gewährt Lesezugriff für alle verfügbaren API-Berechtigungen.
   • Vollzugriffsschlüssel: gewährt Lese-/Schreibzugriff für alle verfügbaren API-Berechtigungen.
   • Benutzerdefinierter Schlüssel: Damit kannst du für jede Zeile unter API-Bereiche Kein Zugriff, Lesezugriff oder Lese-/Schreibzugriff auswählen. Wähle den Zugriff für mindestens 1 Berechtigung aus.

7. Wähle Erstellen.
8. Verwende auf der Bestätigungsseite das Kopiersymbol (Schlüssel kopieren) oder das Download-Symbol (Herunterladen (.txt)), um den Schlüssel an einem sicheren Ort zu speichern. Du kannst dir den vollständigen Schlüssel nicht noch einmal ansehen, nachdem du diese Seite verlassen hast.
9. Wähle Schließen aus, um zu API-Schlüssel zurückzukehren.

Wenn du jetzt einen privaten API-Schlüssel teilst, hat die Drittpartei nur Zugriff auf die Informationen, die du im Umfang definiert hast.

Einen privaten API-Schlüssel klonen

Beim Klonen wird ein neuer privater API-Schlüssel mit den Scopes des ursprünglichen Schlüssels erstellt. Umbenannte Scopes verwenden ihre aktuellen Namen, und veraltete Scopes ohne Ersatz werden ausgelassen.

Beachte:

• Durch das Klonen wird nicht derselbe Schlüssel wie beim ursprünglichen privaten API-Schlüssel generiert.
• Ein geklonter API-Schlüssel hat denselben Namen wie das Original. Du kannst ihn in den Einstellungen für API-Schlüssel nicht umbenennen.

So klonst du einen privaten API-Schlüssel:

1. Gehe zu Einstellungen > API-Schlüssel.
2. Klicke auf das 3-Punkte-Menü neben dem Schlüssel, den du klonen möchtest.
3. Wähle Klonen aus, und wähle dann im Bestätigungsdialog erneut Klonen aus.

4. Verwende das Kopiersymbol (Schlüssel kopieren) oder das Download-Symbol (Herunterladen (.txt)), um den neuen Schlüssel an einem sicheren Ort zu speichern, und wähle dann Schließen aus. Du kannst den vollständigen Schlüssel nicht noch einmal ansehen, nachdem du diese Seite geschlossen hast.
5. Wenn du den ursprünglichen Schlüssel ersetzt, aktualisiere alle Integrationen, die ihn verwenden, und bestätige, dass sie mit dem neuen Schlüssel funktionieren. Lösche den ursprünglichen Schlüssel nur, wenn er nicht mehr benötigt wird.

Verwenden von Abfrageparametern

Der Parameter include fügt einer API-Antwort zugehörige Daten hinzu. Der Parameter scopes wählt Berechtigungen auf der Erstellungsseite für private API-Schlüssel vorab aus. Dies sind separate erweiterte Anwendungsfälle von URL-Abfrageparametern. Wenn du mit ihnen nicht vertraut bist, arbeite mit Entwickler*innen zusammen.

Füge verwandte Daten in eine API-Antwort ein

Wenn ein Endpunkt den Abfrageparameter include unterstützt, benötigt dein Schlüssel die Berechtigung, sowohl die angeforderte Ressource als auch die zugehörigen Daten zu lesen.

Beispielsweise ruft GET /api/profiles/{id}/ ein einzelnes Profil ab und erfordert profiles:read. Ersetze {id} durch die ID des Profils.

Um die Listen dieses Profils einzuschließen, verwende GET /api/profiles/{id}/?include=lists sowohl mit profiles:read als auch mit lists:read. Der Endpunkt der Profile-Collection (GET /api/profiles/) unterstützt das Einschließen von Listen nicht.

Geltungsbereiche auf der Erstellungsseite vorauswählen

Füge den Abfrageparameter scopes zur URL für das Erstellen des privaten API-Schlüssels hinzu, um Zugriffslevel im Formular vorauszuwählen.

Verwende eine durch Kommata getrennte Liste von Scope-Namen. Prüfe den ausgewählten Zugriff, gib einen Namen für den Schlüssel ein und wähle Erstellen aus. Kopiere oder lade dann den Schlüssel herunter, bevor du die Bestätigungsseite schließt.

Eine Beispiel-URL ist:
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write

Navigiere zu unserem Entwicklerportal, um die Geltungsbereiche, die du in dieser Abfrage verwenden kannst, anzusehen.

Weitere Ressourcen