Mit der API authentifizieren
Um die REST-API nutzen zu können, ist eine Authentifizierung mit einem API Key erforderlich.
API Key erstellen
API Keys können in campflow über das Zahnrad-Symbol und anschließendem Klick auf “Entwickler:innen” verwaltet werden. Dort kannst du über “API Key erstellen” einen neuen Key anlegen. Du kannst beliebig viele Keys erstellen, z.B. einen pro Anwendung, die auf campflow zugreift.
Beim Erstellen wählst du zunächst die Art des Keys und gibst ihm anschließend einen Namen. Beschreibe im Namen, wofür der Key verwendet wird. So erkennst du später, welchen Key du neu generieren oder widerrufen musst.
Der API Key wird dir nur einmalig, direkt nach der Erstellung, angezeigt und läuft niemals aus. Bewahre ihn mit derselben Sorgfalt auf wie ein Passwort.
Arten von API Keys
| Art | Beschreibung |
|---|---|
| Service Key | Unabhängig von einzelnen Usern. Geeignet für dauerhafte Integrationen mit anderen Anwendungen. |
| Persönlicher Key | Handelt in deinem Namen und hat dieselben Berechtigungen wie du. Der Key wird inaktiv, sobald du keine Admin-Berechtigung mehr hast. Nur du selbst kannst deinen persönlichen Key neu generieren. |
Da ein persönlicher Key deine Berechtigungen übernimmt, kann er nur auf die Daten zugreifen, auf die du selbst Zugriff hast. Anfragen auf andere Daten werden mit einem 403 Statuscode abgelehnt.
API Key bei Anfragen übergeben
Um den API Key zu übergeben, muss er als Bearer Token im Authorization Header deiner REST-API-Anfrage enthalten sein. Hier ist ein Beispiel:
Authorization: Bearer <dein_api_key>
Fehlt der API Key, ist er ungültig oder inaktiv, wird ein 401 Statuscode zurückgegeben.
API Key neu generieren oder widerrufen
API Keys laufen nicht automatisch ab, können aber jederzeit neu generiert oder widerrufen werden. Klicke dazu in der Übersicht auf den jeweiligen Key.
Mit “Neu generieren” wird ein neuer Key ausgestellt. Der bisherige Key funktioniert danach sofort nicht mehr und alle Anwendungen, die ihn verwenden, müssen auf den neuen Key umgestellt werden.
Mit “Widerrufen” wird der Key dauerhaft gelöscht und funktioniert sofort nicht mehr. Alle anderen API Keys bleiben davon unberührt.