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