API: различия между версиями
Admin (обсуждение | вклад) Нет описания правки |
Admin (обсуждение | вклад) Нет описания правки |
||
Строка 25: | Строка 25: | ||
В основном файле конфигурации ''main/config/config.php'' добавьте ''(или настройте)'' переменную $zapikey, где укажите свой произвольный API-ключ. | В основном файле конфигурации ''main/config/config.php'' добавьте ''(или настройте)'' переменную $zapikey, где укажите свой произвольный API-ключ. | ||
---- | |||
== Категории == | |||
---- |
Версия от 17:57, 27 марта 2015
Этот раздел описывает возможности использования встроенного API в САП "UserSide", что позволяет использовать встроенный функционал в собственных проектах.
API охватывает на данный момент не весь функционал и постепенно дорабатывается, так что данная страница будет иметь частые изменения и дополнения.
Принцип работы
За взаимодействие отвечает файл /api.php
Входящие параметры: Обязательные: api - ключ API kat - категория запроса Возможные: cp - кодировка (возможное значение: cp1251). По-умолчанию данные возвращаются в кодировке utf8. gz - возврат данных в сжатом формате (возможное значение: disable). По-умолчанию данные возвращаются в сжатом формате. subkat - подкатегория запроса sort_desc - обратная сортировка результата запроса (Возможное значение: 1) Прочие параметры, в зависимости от категории. Например: usercode - код абонента (tbl_base.CODE) Пример запроса: api.php?api=key&kat=abon&subkat=msg&usercode=1
Основная настройка
В основном файле конфигурации main/config/config.php добавьте (или настройте) переменную $zapikey, где укажите свой произвольный API-ключ.