Акаунт і налаштування компанії через API
Ці ресурси потрібні, коли інтеграція має знати, від чийого імені вона працює і що їй дозволено, як налаштовано облік компанії, які робочі місця Skynum.Каса є і які інтеграції підключені. Усі вони тільки для читання.
Endpoint-и
| Метод | Endpoint | Призначення |
|---|---|---|
| GET | /v1/account | API-користувач, його права, доступні філії, склади, каси й рахунки, компанія |
| GET | /v1/settings | параметри компанії (Налаштування → Параметри) |
| GET | /v1/computers | робочі місця Skynum.Каса, доступні користувачу |
| GET | /v1/integrations | підключені інтеграції компанії |
Акаунт
GET /v1/account повертає три обʼєкти: user, company і subscription.
Поля user:
| Поле | Призначення |
|---|---|
id, name, email, active | Користувач, від імені якого працює інтеграція. |
system_role, system_role_title | admin або custom і його назва, як у формі користувача. API працює тільки від імені custom-користувача. |
role_id, role_title | Роль компанії, призначена користувачу. |
permissions | Права ролі за розділами, як у формі ролі. Для admin список порожній: у нього всі права. |
filials, stocks, cashboxes, bankboxes | Філії, склади, каси й банківські рахунки, доступні користувачу (id, title). Записи поза цими списками API йому не показує. |
time_zone, locale | Часовий пояс і мова користувача. |
use_sales_register | Чи є в користувача власний вхід до фіскального реєстратора. |
permissions — список груп. У кожної групи є group (ключ розділу), title (назва вкладки у формі ролі) і permissions — права з key, title (назва права у формі ролі) і access. Для прав-перемикачів access — true/false. Для решти — обʼєкт «дія → значення»: read і update мають рівень all, owner, executor або none; create, delete, activate, deactivate — true/false. Дії, яких у права немає, у відповідь не потрапляють.
Поля company: id, title, registered_at.
subscription бачить тільки адміністратор компанії, тому для API-користувача це завжди null.
Параметри компанії
GET /v1/settings повертає список settings: key — ключ параметра, title — його назва в Налаштування → Параметри (null у застарілих і суто інтерфейсних ключів), value — поточне значення.
Для запиту потрібне право ролі «Доступ до налаштувань обліку», інакше API відповість 403.
Це той самий набір параметрів, який визначає, чи дозволений продаж без залишку, як працюють партії та серійні номери, округлення, ліміти чека Skynum.Каса тощо. Докладніше про самі параметри: Системні параметри.
Робочі місця Skynum.Каса
GET /v1/computers повертає список computers — робочі місця, доступні користувачу за його складами. Потрібне право «Компʼютери» в розділі Довідники ролі.
| Поле | Призначення |
|---|---|
id, title, active | Робоче місце. |
filial_id, stock_id, cashbox_id, currency_id, tax_id та *_title | Філія, склад, каса, валюта й податок робочого місця з назвами. |
typeprice, typeprice_title | Тип ціни продажу і його назва; для додаткової ціни — назва ціни. |
interchange_start_time | Час початку зміни. |
sales_register, sales_register_test_mode, fiscal_key_present | Фіскальний реєстратор, його тестовий режим і чи завантажено фіскальний ключ. Сам ключ API не повертає. |
products_sync, products_sync_title, show_remains, shared_showcase, exclude_group_product_ids | Які товари й залишки бачить каса. |
offline_support, offline_min_codes | Офлайн-режим. |
order_statuses, group_contragent_ids, sale_channel_id, master_template_id, qr_provider_id, nfc_provider_id | Замовлення, групи контрагентів, канал продажу, шаблон чека, QR- і NFC-оплата. |
skypos_device_name, skypos_version, skypos_synced_at | Пристрій, версія застосунку й час останньої синхронізації. |
Інтеграції
GET /v1/integrations повертає список integrations — один список, як екран Налаштування → Інтеграції: провайдери й інтернет-магазини разом. Параметр kind залишає один вид: delivery, banks, telephony, messengers, sms, acquiring, fiscal, shopwires.
Спільні поля: id, title, kind, kind_title, service, service_title, active, filial_id, filial_title, connected_at, last_history_logs.
last_history_logs — десять останніх записів журналу інтеграції, від нових до старих: at, level (info, success, warning, error), title і content — причина, як на екрані журналу інтеграції; content обрізається до 1000 символів.
У провайдерів додатково is_default, account_api_id, account_api_name, terms_synced_at, fields — налаштування з форми інтеграції (ключі ті самі, що у формі: наприклад, cash_register_id, alphaname_sms, payer_type) і mapping — відповідність зовнішніх довідників довідникам Skynum.
В інтернет-магазинів — усі налаштування форми магазину: товари (products_sync_active, products_sync_interval, products_stock_ids, typeprice, product_identifier, modification_identifier, upload_images, upload_products_without_remains тощо), замовлення (orders_sync_active, orders_sync_interval, orders_start_date, orders_contragent_id, orders_stock_id, activate_orders, refresh_orders_method, upload_orders_method, auto_payment_enabled, auto_fiscalization_enabled тощо), mapping; назви поруч з id: orders_contragent_title, orders_stock_title, products_stock_titles, auto_fiscal_provider_title; для полів-вибору (typeprice, product_identifier, modification_identifier, modification_title_kind, category_identifier, refresh_orders_method, upload_orders_method) поруч є *_title — назва, як у формі магазину; а також стан синхронізації: terms_synced_at, products_synced_at, orders_synced_at, products_sync_failed, orders_sync_failed.
Облікові дані інтеграцій API не повертає. Провайдерів бачить той, у кого є право «Інтеграції» в розділі Довідники ролі, магазини — право «Інтеграції» в розділі Інтернет-магазин; без обох прав API відповість 403.
Повʼязані матеріали
Підсумок
GET /v1/account каже інтеграції, хто вона і що їй дозволено; GET /v1/settings, GET /v1/computers і GET /v1/integrations показують, як налаштовано облік, каси й підключені сервіси. Усе це — читання; змінюються ці налаштування тільки в платформі.