Аутентификация

Аутентифицируйте запросы к BoxHero API с помощью Bearer-токена и отправляйте их на базовый URL с версией.

API-токены

Каждый запрос должен содержать API-токен в виде Bearer-токена в заголовке Authorization:

Authorization: Bearer <api-token>

Токены выпускаются в приложении BoxHero в разделе Настройки > Интеграции. Каждый токен привязан к одной команде: любой запрос читает и записывает только данные этой команды. Чтобы работать с несколькими командами, выпустите токен в каждой из них.

Анонимный доступ не поддерживается. Если токен не передан или недействителен, любой эндпоинт возвращает 401 с описанием ошибки.

Базовый URL и версии

Все запросы отправляются на:

https://rest.boxhero-app.com

Все эндпоинты находятся под префиксом /v1 — например, GET /v1/items.

Режим команды

Большинство эндпоинтов доступны только командам, которые ведут учёт остатков по местам хранения. Для остальных команд они возвращают 400 с типом ошибки /errors/invalid-team-mode. Эндпоинты команд, участников, контрагентов и атрибутов работают для любой команды — вызовите Получение связанной команды, чтобы узнать, какой режим использует ваша команда.