Документація ComboPocket API v2

ComboPocket API — це спосіб під'єднати мобільний збір даних до будь-якої облікової системи, яка вміє виконувати HTTP-запити.

Ви надсилаєте завдання на термінал оператора й забираєте результат назад. Готова обробка не потрібна, доступ до внутрішньої структури нашої бази — теж.

Обмін побудовано максимально просто: усі операції — POST з тілом у JSON, авторизація одним заголовком, результат — в одному полі відповіді.

Нижче — розділи документації та мінімум, який варто прочитати перед першим запитом.

Розділи

Що потрібно знати до першого запиту

Базова адреса API — https://combopocket.online/v2/exchange.

Кожен запит несе заголовок X-API-Token з токеном вашої бази. Входу в систему й сесій немає: система сама визначає за токеном, до якої бази належать дані.

Токени можна отримати безкоштовно й автоматично — прямо зараз, на сторінці тарифу Free.

Отримання токена не потребує оплати: реєструєтеся, отримуєте доступ і починаєте тестувати обмін.

Отримати токени безкоштовно ↗

Результат операції сервер кладе в тіло відповіді — у поле ok.

Тіло — джерело істини, і воно приходить із будь-яким кодом відповіді: уся обробка на вашому боці може зводитися до перевірки одного поля.

{
  "ok": true,
  "error": ""
}

HTTP-код — це рівень транспорту: він каже лише, чи доїхав запит до бізнес-обробки. Сам бізнес-результат — завжди в тілі, у полях ok та error:

• 200 — запит дійшов і оброблений, результат дивіться в ok;
• 4xx — запит до обробки не дійшов;
• 5xx — збій на нашому боці.

Повна таблиця кодів — у розділі «З чого почати».

Токен бази й токени операторів

Для одного токена бази може існувати багато токенів операторів.

Токен бази ідентифікує вашу облікову систему в цілому. Токени операторів адресують конкретні документи конкретним виконавцям усередині однієї бази: ви вказуєте токен оператора під час надсилання завдання — і документ з'являється на терміналі саме цього оператора.

Для невеликого магазину або для розробки достатньо токена бази й одного токена оператора — обидва видаються на сторінці тарифу Free.

Якщо ж ви розгортаєте багатооператорну роботу, знадобиться більше токенів операторів — по одному на кожного виконавця.

З боку головної бази маршрутизацію даних можна налаштувати як завгодно: наприклад, документи по групі магазинів одного району надсилати на телефон оператора А, решту — іншим виконавцям. Ви самі вирішуєте, який токен оператора вказати в кожному завданні.

Порядок під'єднання

1. Отримайте токени — безкоштовно й автоматично на сторінці тарифу Free.
2. Перевірте зв'язок викликом ping — переконайтеся, що адреса й токен правильні.
3. За потреби вивантажте таблицю штрих-кодів: це потрібно лише щоб оператор міг додавати товар поза завданням.
4. Надішліть перше завдання — перерахунок або надходження.
5. Опитуйте status, а після Done заберіть результат через download і видаліть документ.