Начало
Быстрый старт
Четыре шага от нуля до первого осмысленного ответа.
- 1Запросите ключКлючи выпускает владелец платформы. Укажите бренд, назначение интеграции и нужные права.
- 2Положите ключ в переменную окруженияНе в код и не во фронтенд: ключ равносилен доступу сотрудника к вашему бренду.
- 3Сделайте пробный запросНачните с чтения — списка заказов или остатков. Изменяющие запросы оставьте на потом.
- 4Проверьте единицы и брендСуммы в копейках, а в выдаче должны быть только ваши данные.
Первый запрос
Возьмём список последних заказов. Это безопасно: запрос только читает и ничего не меняет.
curl -s "https://api.amarix.ru/orders/admin/all?limit=5" \
-H "Authorization: Bearer $AMARIX_KEY"Как читать ответ
Три вещи, которые стоит проверить сразу на первом же ответе.
Код ответа. 200 — всё хорошо. 401 — ключ не принят. 403 — ключ принят, но не хватает прав или вы просите чужое. Разбор всех вариантов в разделе про ошибки.
Суммы. В копейках. Сверьте одно значение с тем, что видно в админке.
Бренд. В выдаче должны быть только ваши заказы. Пустой список при заведомо существующих заказах означает, что ключ выпущен для другого бренда.
Что дальше
Прочитайте термины — без них поля ответа выглядят загадочно. Затем выберите свой сценарий:
- синхронизация заказов — раздел «Заказы»;
- обмен остатками — «Склад и остатки»;
- приложение для цеха — «Производство»;
- приём заказов из внешней системы — «Входящие вебхуки».