Огляд API
REST API Silium для інтеграцій: сайт і маркетплейси, облікові системи (1С/BAS), телефонія, BI. Ті самі дані й ті самі права, що в інтерфейсі, але через HTTPS і JSON.
Базова адреса
Кожна компанія працює на власному піддомені, і він збігається з адресою кабінету:
https://<компанія>.silium.io/api/v1
Наприклад, якщо кабінет відкривається за адресою https://acme.silium.io, запити йдуть на https://acme.silium.io/api/v1/…. Тільки HTTPS.
Швидкий старт за 3 кроки
- Створіть окремого користувача для інтеграції з роллю, що містить лише потрібні права, і випустіть для нього токен у
Налаштування → API. Детально в розділі Авторизація і токени. - Передавайте токен у заголовку
Authorization: Bearer slm_live_…. - Зробіть перший запит:
curl "https://<компанія>.silium.io/api/v1/contact?per-page=5" \ -H "Authorization: Bearer $SILIUM_TOKEN"
Відповідь
{
"items": [ { "id": 42, "first_name": "Олена", "last_name": "Коваль", ... } ],
"total": 318,
"page": 1,
"per_page": 5
}Що доступно
| Розділ | Маршрути | Що можна |
|---|---|---|
| Контакти | /contact | CRUD, пошук, фільтри за каналами й доп. полями |
| Контрагенти | /account | CRUD, реквізити й адреси у фільтрах |
| Ліди | /lead | CRUD, рух воронкою, кваліфікація |
| Угоди | /opportunity | CRUD, етапи воронки, виграш/програш, позиції, рахунок і акт |
| Завдання | /task | CRUD |
| Замовлення | /order | CRUD, позиції, створення рахунку й відвантаження |
| Рахунки | /invoice | CRUD, позиції, відвантаження, акт |
| Платежі | /payment | CRUD |
| Товари | /product | CRUD, одиниці, ціни в прайсах, пошук за штрихкодом |
| Залишки | /stock/remainders | Кількість, резерв і доступний залишок |
| Довідники | /currency, /lookup, … | Лише читання: валюти, статуси, склади, категорії, доп. поля |
Чого поки немає в API
Ці розділи працюють в інтерфейсі, але через API поки недоступні. Якщо якийсь із них потрібен для інтеграції, напишіть нам: пріоритет визначаємо за запитами клієнтів.
| Розділ | Що недоступно |
|---|---|
| Склад | Відвантаження (крім створення із замовлення чи рахунку), прихід, закупівлі, переміщення, інвентаризація, списання, повернення, партії й серійні номери, WMS |
| Фінанси | Витрати, документи постачання, фінансові операції й перекази, кредити, підзвіт, основні засоби, бюджети, банківські виписки, платіжний календар, звіти |
| Ціни | Зміна прайс-листів, переоцінка, стратегії ціноутворення (ціни лише читаються) |
| Виробництво й проєкти | Виробничі замовлення, техкарти, робочі центри, MRP, проєкти, облік часу |
| Комунікації | Чати, пошта, телефонія, скрипти продажів |
| Службове | Файли й вкладення, коментарі та хронологія, друк документів (PDF), запуск бізнес-процесів, імпорт і експорт |
| HR | Зарплата, табель, відпустки |
| Налаштування | Зміна довідників, ролей і користувачів |
filter[updated_at;gte] і /deleted (див. Синхронізація). Події «запис створено/змінено» можна надсилати й зараз бізнес-процесом з дією «HTTP-запит».Головні правила
- ●Права беруться від користувача токена. Що заборонено ролі в інтерфейсі, заборонено й через API (
403). - ●Гроші передаються цілими числами в копійках (мінімальних одиницях валюти), кількість множиться на 1000. Див. Списки, поля, одиниці.
- ●Квоти за тарифом: не більше 5 запитів на секунду, бюджет очок і одночасні запити. Заголовки
X-RateLimit-*приходять у кожній відповіді, див. Ліміти та квоти. - ●Повтор POST без дубля забезпечує заголовок
Idempotency-Key. Див. Idempotency-Key. - ●Синхронізація:
external_id,filter[updated_at;gte]і/{сутність}/deleted. Див. Синхронізація. - ●Помилки приходять в одному форматі
{"error": {"code", "message"}}. Див. Помилки.
Версії та сумісність
Усі маршрути живуть під /api/v1. У межах v1 ми лише додаємо: нові маршрути, нові поля у відповідях, нові необов'язкові параметри. Клієнт має ігнорувати незнайомі поля. Зміни, що ламають сумісність, вийдуть як /api/v2з перехідним періодом.
/api/v1 повертають 404.