Wie man einen privaten API-Schlüssel erstellt oder klont

Du wirst lernen

Erfahre, wie du einen privaten API-Schlüssel erstellst, der eine eindeutige Kennung für API-Aufrufe ist, und wie du einen Bereich definierst. 

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

Über private API-Schlüssel und Geltungsbereiche

Mit einem API-Aufruf kannst du eine Software mit einer anderen verbinden. Diese Verbindung ermöglicht es einer Software, Informationen bei der anderen abzufragen, zu bearbeiten oder hinzuzufügen.  

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

Die Einbeziehung eines privaten API-Schlüssels fügt eine weitere Berechtigungsebene hinzu, die den Zugriff auf bestimmte Elemente für Dritte einschränkt. Scopes sind vergleichbar mit einem Hotelschlüssel, der dir nur Zugang zu bestimmten Bereichen gibt (wie deinem Zimmer oder dem Fitnessstudio) und nicht zum ganzen Gebäude. 

Arten von Geltungsbereichen

Wenn du einen privaten API-Schlüssel erstellst, musst du seinen Geltungsbereich auswählen. Mit anderen Worten: Du musst entscheiden, ob du willst, dass eine dritte Partei:

• Keinen Zugriff auf einen API-Endpunkt haben.
• Alle Daten für einen API-Endpunkt anzeigen, aber keine Änderungen vornehmen können (auch "schreibgeschützt" genannt). 
• Erstellen, Löschen und andere Änderungen an allem, was mit diesem Endpunkt verbunden ist (auch "Vollzugriff" oder "Schreibzugriff" genannt).

Angenommen, du möchtest Abonnent zu einer Klaviyo Liste von einer Drittanbieter-Software hinzufügen. In diesem Fall musst du vollen (Schreib-)Zugriff auf den API Endpunkt für Liste, Profil und Massenabonnement Profil haben. Die dritte Partei braucht jedoch keinen Zugang zu einem anderen Endpunkt. 

Du kannst mehr über die API vonKlaviyo erfahren und die verfügbaren Bereiche für jeden Endpunkt auf dem Entwicklerportal sehen. 

Bevor du beginnst

Bitte beachte die folgenden Punkte: 

• Nachdem du einen privaten API-Schlüssel erstellt hast, kannst du nicht mehr:
  • Sieh dir den privaten API-Schlüssel noch einmal an. 
    • Tipp: Speichere private API-Schlüssel sicher und notiere dir, wofür du sie verwenden willst, z. B. in einem Passwortmanager. 
  • Füge seine Geltungsbereiche hinzu oder bearbeite sie. 
    • Wenn du den Geltungsbereich ändern musst, besteht die einzige Möglichkeit darin, den ursprünglichen privaten API-Schlüssel zu löschen und dann einen neuen mit dem richtigen Geltungsbereich zu erstellen. 
• Private API-Schlüssel haben standardmäßig vollen Zugriff.

Wenn du dir nicht sicher bist, welche API Endpunkte, Bereiche oder Berechtigungen du benötigst, kontaktiere bitte einen Entwickler oder wende dich an einen Klaviyo Partner, um Hilfe zu erhalten. 

Einen privaten API-Schlüssel erstellen 

1. Klicke unten links auf den Namen deiner Organisation.
2. Navigiere zu Einstellungen.
3. Klicke auf API-Schlüssel.
   
4. Klicke auf Privaten API-Schlüssel erstellen.
5. Benenne den API-Schlüssel.
6. Wähle den Bereich aus, dem du den API-Schlüssel geben willst:
   • Schreibgeschützt
   • Vollständig
   • Benutzerdefiniert
     
7. Wähle Erstellen.

Wenn du jetzt einen privaten API-Schlüssel weitergibst, hat die dritte Partei nur Zugriff auf die Informationen, die du im Geltungsbereich festgelegt hast. 

Abfragen verwenden 

Abfragen werden in fortgeschrittenen Szenarien verwendet. Wenn du dich noch nicht mit Abfragen auskennst oder nicht weißt, wie man sie benutzt, empfehlen wir dir, mit einem Entwickler zusammenzuarbeiten. 

einbeziehen

Wenn du die Include-Abfrage verwendest, musst du das Format gegenüber der obigen Liste ändern.

Der Profil-Endpunkt lautet zum Beispiel /API/Profil.

Wenn du jedoch den Abfrageparameter include hinzufügst(/API/Profil?include=Liste), brauchst du auch Liste:read oder Liste:full access, je nachdem, welche Art von API du aufrufst.

Geltungsbereiche

Mit dem Parameter scopes kannst du einen URL-Parameter erstellen, mit dem du automatisch ausfüllen kannst, welchen Bereich du für deinen privaten API-Schlüssel benötigst. 

In der Bereichsabfrage fügst du eine durch Kommata getrennte Liste der Bereiche ein, die du vorauswählen möchtest. 

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

Einen privaten API-Schlüssel klonen

Mit dem privaten API-Schlüssel kannst du durch Klonen einen neuen Schlüssel erstellen, der denselben Geltungsbereich und dieselben Berechtigungen hat wie der Originalschlüssel.

Beachte das:

• Beim Klonen wird nicht der gleiche Schlüssel wie der ursprüngliche private API-Schlüssel erzeugt.
• Du kannst einen klonen API-Schlüssel nicht umbenennen; er hat den gleichen Namen wie der ursprüngliche Schlüssel. 

Klone einen privaten API-Schlüssel: 

1. Navigiere zur Registerkarte " API-Schlüssel" . 
2. Klicke auf das 3-Punkte-Menü neben der Taste, die du klonen möchtest. 
3. Wähle klonen > klonen. 
   
4. Kopiere oder lade den neuen privaten API-Schlüssel herunter und lade ihn an einem sicheren Ort. 
5. Stelle sicher, dass du deinen alten Schlüssel löschst, wenn du ihn nicht mehr brauchst. 

Zusätzliche Ressourcen

• Siehe unseren Artikel über die ersten Schritte mit Klaviyo API.
• Schau dir weitere Entwicklerdokumente an.
• Erfahre mehr darüber, wie du dein Konto sicher halten kannst.