Автентифікація

Публічне API SkyService використовує особистий API-токен. Ви створюєте його в адмін-панелі, і запити через нього виконуються від імені акаунта, під яким ви авторизовані (з усіма його правами). Кожен бізнес-запит несе два query-параметри:

  • companyId — UUID компанії.
  • token — ваш API-токен.
<baseUrl>/?section=publicInterface&action=getClient&companyId=<companyId>&token=<token>

Як отримати токен

Усе потрібне — на одній сторінці адмін-панелі: Розробникам → API токени. Там показані ваші baseUrl і companyId (обидва копіюються), а також список токенів.

  1. Відкрийте Розробникам → API токени.
  2. Скопіюйте baseUrl і companyId.
  3. Натисніть «Додати токен» і скопіюйте згенерований токен зі списку.

Обмеження прав (scoped-доступ)

Токен діє з правами акаунта, під яким ви авторизовані. Щоб видати інтеграції лише потрібний доступ — створіть окремого працівника з мінімальними правами (розділи, склади, торгові точки, гаманці) і згенеруйте токен, увійшовши під ним.

Запит до ендпоінта, на який немає прав, повертає помилку без даних:

{ "status": "error", "error": ["access denied"] }

Використання

Підставляйте baseUrl, companyId і token у бізнес-запити. Наприклад — publicInterface/getClient:

curl "<baseUrl>/?section=publicInterface&action=getClient&companyId=<companyId>&token=<token>&clientPhone=380000000000"

Формат відповіді

Кожна відповідь — JSON із полем status (HTTP завжди 200):

{ "status": "done",  "data": { } }
{ "status": "error", "error": ["опис помилки"] }

Завжди перевіряйте status, а не HTTP-код. Докладніше — у гайді Помилки.

Термін дії та відкликання

Токен діє, поки його не відкликати. Щоб відкликати — на тій самій сторінці API токени видаліть токен: інтеграції, що ним користуються, одразу втратять доступ. Діє ліміт — до 10 токенів на акаунт.