Начало работы с API v1

API v1 предназначен для существующих интеграций, которым нужен прежний формат ответов. Новые интеграции рекомендуется строить по API v2.

Примеры ниже используют относительные URL. Подставьте адрес API вашего окружения перед указанным путем.

1. Получите токен

Legacy-клиент передает login в URL, а пароль — после Bearer в заголовке:

curl \
  -H 'Authorization: Bearer YOUR_PASSWORD' \
  'https://api.example.ru/auth/token/user%40example.com'

Успешный ответ содержит JWT в data.token. Токен действует 24 часа. Полный контракт описан в разделе «Авторизация».

Безопасность

Legacy endpoint помещает login в URL и использует заголовок нестандартным образом. Для новых клиентов используйте безопасный POST /auth/token из API v2.

2. Передавайте JWT

curl \
  -H 'Authorization: Bearer YOUR_JWT' \
  'https://api.example.ru/api/v1/get/catalog'

JWT требуется для всех маршрутов /api/v1/*.

3. Проверяйте status, а не только HTTP-код

Legacy API возвращает большинство ошибок с HTTP 200:

{
  "status": false,
  "data": {},
  "error": {
    "name": "AuthenticationError",
    "code": 401,
    "text": "Не указан токен в заголовке запроса Authorization"
  },
  "message": ""
}

Клиент обязан проверять поле status. Подробнее: «Формат ответов».

4. Учитывайте legacy-идентификаторы

Параметры id и id_list содержат UMI object ID. Это не внутренний ID PostgreSQL и не артикул товара. Для поиска по артикулам используйте GET /api/v1/get/items/by-stock.

5. Выберите нужный маршрут

Задача	Маршрут
Дерево каталога	GET /api/v1/get/catalog
Производители раздела	GET /api/v1/get/vendors/for/:id
Метаданные раздела	GET /api/v1/get/section-meta/:id
Один товар	GET /api/v1/get/item/:id
Товары по UMI ID	GET /api/v1/get/items?id_list=...
Товары по артикулам	GET /api/v1/get/items/by-stock?stock_list=...
Товары разделов	GET /api/v1/get/items/from?id_list=...
Конфигуратор	GET /api/v1/get/item/:id/configurator