компаний уже выбрали Клиентскую базу!
Узнайте, почему.
ClientBase API
Альфа
РазработчикуАльфа
Общая информация
- API работает по протоколу HTTPS или HTTP.
- Подерживается с версии 2.0.7 и только с php 5.4 и выше.
- Все данные доступны только в формате JSON.
Активация
Для активации API необходимо перейти во вкладку «Пользователи» CRM системы и поставить галочку «Включить API» у определенного пользователя. Вам будет предоставлен «API AuthKey» (ключ API) с правами доступа выбранного пользователя. Имея ключ, вы можете начать генерировать запросы API согласно документации.
Важно: Для работы API необходимо, чтобы был включен модуль Apache mod_rewrite.
Точка входа
POST {site}/api/{module}/{method}/
Все команды, посылаемые на сервер, отправляются методом POST, в методе POST передается JSON структура с параметрами.
Обязательные параметры
- v – версия используемого API при аутентификации.
- access_Id – идентификатор текущей сессии после аутентификации.
Модули и методы
- auth – Аутентификация
- data – Работа с данными в таблицах
- group – Работа с группами
- table – Работа с таблицами
- user – Работа с пользователями
- 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 – Булев тип
Примечание: имена переменных, используемых в методах, пишутся маленькими буквами.
Примеры
Создайте собственный аккаунт прямо сейчас! Бесплатно! Начать бесплатно
