Просмотр кода страницы API UK

[[API_EN|en]] | '''uk''' | [[API|ru]]

Цей розділ описує можливості використання вбудованого API в ERP "UserSide", що дозволяє використовувати вбудований функціонал у власних проєктах. 

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

== Принцип роботи ==

За взаємодію відповідає файл /api.php

Можна використовувати і GET, і POST-запити.

 Вхідні параметри:
 Обов'язкові:
  key - ключ API
  cat - категорія запиту
 Необов'язкові:
  skip_internal_api - прапорець - не включати внутрішні тригери системи ''(доцільно використовувати, коли ваш метод API є реакцією на певний тригер і в результаті під час звичайної роботи сам зациклює свою роботу)''
 Інші додаткові параметри, залежно від категорії ''(див. нижче у відповідних категоріях)''. Наприклад:
  customer_id - id абонента
  is_potential - прапорець. Може набувати значення 1 або 0. Більшість прапорців мають префікс '''is'''.
  lang - мова, якою повертати відповідь ''(в об'єктах, де підтримується локалізація. За замовчуванням: en)''
 
 Приклад запиту:
 api.php?key=apikey&cat=abon&action=msg&usercode=1

 Дані, що повертаються:
  Якщо запит передбачає певну дію або повернення інформації, інформація буде повернена у форматі JSON:
   array(
    [Result] => OK / ERROR
    [ErrorText] => У разі помилки - текст помилки
   )

 Також варто перевіряти HTTP-код відповіді. У разі помилок або некоректних запитів HTTP-код відрізнятиметься від 200

== Основне налаштування ==

Налаштуйте [[UserSide API Key_UK|API-ключ]].

== Категорії ==
* [[API_address_UK|address]] - Адреси
* [[API_attach_UK|attach]] - Прикріплені файли
* [[API_additional_data_UK|additional_data]] - Додаткові поля/дані для об'єктів
* [[API_advertising_UK|advertising]] - Рекламні кампанії
* [[API_billing_UK|billing]] - Білінги
* [[API_cable_route_UK|cable_route]] - Кабельні траси і канали
* [[API_call_UK|call]] - Дзвінки
* [[API_chapter_UK|chapter]] - Власні розділи/сторінки/посилання
* [[API_commutation_UK|commutation]] - Комутація об'єктів
* [[API_cross_UK|cross]] - Кроси/ODF
* [[API_customer_UK|customer]] - Абоненти. Більшість дій актуальна для [[Підтримувані білінги_UK|ручних білінгів]]
* [[API_cwdm_UK|cwdm]] - CWDM
* [[API_device_UK|device]] - Обладнання
* [[API_employee_UK|employee]] - Співробітники ''(з 3.16dev2)''
* [[API_fiber_UK|fiber]] - Кабельні лінії
* [[API_gps_UK|gps]] - GPS-трекери
* [[API_inventory_UK|inventory]] - Склад
* [[API_key_UK|key]] - Ключі
* [[API_map_UK|map]] - Карти покриття
* [[API_module_UK|module]] - Зовнішні запити від модулів
* [[API_newin_UK|newin]] - Заявка на підключення ''(до 3.18)''
* [[API_node_UK|node]] - Об'єкти інфраструктури ''(вузли зв'язку, муфти, опори, колодязі)''
* [[API_notepad_UK|notepad]] - Блокнот
* [[API_operator_UK|operator]] - Оператори системи ''(до 3.16dev2)''
* [[API_owner_UK|owner]] - Власники об'єктів
* [[API_redirect_UK|redirect]] - Переадресація на карткв об'єкта за певною ознакою
* [[API_service_UK|service]] - Додаткові послуги
* [[API_setting_UK|setting]] - Налаштування
* [[API_sms_UK|sms]] - SMS-повідомлення
* [[API_splitter_UK|splitter]] - Сплітери
* [[API_staff_UK|staff]] - Співробітники ''(до 3.16dev2)''
* [[API_system_UK|system]] - Системна інформація та операції
* [[API_tariff_UK|tariff]] - Тарифи
* [[API_task_UK|task]] - Завдання
* [[API_trader_UK|trader]] - Постачальники
* [[API_vehicle_UK|vehicle]] - Автотранспорт
* [[API_vlan_UK|vlan]] - VLAN