Документация

API

Формат запросов, ответов и справочник полей для интеграций.

ФорматОрганизацииПерсоналРесурсыГруппы услугУслугиКлиентыСобытияЗаписиКастомные поляФинансы

Организации

Поля формы организации используются при создании и сохранении организации через API кабинета. Список и получение одной организации возвращают разный набор полей: это отмечено в таблице.

URL организаций

Для организаций используется общий API данных с именем раздела organizations.

МетодURLОписание
GET/api/?mod=data&data=organizationsПолучить список организаций текущего пользователя.
GET/api/?mod=data&data=organizations&id=IDПолучить одну организацию по id.
POST/api/?mod=save_data&data=organizationsСоздать новую организацию или сохранить существующую. Для обновления передайте id в теле запроса.
ПолеТипОбязательноеDefaultЗначенияСохранениеСписокКарточкаОписание
public_namestringДаНетЛюбоеНазвание, которое видят клиенты и пользователи кабинета.
typeselectДаНетservice_studiomedicaleducationsportotherКатегория деятельности организации.
idnumberНетНетЛюбоеИдентификатор существующей организации. При создании не передается.
uidstringНетautoЛюбоеПубличный технический идентификатор, генерируется сервером.
uristringНетНетЛюбоеЧеловекочитаемый адрес публичной страницы организации.
descriptionstringНетНетЛюбоеКраткое описание для публичных сценариев и виджета.
phonestringНетНетЛюбоеРабочий телефон организации.
emailstringНетНетЛюбоеРабочий email организации.
websitestringНетНетЛюбоеСайт организации.
addressstringНетНетЛюбоеАдрес точки обслуживания или офиса.
address_datajsonНетНетЛюбоеСтруктурные данные адреса: строка адреса, координаты и подсказка как добраться.
timezonetimezoneНетEurope/MoscowIANA-таймзона организации.
languageselectНетruruenОсновной язык организации.
currencyselectНетRUBRUBUSDEURВалюта по умолчанию для услуг.
day_starttimeНет10:00:00ЛюбоеНачало рабочего дня в формате HH:mm или HH:mm:ss.
day_endtimeНет18:00:00ЛюбоеОкончание рабочего дня, должно быть позже начала.
use_ru_production_calendarbooleanНетfalsefalsetrueУчитывать российский производственный календарь.
slot_stepnumberНет60ЛюбоеМинимальный шаг записи в минутах.
min_lead_timenumberНет1440ЛюбоеМинимальное время до записи в минутах.
booking_horizon_daysnumberНет5ЛюбоеГоризонт записи в днях, целое число от 1 до 365.
client_confirmation_enabledbooleanНетfalsefalsetrueЗапрашивать у клиента подтверждение записи.
client_confirmation_lead_timenumberНет180ЛюбоеИнтервал в минутах внутри ежедневных часов day_start–day_end. Ночные часы пропускаются, дни недели и производственный календарь не учитываются.
allow_client_cancelbooleanНетtruefalsetrueРазрешить клиенту самостоятельную отмену записи.
collect_feedbackbooleanНетtruefalsetrueПредлагать клиенту оценить состоявшийся визит. Настройка включена по умолчанию и проверяется при выполнении действия complete.

Ответы с ошибками

Если запрос не выполнен, API возвращает ok=false и числовой code. Подробности по полям передаются в errors[].type.

КодКогда возникаетОтвет
16Не переданы обязательные public_name или type, либо обязательные кастомные поля организации.required со списком незаполненных полей.
17Поля организации переданы, но не прошли проверку типа, списка значений, времени, числа или тарифа.errors со списком ошибок полей.
11-14Нет доступа к организации, созданию, сохранению или превышен лимит тарифа.message с причиной отказа.
Тип ошибкиПолеКогда возникает
select_errortype, language, currencyЗначение не входит в разрешенный список.
invalid_timezonetimezoneТаймзона не входит в справочник IANA-зон.
time_errorday_start, day_endВремя не соответствует HH:mm или окончание дня не позже начала.
number_errorslot_step, min_lead_time, booking_horizon_days, client_confirmation_lead_timeОжидается положительное целое число.
tariff_erroruriСмена адреса страницы uri доступна только на тарифе Pro.