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

Übersicht

Erfahre, wie du einen privaten API-Schlüssel erstellst, der als eindeutige Kennung für API-Aufrufe verwendet wird, und wie du einen Scope definierst.

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

Wenn du einen API-Aufruf machst, ermöglicht das einer Software, sich mit einer anderen zu verbinden. Diese Verbindung ermöglicht es einer Software, Informationen bei der anderen anzufordern, zu bearbeiten oder hinzuzufügen. 

Ein privater API-Schlüssel stellt sicher, dass diese Anfrage die richtigen Berechtigungen hat (d. h., dass sie von einer*m autorisierten Nutzer*in, Konto oder Programm stammt). Stell es dir wie einen Haustürschlüssel vor: Er lässt dich und deine Familie rein, hält aber alle anderen draußen.

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.

Arten von Bereichen

Wenn du einen privaten API-Schlüssel erstellst, musst du seinen Geltungsbereich auswählen. Das heißt, du musst entscheiden, ob du möchtest, dass ein Drittanbieter:

• Keinen Zugriff auf einen API-Endpunkt haben.
• Alle Daten für einen API-Endpunkt anzeigen, aber keine Änderungen vornehmen können (auch als „schreibgeschützt“ bezeichnet).
• Alles, was mit diesem Endpunkt verknüpft ist, erstellen, löschen und weitere Änderungen vornehmen (auch „voller Zugriff“ oder „Schreibzugriff“ genannt).

Nehmen wir zum Beispiel an, du möchtest über eine Drittanbieter-Software Abonnent*innen zu einer Klaviyo-Liste hinzufügen. In diesem Fall musst du über vollständigen (Schreib-)Zugriff auf die API-Endpunkte für Listen, Profile und das Massen-Abonnieren von Profilen verfügen. Der Drittanbieter benötigt jedoch keinen Zugriff auf andere Endpunkte.

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:
  • Privaten API-Schlüssel erneut anzeigen.
    • 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 Scopes ändern musst, ist die einzige Option, den ursprünglichen privaten API-Schlüssel zu löschen und dann einen neuen mit dem richtigen Scope zu erstellen.
• Private API-Schlüssel haben standardmäßig vollständigen Zugriff.

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 den Umfang aus, den du dem API-Schlüssel geben möchtest:
   • Schreibgeschützt
   • Vollumfänglich
   • Benutzerdefiniert

7. Wähle Erstellen.

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

Abfragen verwenden

Abfragen werden in erweiterten Szenarien verwendet. Wenn du noch nicht mit Abfragen oder ihrer Verwendung vertraut bist, empfehlen wir, mit Entwickler*innen zusammenzuarbeiten.

Einbeziehen

Beachte, dass du, wenn du versuchst, die include -Abfrage zu verwenden, das Format gegenüber dem oben aufgeführten ändern musst.

Zum Beispiel lautet der Profil-Endpunkt /api/profiles.

Wenn du jedoch den include-Abfrageparameter hinzufügst (/API/profiles?include=list), Außerdem benötigst du list:read oder list:full access, je nachdem, welche Art von API-Aufruf du machst.

Geltungsbereiche

Mit dem Parameter scopes kannst du einen URL-Parameter erstellen, um automatisch auszufüllen, welchen Scope-Zugriff du für deinen privaten API-Schlüssel benötigst.

Füge in der Scopes-Abfrage eine kommagetrennte Liste der Scopes ein, die du vorab auswählen möchtest.

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.

Einen privaten API-Schlüssel klonen

Mit privaten API-Schlüsseln kannst du durch Klonen einen neuen Schlüssel erstellen, der dieselben Scopes und Berechtigungen wie der ursprüngliche Schlüssel hat.

Beachte:

• Durch das Klonen wird nicht derselbe Schlüssel wie beim ursprünglichen privaten API-Schlüssel generiert.
• Du kannst einen geklonten API-Schlüssel nicht umbenennen; er hat denselben Namen wie der ursprüngliche Schlüssel.

So klonst du einen privaten API-Schlüssel:

1. Navigiere zur Registerkarte API-Schlüssel .
2. Klicke auf das 3-Punkte-Menü neben dem Schlüssel, den du klonen möchtest.
3. Wähle Klonen > Klonen.
   

4. Kopiere oder lade den neuen privaten API-Schlüssel herunter und speichere ihn an einem sicheren Ort.
5. Denke daran, deinen alten Schlüssel zu löschen, wenn er nicht mehr benötigt wird.

Weitere Ressourcen