PDF
Розділ: Вступ і швидкий старт
Для інтеграторів · API v1

API інтеграцій ApexSFA

Підключіть облікову систему, систему виробника чи свою CRM: HTTPS і JSON, підпис кожного запиту, ідемпотентні операції, файли-відповіді й журнал обміну. Усе, що потрібно, щоб зробити інтеграцію самостійно.

З чого почати Запросити доступ Завантажити PDF
Базова адреса
https://api.apexsfa.com/api/v1
Формат
HTTPS, JSON, UTF-8; файли заказів — XML, CSV, JSON
Ліміти
600 запитів/хв на обмін; пакет до 5000 конвертів
Версіонування
у межах v1 — лише сумісні зміни

Як усе повʼязано

Схема обміну даними ApexSFA Облікова система Виробник API або SFTP дані заявки файли ApexSFA заявки, склад, логістика вебхуки CRM, BI, бот Торгові й менеджери
Обидва напрямки обміну ініціює облікова система — публічна адреса їй не потрібна, достатньо вихідного HTTPS.

Що можна інтегрувати

Обмін з обліковою системою

Довідники, ціни, залишки, продажі, борги й каса — в ApexSFA; заявки, оплати, приходи й рейси — назад в облік.

Ключ обміну + підпис

Готова обробка обміну

Для облікових систем BAS і сумісних: карта відповідностей замість програмування.

Без коду

Файли заказів через API

Виробник надсилає файл заказів, менеджер дистрибʼютора обробляє, ви забираєте файл-відповідь.

API-токен

SFTP

Те саме без програмування: файли в теку incoming, результат — у processed або failed.

Ключ ed25519

Вебхуки

Події заявок у вашу CRM, BI чи бот: підтверджено, у доставці, доставлено, скасовано.

HMAC-SHA256

Довідник ендпоінтів

Усі ендпоінти з параметрами й кодами відповідей, специфікація OpenAPI.

OpenAPI 3

З чого почати за 15 хвилин

Позначайте кроки — прогрес збережеться в цьому браузері.

Облікова система дистрибʼютора

0 / 5

  1. Отримаєте Tenant Id, ключ обміну й адресу тестового середовища. Детальніше →

  2. curl https://api.apexsfa.com/api/v1/health → {"status":"ok"}.

  3. SHA-256 від t.тіло.ключ — звірте з контрольним прикладом. Детальніше →

  4. Один склад через inbound/batch → accepted_count: 1. Детальніше →

  5. outbox/pull → створіть документ → outbox/ack з вашим GUID. Детальніше →

Виробник: файли заказів

0 / 5

  1. Через дистрибʼютора або форму доступу — отримаєте asfa_…. Детальніше →

  2. XML, CSV або JSON — візьміть шаблон із прикладів. Детальніше →

  3. POST /exchange/order-files → збережіть id. Детальніше →

  4. GET /exchange/order-files раз на 5–15 хв.

  5. Коли response_ready: true — GET …/{id}/response. Детальніше →

Потрібні тестові ключі?

Видаємо тестове середовище з даними для перевірки сценаріїв, а після запуску — супровід перших днів обміну.

Запросити доступ