API Skynum
API Skynum — це діючий інструмент для інтеграцій із сайтами, CRM, маркетплейсами, сервісами обміну даними, аналітикою та внутрішніми системами компанії.
API працює окремо від вебінтерфейсу платформи й доступний за адресою:
https://api.skynum.com
Технічна довідка API доступна за адресою https://api.skynum.com/index.html.
Цей розділ описує API V1, який уже використовується в робочих інтеграціях. Документація буде доповнюватися новими прикладами й сценаріями в міру розвитку API.
Для чого використовують API
API потрібен, коли зовнішня система має читати або передавати дані в Skynum без ручного введення.
Типові сценарії:
- синхронізація товарів, категорій і цін із сайтом або CRM;
- передавання покупців, постачальників і контактних даних;
- створення замовлень, продажів, повернень або інших документів;
- створення платежів і передавання оплат;
- отримання залишків, резервів і очікуваних поставок;
- оновлення статусів документів;
- побудова внутрішніх інтеграцій компанії.
Що входить в API V1
У поточному API описані окремі ресурси: довідники, категорії, товари, модифікації, контрагенти, документи, платежі, валюти, курси валют, додаткові ціни, власні довідники, знижки, звіти та склади.
З чого почати
- Узгодьте з командою Skynum, що API потрібен для вашого сценарію.
- Підготуйте окремого користувача для інтеграції.
- Видайте цьому користувачу роль із доступом до API.
- Згенеруйте персональний API-токен.
- Перевірте базові запити в інструменті для API-запитів.
- Побудуйте інтеграцію з урахуванням лімітів, черги запису й безпечної роботи з токеном.
Докладніше: доступ і авторизація, ліміти та безпечна робота.
Важливі принципи
API працює з реальними даними обліку. Запити на створення, оновлення, активацію або видалення можуть змінювати залишки, фінанси, взаєморозрахунки, статуси й аналітику.
Не тестуйте write-запити на робочих документах без розуміння наслідків. Для інтеграції використовуйте окремого користувача, тестові обʼєкти й чергу запису.