Москва
< Все способы интеграции

API

В разделе "Интеграция" в личном кабинете вы можете указать url для онлайн нотификации о событиях в вашем расписании.

Данные отправляются POST запросом в формате JSON, кодировка UTF-8, со следующими полями:

  • ClientId - уникальный номер клиента
  • ClientName - имя клиента
  • ClientPhone - телефон клиента
  • ClientEmail - электронный адрес клиента
  • CabinetName - название очереди
  • CabinetSubdomain - поддомен очереди
  • ServiceId - уникальный номер услуги, 0 - если бронь
  • ServiceName - название услуги, пусто, если бронь
  • Comment - комментарий администратора
  • BeginDateTimeLocal - время начала оказания услуги (на какое время записался клиент) в формате yyyy-MM-ddThh:mm:ss
  • DurationMinutes - общая продолжительность в минутах
  • AttributesText - дополнительные параметры в формате: "имя: значение"
  • EventType - тип события. "add" - новая запись, "remove" - запись удалена
  • CreatedOnDateTimeUTC - дата создания записи, UTC, в формате yyyy-MM-ddThh:mm:ss
  • Source - кто создал запись. "themself" - самозапись, "admin" - администратор

Пример запроса на добавление записи клиентом (самостоятельная):

{
        "ClientId" : 4313,
        "ClientName" : "Иван",
        "ClientPhone" : "79999999999",
        "ClientEmail" : "test@gmail.com",
        "TimetableId" : 2746133,
        "CabinetName" : "Название кабинета, очереди",
        "CabinetSubdomain" : "84703c",
        "ServiceName" : "Название сервиса",
        "ServiceId" : 2143,
        "Comment" : "Комментарий к записи",
        "BeginDateTimeLocal" : "2018-04-28T12:00:00",
        "CreatedOnDateTimeUtc" : "2018-04-21T09:35:48",
        "DurationMinutes" : 60,
        "EventType" : "add",
        "Source" : "themself"
}


Пример запроса для нового бронирования времени:
{
        "ClientId" : 0,
        "TimetableId" : 2746132,
        "CabinetName" : "Название кабинета, очереди",
        "CabinetSubdomain" : "84703c",
        "ServiceId" : 0,
        "Comment" : "Комментарий к брони",
        "BeginDateTimeLocal" : "2018-04-27T11:00:00",
        "CreatedOnDateTimeUtc" : "2018-04-21T09:22:02",
        "DurationMinutes" : 60,
        "EventType" : "add",
        "Source" : "admin"
}

Для предваретильной отладки можно воспользоваться сервисом https://beeceptor.com
Рекомендуется использование ssl.

API расширяется по заявкам от пользователей.