ClientBase API

Разработчику^Альфа

Общая информация

• API работает по протоколу HTTPS или HTTP.
• Подерживается с версии 2.0.7 и только с php 5.4 и выше.
• Все данные доступны только в формате JSON.

Активация

Для активации API необходимо перейти в "Настройки" - "Модули" - API и выбрать пользователей, через которых данные будут выводится и добавляться в коде API. Вам будет предоставлен «API AuthKey» (ключ API) с правами доступа выбранного пользователя. Имея ключ, вы можете начать генерировать запросы API согласно документации.

Важно: Для работы API необходимо, чтобы был включен модуль Apache mod_rewrite.

Точка входа

POST         {site}/api/{module}/{method}/

Все команды, посылаемые на сервер, отправляются методом POST, в методе POST передается JSON структура с параметрами.

Обязательные параметры

• v – версия используемого API при аутентификации.
• access_Id – идентификатор текущей сессии после аутентификации.

Модули и методы

• auth – Аутентификация
  • request - Запрос на аутентификацию
  • auth - Аутентификация пользователя
• data – Работа с данными в таблицах
  • create - Создание записи в таблице
  • read - Получение записей из таблицы
  • update - Обновление записей в таблице
  • delete - Удаление записей в таблице
• group – Работа с группами
  • get_list - Получение списка групп доступа
• table – Работа с таблицами
  • get_list - Получение списка доступных таблиц
  • get_perms - Получение списка параметров доступа таблицы
  • info - Получение информации о таблице
• user – Работа с пользователями
  • get_list - Получение списка пользователей
• files – Работа с файлами
  • files - Получение файлов из таблицы

Список типов полей данных

• integer – Целое число
• number – Число с плавающей запятой
• date – Дата в формате: «%Y-%m-%d %H:%i:%s» 
      где:
  
  • %Y – Year, numeric, four digits
  • %m – Month, numeric (00-12)
  • %d – Day of month, numeric (00-31)
  • %H – Hour (00-23)
  • %i – Minutes, numeric (00-59)
  • %s – Seconds (00-59)
• text – Строка символов произвольной длины
• boolean – Булев тип

 

Примечание: имена переменных, используемых в методах, пишутся маленькими буквами.

Примеры

api_test.zip

primer.zip

primer_files.zip