Authentifizierung

Authentifizieren Sie Anfragen an die BoxHero API mit einem Bearer-Token und senden Sie sie an die versionierte Basis-URL.

API-Tokens

Jede Anfrage muss einen API-Token als Bearer-Token im Header Authorization enthalten:

Authorization: Bearer <api-token>

Erstellen Sie Tokens in der BoxHero-App unter Einstellungen > Integrationen. Jeder Token ist an genau ein Team gebunden: Jede Anfrage liest und schreibt ausschließlich die Daten dieses Teams. Um mit mehreren Teams zu arbeiten, erstellen Sie in jedem Team einen eigenen Token.

Anonymer Zugriff wird nicht unterstützt. Fehlt der Token oder ist er ungültig, gibt jeder Endpunkt 401 mit einem Fehlerobjekt zurück.

Basis-URL und Versionierung

Alle Anfragen gehen an:

https://rest.boxhero-app.com

Alle Endpunkte liegen unter dem Präfix /v1 – zum Beispiel GET /v1/items.

Team-Modus

Die meisten Endpunkte stehen nur Teams zur Verfügung, die ihren Bestand nach Standort verwalten. Für andere Teams geben sie 400 mit dem Fehlertyp /errors/invalid-team-mode zurück. Endpunkte für Teams, Mitglieder, Partner und Attribute funktionieren für alle Teams – rufen Sie Get the linked team auf, um zu sehen, welchen Modus Ihr Team verwendet.