Autenticação
Autentique as requisições à API do BoxHero com um token Bearer e envie-as para a URL base com versão.
Tokens de API
Seção intitulada “Tokens de API”Toda requisição deve levar um token de API como token Bearer no cabeçalho Authorization:
Authorization: Bearer <api-token>Emita tokens no app BoxHero em Configurações > Integrações e API. Cada token está vinculado a uma única equipe: toda requisição lê e grava somente os dados dessa equipe. Para trabalhar com várias equipes, emita um token em cada uma delas.
O acesso anônimo não é permitido. Quando o token está ausente ou é inválido, todos os endpoints retornam 401 com um envelope de erro.
URL base e versionamento
Seção intitulada “URL base e versionamento”Todas as requisições vão para:
https://rest.boxhero-app.comTodos os endpoints ficam sob o prefixo /v1 — por exemplo, GET /v1/items.
Modo da equipe
Seção intitulada “Modo da equipe”A maioria dos endpoints está disponível apenas para equipes que gerenciam o estoque por local. Para as demais equipes, eles retornam 400 com o tipo de erro /errors/invalid-team-mode. Os endpoints de equipe, membros, parceiros e atributos funcionam para todas as equipes — chame Obter a equipe vinculada para ver qual modo a sua equipe usa.