Authentifizierung
API-Token anlegen, verwenden und löschen.
Jede Anfrage an die Data Export API braucht einen API-Token im Header Authorization:
Authorization: Bearer ph_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxEin Token beginnt immer mit ph_, gefolgt von 48 Zeichen.
API-Token anlegen
API-Tokens können nur Inhaber und Admins eines Accounts verwalten. Der API-Zugang ist im Enterprise-Plan enthalten.
Schritt 1: Öffne die Accountverwaltung und scrolle zur Box API-Zugriff.
Schritt 2: Gib unter Name des Tokens einen Namen ein, an dem du später erkennst, wofür der Token genutzt wird, zum Beispiel BI-Export.
Schritt 3 (optional): Hat dein Account mehrere Projekte, kannst du den Token unter Auf Projekte beschränken (optional) auf einzelne Projekte begrenzen. Ohne Auswahl gilt der Token für alle Projekte des Accounts, auch für später angelegte.
Schritt 4: Klicke auf Token erstellen.
Schritt 5: Kopiere den Token mit Kopieren und speichere ihn sicher, zum Beispiel in einem Passwort-Manager oder als Secret in deinem Tool. Er wird aus Sicherheitsgründen nur dieses eine Mal angezeigt.
Behandle den Token wie ein Passwort: Er gibt Lesezugriff auf alle Antworten der freigegebenen Projekte, inklusive der übermittelten Benutzerattribute wie E-Mail-Adressen. Gib ihn nicht in öffentlichen Code oder in den Browser.
Regeln für API-Tokens
- Ein Token gehört zum Account, nicht zu einer Person. Er bleibt gültig, wenn die Person, die ihn angelegt hat, den Account verlässt.
- Ein Token gilt für alle Projekte des Accounts oder nur für die Projekte, auf die er beim Anlegen beschränkt wurde. Die Beschränkung lässt sich nachträglich nicht ändern. Lege in diesem Fall einen neuen Token an.
- Ein Token hat nur Lesezugriff. Über die API lässt sich nichts ändern oder löschen.
- Tokens laufen nicht ab. Sie gelten, bis du sie löschst.
- Ein Account kann höchstens 20 Tokens haben.
In der Box API-Zugriff siehst du zu jedem Token, wer ihn wann erstellt hat, für welche Projekte er gilt und wann er zuletzt verwendet wurde.
API-Token löschen
Klicke in der Box API-Zugriff beim gewünschten Token auf Token löschen und bestätige. Der Token wird sofort ungültig. Anwendungen, die ihn verwenden, verlieren den Zugriff.
Wenn ein Token in falsche Hände geraten sein könnte, lösche ihn sofort und lege einen neuen an.
Fehler bei der Authentifizierung
| Status | Bedeutung |
|---|---|
401 | Der Token fehlt oder ist ungültig, zum Beispiel weil er gelöscht wurde. |
403 | Der Plan des Accounts enthält keinen API-Zugang. |
404 | Die Umfrage gehört zu einem anderen Account oder zu einem Projekt, auf das der Token keinen Zugriff hat. |
Mehr zu Fehlern unter Grundlagen.