API

Этот раздел описывает возможности использования встроенного API в ERP "UserSide", что позволяет использовать встроенный функционал в собственных проектах.

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

Принцип работы

За взаимодействие отвечает файл /api.php

Можно использовать и GET и POST запросы.

Входящие параметры:
Обязательные:
 key - ключ API
 cat - категория запроса
Необязательные:
 skip_internal_api - флаг - не включать внутренние триггеры системы (разумно использовать, когда ваш метод API и есть реакция на какой-то триггер и в итоге при обычной работе он же сам и зацикливает свою работу)
Прочие дополнительные параметры, в зависимости от категории (см. ниже в соответствующих категориях). Например:
 customer_id - id абонента
 is_potential - флаг. Может принимать значение 1 или 0. Большинство флагов имеют префикс is.

Пример запроса:
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 - Звонки
• commutation - Коммутация объектов
• cross - ODF/Кроссы
• customer - Абоненты. Большинство действий актуально для ручных биллингов
• device - Оборудование
• employee - Сотрудники (с 3.16dev2)
• fiber - Кабельные линии
• gps - GPS-трекеры
• inventory - Склад
• key - Ключи
• map - Карты покрытия
• module - Внешние запросы от модулей
• newin - Заявка на подключение
• node - Сооружения связи (узлы связи, муфты, опоры, колодцы)
• notepad - Блокнот
• operator - Операторы системы (до 3.16dev2)
• owner - Собственники объектов
• redirect - Переадресация на карточку объекта по какому-то признаку
• service - Дополнительные услуги
• setting - Настройка
• sms - SMS-сообщения
• splitter - Делители/уплотнители
• staff - Сотрудники (до 3.16dev2)
• system - Системная информация и операции
• tariff - Тарифы
• task - Задания
• trader - Поставщики
• vehicle - Автотранспорт
• vlan - Vlan