Введение

Все запросы по API осуществляется по адресу https://userID.aircrm.io/api. Создать токен вы можете в личном кабинете.

Все запросы должны быть выполнены как JSON с заголовком application/json

Аутентификация

Укажите свой токен API как часть заголовка Authorization: Bearer {token}.

Каждый пользователь, у которого разрешен доступ к API, сможет создать токен.

HTTP-методы

Метод Описание
GET Для получения
POST Для создания
PUT Для обновления
DELETE Для удаления

Пагинация

Запросы, которые возвращают несколько элементов, по умолчанию разбиты на страницы (по 15 записей). Вы можете указать доп. страницы с параметром ?page. Для некоторых разделов вы также можете установить вывод кол-ва записей с помощью параметра ?per_page.

Обратите внимание, что не все разделы точки поддерживают параметр ?per_page

Ограничения

Мы ограничиваем количество запросов, которые вы можете сделать в течение определенного периода времени. Сейчас можно сделать 60 запросов в минуту.

При превышении лимита скорости возвращается ответ об ошибке со статусом 429 Too Many Requests.

Поля

При сохранении полей вам нужно учитывать ID этого поля (который указывается при создании поля).

Название Тип значения Пример
Булевное boolean [ ...payload, "field_id" => true ]
Флажок array [ ...payload, "field_id" => [5] // id вариантов ]
Дата date [ ...payload, "field_id" => "2022-06-07" ]
Дата и Время date [ ...payload, "field_id" => "2022-06-07 06:00:00" ]
Email string [ ...payload, 'field_id' => "[email protected]" ]
Мультисписок array [ ...payload, "field_id" => [5] // id вариантов ]
Число integer [ ...payload, "field_id" => 300 ]
Числовой decimal(15, 3) [ ...payload, "field_id" => 1150.530 ]

[ ...payload, "field_id" => 1500 ]
Флажок integer [ ...payload, "field_id" => 5 // id варианта ]
Список integer [ ...payload, "field_id" => 10 // id варианта ]
Текстовое поле string [ ...payload, "field_id" => "Пример текста" ]
Большое текстовое поле string [ ...payload, "field_id" => "Пример текста" ]
Часовой пояс string [ ...payload, "field_id" => "Russia/Moscow" ]