Структура запиту

Усі запити надсилаються так:

• HTTP метод: POST
• Заголовок: Content-Type: application/json
• Тіло: JSON об'єкт

Загальна схема

{
  "auth": { "login": "<LOGIN>", "password": "<PASSWORD>" },
  "method": "get.products.list",
  "params": { },
  "meta": {
    "user_card": "<USER_CARD>",
    "client_name": "MyIntegration",
    "client_version": "1.0.0"
  },
  "id": "req-001"
}

Поля верхнього рівня

• auth (опційно): якщо не використовуєте Basic Auth

  • login (string, required)
  • password (string, required)

• method (string, required): назва методу

• params (object, optional): параметри конкретного методу
  Якщо немає параметрів, передавайте {} або просто не передавайте поле.

• meta (object, optional): технічні метадані

  • user_card (string або number, майже завжди required)
  • client_name (string, optional)
  • client_version (string, optional)

• id (string або number, optional): ваш ідентифікатор запиту
  API поверне його у відповіді, щоб вам було зручніше корелювати логи.

Рекомендації

• Завжди передавайте id. Це реально економить час під час пошуку проблем.
• Передавайте client_name і client_version, щоб у Query_log було видно, хто саме робив запит.