API: различия между версиями

Версия от 10:47, 22 февраля 2021

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

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

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

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

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

Входящие параметры:
Обязательные:
 key - ключ API
 cat - категория запроса
Прочие дополнительные параметры, в зависимости от категории (см. ниже в соответствующих категориях). Например:
 usercode - 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

Основная настройка

В основном файле конфигурации [USERSIDE_DIRECTORY]/userside3/main/config/config.php добавьте (или настройте) переменную $zapikey, где укажите свой произвольный API-ключ.

Категории

address - Адреса
attach - Прикрепляемые файлы
additional_data - Дополнительные поля/данные для объектов
advertising - Рекламные кампании
billing - Биллинги
cable_route - Кабельные трассы и каналы
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)
tariff - Тарифы
task - Задания
vehicle - Автотранспорт

@@ Строка 44: / Строка 44: @@
 * [[API customer|customer]] - Абоненты. Большинство действий актуально для [[Поддерживаемые биллинги|ручных биллингов]]
 * [[API device|device]] - Оборудование
+* [[API employee|employee]] - Сотрудники ''(с 3.16dev2)''
 * [[API fiber|fiber]] - Кабельные линии
 * [[API gps|gps]] - GPS трекеры
@@ Строка 53: / Строка 54: @@
 * [[API node|node]] - Объекты инфраструктуры ''(узлы связи, муфты, опоры, колодцы)''
 * [[API notepad|notepad]] - Блокнот
-* [[API operator|operator]] - Операторы системы
+* [[API operator|operator]] - Операторы системы ''(до 3.16dev2)''
 * [[API owner|owner]] - Собственники объектов
 * [[API redirect|redirect]] - Переадресация на карточку объекта по какому-то признаку
@@ Строка 60: / Строка 61: @@
 * [[API sms|sms]] - SMS-сообщения
 * [[API splitter|splitter]] - Делители/уплотнители
-* [[API staff|staff]] - Сотрудники
+* [[API staff|staff]] - Сотрудники ''(до 3.16dev2)''
 * [[API tariff|tariff]] - Тарифы
 * [[API task|task]] - Задания
 * [[API vehicle|vehicle]] - Автотранспорт