Быстрый старт

Выпустите API-токен и отправьте первый запрос к BoxHero API.

Это руководство проведёт вас от получения токена до первого успешного вызова API.

1. Выпустите API-токен

В веб-приложении для компьютера откройте команду, которую хотите подключить, и перейдите в Настройки > Интеграции. Создайте новый API-токен и скопируйте его.

2. Отправьте первый запрос

Вызовите Получение связанной команды, чтобы проверить, что токен работает. Передайте токен в заголовке Authorization:

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

Ответ описывает команду, которой принадлежит токен:

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

Если вместо этого вы получили 401, токен не передан или скопирован не полностью. Формат ошибок описан в разделе Ошибки.

3. Что дальше

Получите список остатков с помощью Список товаров и узнайте, как получить все страницы, в разделе Пагинация.
Записывайте изменения остатков с помощью Создание операции — правила описаны в разделе Операции.
Получайте уведомления об изменениях вместо регулярных опросов с помощью вебхуков.
Просмотрите все эндпоинты в справочнике API.