API предварительной записи

API-проводник

Отправляйте запросы к API прямо из документации: получите услуги, посмотрите свободные слоты, создайте тестовую бронь и проверьте чтение, отмену или перенос. Запросы идут в песочницу через публичный тестовый ключ и не попадают в живую очередь.

/api/queue/booking sandbox v1
Это безопасно для рабочей системы. Публичный тестовый ключ создаёт только брони с is_test=true: они не появляются на табло, в живой очереди, отчётах и дашборде. Тестовые записи автоматически удаляются через сутки.
sandbox
Проверка API в песочнице Запросы уходят на /api/queue/booking текущего сервера

Нажмите «Загрузить услуги», чтобы получить доступные ID.
Для создания брони можно нажать «Подобрать слот».
Код возвращается при создании брони.
Повтор с тем же ключом не создаст вторую бронь.
Ответ —
Здесь появится ответ API…
Запрос Можно скопировать кнопкой справа
…

Как это работает

  1. Получите услуги Нажмите «Загрузить услуги» — проводник подставит доступные ID в подсказки. Если услуги не загрузились, проверьте, включена ли предварительная запись в админке.
  2. Выберите метод Для слотов и создания брони нужны ID услуги, дата и время. Для чтения, отмены и переноса — booking_ref, который вернул метод создания.
  3. Отправьте запрос Слева формируется запрос с заголовками и телом, справа появляется статус, время ответа, X-Request-Id и JSON. Код запроса можно скопировать.
  4. Проверьте сценарий целиком Создайте бронь, прочитайте её по booking_ref, перенесите на другое время и отмените. Все действия остаются в песочнице.

Пример ответа

После создания тестовой брони справа появится статус 201 Created, время выполнения, X-Request-Id и JSON. Ключ booking_ref из ответа можно сразу вставить в поле «booking_ref» и прочитать, перенести или отменить эту запись.

{
  "booking_ref": "hXk2m9Qb1sA7cD4e",
  "number": "T-014",
  "status": "booked",
  "scheduled_at": "2026-12-01T11:30:00.000Z",
  "scheduled_at_local": "2026-12-01 14:30",
  "timezone": "Europe/Moscow",
  "service": { "id": 3, "name": "Приём документов", "prefix": "П" },
  "is_test": true,
  "callable": false,
  "created_at": "2026-11-20T12:00:00.000Z"
}

Префикс T- и поле is_test: true говорят, что это песочница. У запроса с тем же Idempotency-Key ответ будет 201 с заголовком Idempotent-Replayed, но вторая бронь не создастся. Если в ответе ошибка, формат всегда один: {"error": "пояснение", "code": "код_ошибки"}.

Безопасность и ограничения

Публичный sandbox-ключ. Он предназначен только для проверки API и создания тестовых броней. Для боевой интеграции выпустите live-ключ в админке → API-ключи и используйте его только на сервере, а не в браузере.
Лимиты. Не более 60 запросов в минуту на ключ и IP. Если предварительная запись выключена администратором, API отвечает 503 booking_disabled; если тестовый ключ запрещён — 403 test_disabled.

Что дальше

API версии v1 (путь /api/queue/booking). Документация обновляется вместе с релизом модуля booking.