API UK

en | uk | 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

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

Налаштуйте API-ключ.

Категорії

• address - Адреси
• attach - Прикріплені файли
• additional_data - Додаткові поля/дані для об'єктів
• advertising - Рекламні кампанії
• billing - Білінги
• cable_route - Кабельні траси і канали
• call - Дзвінки
• chapter - Власні розділи/сторінки/посилання
• commutation - Комутація об'єктів
• cross - Кроси/ODF
• customer - Абоненти. Більшість дій актуальна для ручних білінгів
• cwdm - CWDM
• device - Обладнання
• employee - Співробітники (з 3.16dev2)
• fiber - Кабельні лінії
• gps - GPS-трекери
• inventory - Склад
• key - Ключі
• map - Карти покриття
• module - Зовнішні запити від модулів
• newin - Заявка на підключення (до 3.18)
• node - Об'єкти інфраструктури (вузли зв'язку, муфти, опори, колодязі)
• notepad - Блокнот
• operator - Оператори системи (до 3.16dev2)
• owner - Власники об'єктів
• redirect - Переадресація на картку об'єкта за певною ознакою
• service - Додаткові послуги
• setting - Налаштування
• sms - SMS-повідомлення
• splitter - Сплітери
• staff - Співробітники (до 3.16dev2)
• system - Системна інформація та операції
• tariff - Тарифи
• task - Завдання
• trader - Постачальники
• vehicle - Автотранспорт
• vlan - VLAN