Перейти до основного вмісту

Технічна довідка API

Інтерактивна технічна довідка API Skynum показує endpoints, методи, параметри, приклади запитів і приклади відповідей.

Адреса: https://api.skynum.com/index.html.

OpenAPI YAML:

https://api.skynum.com/api-docs/v1/swagger.yaml

Коли використовувати​

Технічна довідка потрібна, коли розробник має перевірити:

  • точний endpoint;
  • HTTP-метод;
  • параметри query;
  • заголовки;
  • структуру JSON body;
  • приклад відповіді;
  • обовʼязкові поля;
  • назви технічних полів.

Ця база знань пояснює принципи, сценарії та безпечну логіку роботи. Інтерактивна довідка допомагає швидко перевірити технічну форму конкретного запиту.

Як читати endpoint​

Кожна операція має:

  • метод: GET, POST, PUT, DELETE;
  • шлях, наприклад /v1/products;
  • групу, наприклад Products;
  • короткий опис;
  • параметри;
  • приклад JSON-відповіді;
  • для write-запитів — схему request body.

Base URL​

Base URL API:

https://api.skynum.com

Endpoint додається після base URL.

Наприклад:

GET https://api.skynum.com/v1/products

Авторизація​

Для авторизованих запитів потрібен Personal API Token.

В інтерактивній довідці використовуйте кнопку Authorize і передайте токен у форматі Bearer.

У реальному запиті заголовок має виглядати так:

Authorization: Bearer <YOUR_API_TOKEN>

Докладніше: Доступ і авторизація API.

Приклади й реальні дані​

Приклади показують форму даних, але в реальній компанії ID, назви, статуси, склади, ціни й документи будуть іншими.

Не копіюйте ID з прикладів у робочу інтеграцію. Спочатку отримайте реальні ID зі своєї компанії через API або з платформи.

На що звертати увагу​

Перед використанням endpoint перевірте:

  • чи це read-запит або write-запит;
  • які поля обовʼязкові;
  • які query-параметри доступні;
  • чи є пагінація;
  • чи потрібно передавати with_custom_fields;
  • чи потрібно передавати extended;
  • чи впливає запит на облік;
  • які помилки може повернути API.
попередження

Інтерактивна довідка дозволяє виконувати запити до реального API. Не запускайте створення, оновлення, активацію, деактивацію або видалення без розуміння наслідків.

Підсумок​

Технічна довідка API допомагає перевірити форму конкретного запиту, а цей розділ бази знань пояснює принципи, сценарії та облікові наслідки роботи з API Skynum.

Останнє оновлення