Authentification
Authentifiez les requêtes à l’API BoxHero avec un jeton Bearer et envoyez-les à l’URL de base versionnée.
Jetons d’API
Section intitulée « Jetons d’API »Chaque requête doit inclure un jeton d’API en tant que jeton Bearer dans l’en-tête Authorization :
Authorization: Bearer <api-token>Générez des jetons dans l’application BoxHero sous Paramètres > Intégrations et API. Chaque jeton est lié à une seule équipe : chaque requête lit et écrit uniquement les données de cette équipe. Pour travailler avec plusieurs équipes, générez un jeton dans chacune d’elles.
L’accès anonyme n’est pas pris en charge. Lorsque le jeton est absent ou invalide, tous les endpoints renvoient 401 avec une enveloppe d’erreur.
URL de base et gestion des versions
Section intitulée « URL de base et gestion des versions »Toutes les requêtes sont envoyées à :
https://rest.boxhero-app.comTous les endpoints se trouvent sous le préfixe /v1 — par exemple, GET /v1/items.
Mode de l’équipe
Section intitulée « Mode de l’équipe »La plupart des endpoints ne sont disponibles que pour les équipes qui gèrent leur stock par site. Pour les autres équipes, ils renvoient 400 avec le type d’erreur /errors/invalid-team-mode. Les endpoints des équipes, membres, partenaires et attributs fonctionnent pour toutes les équipes — appelez Get the linked team pour savoir quel mode utilise votre équipe.