Документация
API
Формат запросов, ответов и справочник полей для интеграций.
Ресурсы
Поля формы ресурсов описывают места и оборудование организации. Список и получение одной карточки возвращают одинаковый набор стандартных полей; кастомные поля приходят в customFields.
URL ресурсов
Для ресурсов используется общий API данных с именем раздела resources.
| Метод | URL | Описание |
|---|---|---|
GET | /api/?mod=data&data=resources | Получить список ресурсов текущей организации. |
GET | /api/?mod=data&data=resources&id=ID | Получить одну карточку ресурса по id. |
POST | /api/?mod=save_data&data=resources | Создать новый ресурс или сохранить существующий. Для обновления передайте id в теле запроса. |
POST | /api/?mod=delete_data&data=resources&id=ID | Удалить ресурс по id. |
| Поле | Тип | Обязательное | Default | Значения | Сохранение | Список | Карточка | Описание |
|---|---|---|---|---|---|---|---|---|
name | string | Да | Нет | Любое | Название ресурса, которое видят пользователи кабинета при настройке услуг и календаря. | |||
id | number | Нет | Нет | Любое | Идентификатор существующего ресурса. При создании не передается. | |||
sort_order | number | Нет | auto | Любое | Позиция ресурса в сортировке списка. Заполняется сервером. | |||
type | select | Нет | place | placeequipment | Тип ресурса: место или оборудование. | |||
quantity | number | Нет | 1 | Любое | Количество одинаковых единиц ресурса. | |||
customFields | object | Нет | Нет | Любое | Значения кастомных полей по uid. Для сохранения используйте поле custom_fields в теле запроса. |
Ответы с ошибками
Если запрос не выполнен, API возвращает ok=false и числовой code. Подробности по полям передаются в errors[].type.
| Код | Когда возникает | Ответ |
|---|---|---|
16 | Не передано обязательное name, либо обязательные кастомные поля ресурсов. | required со списком незаполненных полей. |
17 | Поля ресурса переданы, но не прошли проверку типа или количества. | errors со списком ошибок полей. |
11-14 | Нет доступа к ресурсу, созданию, сохранению, удалению или превышен лимит тарифа. | message с причиной отказа. |
| Тип ошибки | Поле | Когда возникает |
|---|---|---|
select_error | type | Значение не входит в разрешенный список. |
number_error | quantity | Количество должно быть положительным целым числом. |