API

Материал из WiKi - UserSide
Перейти к: навигация, поиск

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

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

ВАЖНО: В данном разделе может быть указан функционал, которого в Вашей системе нет. Этот функционал всегда доступен в тестовых хотфиксах для последней версии.

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

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

Входящие параметры:
Обязательные:
 key - ключ API
 cat - категория запроса
Возможные:
 cp - кодировка (возможное значение: cp1251). По-умолчанию данные возвращаются в кодировке utf8.
 gz - возврат данных в сжатом формате (возможное значение: disable). По-умолчанию данные возвращаются в сжатом формате.
 subcat - подкатегория запроса
 sort_desc - обратная сортировка результата запроса (Возможное значение: 1)
 Прочие дополнительные параметры, в зависимости от категории (см. ниже в соответствующих категориях). Например:
  usercode - код абонента (tbl_base.CODE)

Пример запроса:
api.php?key=apikey&cat=abon&subcat=msg&usercode=1
Возвращаемые данные:
 Если запрос предполагает какое-то действие или возврат информации, то в формате JSON будет возвращена информация:
  array(
   [Result] => OK / ERROR
   [ErrorText] => В случае ошибки - текст ошибки
  )

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

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

Категории

  • address - Адреса
  • attach - Прикрепляемые файлы
  • additional_data - Дополнительные поля/данные для объектов
  • commutation - Коммутация объектов
  • customer - Абоненты. Большинство действий актуально для ручных биллингов
  • device - Оборудование
  • fiber - ВОЛС
  • inventory - Склад
  • module - Внешние запросы от модулей
  • newin - Заявка на подключение
  • node - Объекты инфраструктуры (узлы связи, муфты, опоры, колодцы)
  • operator - Операторы системы
  • redirect - Переадресация на карточку объекта по какому-то признаку
  • setting - Настройка
  • sms - SMS-сообщения
  • staff - Сотрудники
  • tariff - Тарифы
  • task - Задания