API-Schlüssel
API-Schlüssel für externe Integrationen erstellen und Berechtigungen festlegen.
Ziel
Mit einem API-Schlüssel verbinden Sie externe Systeme mit planni, zum Beispiel um Kontakte oder Bestellungen automatisiert abzurufen.
Voraussetzungen
Zugriff auf Einstellungen → Integrationen → API-Schlüssel. Eine technische Anbindung, die den Schlüssel entgegennimmt.
Schritte
Einen API-Schlüssel erstellen
Öffnen Sie Einstellungen → Integrationen → API-Schlüssel und klicken Sie auf API-Schlüssel erstellen.
Vergeben Sie einen Namen und optional eine Beschreibung, damit Sie den Schlüssel später wiedererkennen.
Legen Sie die Berechtigungen fest. Wählen Sie entweder Vollzugriff oder setzen Sie die Zugriffsstufe je Bereich einzeln: Kontakte (Kein Zugriff, Lesen, Lesen & Schreiben), Bestellungen (Kein Zugriff, Lesen), Events (Kein Zugriff, Lesen) und Webhooks (Kein Zugriff, Verwalten).
Klicken Sie auf API-Schlüssel erstellen.
Der vollständige Schlüssel wird nur direkt nach dem Erstellen einmal angezeigt, mit einer Kopieren-Funktion. Notieren Sie ihn sofort an einem sicheren Ort, später lässt er sich nicht erneut einsehen.
Einen Schlüssel verwenden
Alle verfügbaren Endpunkte und wie Sie den Schlüssel dabei übergeben, beschreibt die API-Referenz.
Ergebnis
Ihr externes System kann sich mit dem Schlüssel gegenüber planni ausweisen und hat genau die Berechtigungen, die Sie beim Erstellen festgelegt haben.
Stolpersteine
Der Schlüssel ist verloren gegangen
Der vollständige Schlüssel lässt sich nicht erneut anzeigen. Erstellen Sie einen neuen Schlüssel und hinterlegen Sie ihn in Ihrer Integration, den alten können Sie dann entfernen.
Die Integration bekommt "Keine Berechtigung"
Prüfen Sie in der Liste, welche Berechtigungen dem Schlüssel zugeordnet sind, unter Berechtigungen. Ein Schlüssel mit reinem Lesezugriff auf Bestellungen kann zum Beispiel keine Bestellungen anlegen.