Démarrage rapide

Générez un jeton d’API et envoyez votre première requête à l’API BoxHero.

Ce guide vous accompagne de l’absence de jeton jusqu’à votre premier appel d’API réussi.

1. Générer un jeton d’API

Dans l’application web sur ordinateur, ouvrez l’équipe que vous souhaitez connecter et allez dans Paramètres > Intégrations et API. Générez un nouveau jeton d’API et copiez-le.

2. Envoyer votre première requête

Appelez Get the linked team pour vérifier que le jeton fonctionne. Envoyez le jeton dans l’en-tête Authorization :

curl https://rest.boxhero-app.com/v1/teams/linked \
  -H "Authorization: Bearer $BOXHERO_API_TOKEN"

La réponse décrit l’équipe à laquelle appartient le jeton :

{
  "id": 149058,
  "name": "Acme Retail",
  "mode": 2,
  "currency_symbol": "$",
  "currency_code": "USD",
  "price_decimal_places": 2,
  "memo": null
}

Si vous obtenez plutôt une erreur 401, le jeton est absent ou a été copié de manière incomplète. Consultez Erreurs pour le format des erreurs.

3. Étapes suivantes

Listez votre stock avec List items, et découvrez comment récupérer toutes les pages dans Pagination.
Enregistrez les mouvements de stock avec Create a transaction — consultez Transactions pour les règles.
Soyez averti des changements au lieu d’interroger l’API en boucle grâce aux webhooks.
Parcourez tous les endpoints dans la référence de l’API.