Документация
API
Формат запросов, ответов и справочник полей для интеграций.
Кастомные поля
Справочник описывает настройки кастомных полей, которые затем приходят в custom_fields при получении данных форм.
URL кастомных полей
Для кастомных полей используется общий API данных с именем раздела custom_fields.
| Метод | URL | Описание |
|---|---|---|
GET | /api/?mod=data&data=custom_fields | Получить список доступных кастомных полей. |
GET | /api/?mod=data&data=custom_fields&id=ID | Получить одно кастомное поле по id. |
POST | /api/?mod=save_data&data=custom_fields | Создать новое кастомное поле или сохранить существующее. Для обновления передайте id в теле запроса. |
POST | /api/?mod=delete_data&data=custom_fields&id=ID | Удалить кастомное поле по id. |
| Поле | Тип | Обязательное | Default | Значения | Сохранение | Список | Карточка | Описание |
|---|---|---|---|---|---|---|---|---|
target | select | Да | Нет | organizationsstaffresourcesserviceseventsclientsbookings | Раздел данных, к которому относится поле. | |||
name | string | Да | Нет | Любое | Название поля, которое видят пользователи кабинета. | |||
type | select | Да | Нет | texttextarearadiocheckboxesselectdatetimedatetimeintegerdecimaltagsboolean | Тип значения кастомного поля. | |||
id | number | Нет | Нет | Любое | Идентификатор существующего кастомного поля. При создании не передается. | |||
uid | string | Нет | auto | Любое | Идентификатор поля для передачи значений в custom_fields. Генерируется сервером. | |||
sort_order | number | Нет | auto | Любое | Позиция кастомного поля в сортировке списка. Заполняется сервером. | |||
list | array | Нет | Нет | Любое | Для select, radio и checkboxes передается массив строк. Пример: ["Да", "Нет"]. Для остальных типов можно не передавать. | |||
required | boolean | Нет | false | falsetrue | Обязательность заполнения поля. | |||
show_in_card | boolean | Нет | false | falsetrue | Показывать поле в списке карточек раздела. | |||
show_to_clients | boolean | Нет | false | falsetrue | Показывать поле клиентам в публичных сценариях. |
Ответы с ошибками
Если запрос не выполнен, API возвращает ok=false и числовой code. Подробности по полям передаются в errors[].type.
| Код | Когда возникает | Ответ |
|---|---|---|
16 | Не переданы обязательные target, name или type. | required со списком незаполненных полей. |
17 | Поля кастомного поля переданы, но не прошли проверку списка значений или допустимых вариантов. | errors со списком ошибок полей. |
11-14 | Нет доступа к кастомному полю, созданию, сохранению, удалению или превышен лимит тарифа. | message с причиной отказа. |
| Тип ошибки | Поле | Когда возникает |
|---|---|---|
select_error | target, type | Значение не входит в разрешенный список. |
list_error | list | Для типов с выбором нужен список доступных вариантов. |