Авторизация
Учётная запись Hallify не требуется. Соблюдайте предварительные условия и ограничения этого метода.
Руководство по подключениюПараметры
publicHandleПуть · ОбязательноНепрозрачный публичный идентификатор канала для поиска опубликованной гостевой конфигурации одного заведения. Не является ключом доступа.
stringПолное определение
{ "type": "string", "example": "example" }idempotency-keyЗаголовок · ОбязательноОбязательный ключ идемпотентности длиной до 128 символов.
stringПолное определение
{ "type": "string", "minLength": 1, "maxLength": 128, "example": "example" }originЗаголовок · ОбязательноOrigin браузера проверяется по разрешённым источникам публичного канала. Отсутствующий или запрещённый Origin отклоняется без раскрытия закрытой конфигурации заведения.
stringПолное определение
{ "type": "string", "example": "example" }
Тело запроса
Обязательно
Создаёт кратковременное удержание вместимости и отправляет подтверждение контакта по правилам публичного канала. Для фиксации бронирования нужно подтвердить намерение. Начальный запрос публичный; преобразование намерения защищено кодом контакта.
application/json
Полное определение
{
"$ref": "#/components/schemas/PublicIntentDto"
}Ответы
201Возвращает намерение для подтверждения, срок удержания и состояние доставки с маскированными контактными данными.
Полное определение
{
"$ref": "#/components/schemas/ReservationPublicIntentDto"
}{
"intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
"verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
"expiresAt": "2026-12-31T18:00:00.000Z"
}409Ключ идемпотентности уже обрабатывается или повторно использован с другим телом.
Полное определение
{
"$ref": "#/components/schemas/IdempotencyConflictError"
}{
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
}Схемы
PublicIntentDto
Публичное намерение подтверждения бронирования. Контакт используется только в собственном процессе проверки и не является токеном доступа.
servicePeriodIdОбязательноUUID Hallify для
servicePeriodId.string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "UUID Hallify для `servicePeriodId`.", "example": "4846c409-f4df-40f6-81cc-1d7157a5c646" }scheduledAtОбязательноВремя
scheduledAtв формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.string · date-timeПолное определение
{ "type": "string", "format": "date-time", "description": "Время `scheduledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.", "example": "2026-01-15T12:00:00.000Z" }partySizeОбязательноЦелочисленное значение
partySize. Ограничения: минимум 1; максимум 99.integerПолное определение
{ "type": "integer", "minimum": 1, "maximum": 99, "description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 99.", "example": 1 }contactTypeОбязательноДопустимые значения
contactType: EMAIL, PHONE.stringПолное определение
{ "type": "string", "enum": [ "EMAIL", "PHONE" ], "description": "Допустимые значения `contactType`: EMAIL, PHONE.", "example": "EMAIL" }contactОбязательноКонтакт
contact. Ограничения: минимальная длина 3; максимальная длина 254.stringПолное определение
{ "type": "string", "minLength": 3, "maxLength": 254, "description": "Контакт `contact`. Ограничения: минимальная длина 3; максимальная длина 254.", "example": "example" }displayNameОбязательноПонятное человеку значение
displayName. Ограничения: максимальная длина 120.stringПолное определение
{ "type": "string", "maxLength": 120, "description": "Понятное человеку значение `displayName`. Ограничения: максимальная длина 120.", "example": "Example name" }termsVersionОбязательноВерсия условий
termsVersion. Ограничения: максимальная длина 64.stringПолное определение
{ "type": "string", "maxLength": 64, "description": "Версия условий `termsVersion`. Ограничения: максимальная длина 64.", "example": "example" }privacyVersionОбязательноВерсия уведомления о персональных данных
privacyVersion. Ограничения: максимальная длина 64.stringПолное определение
{ "type": "string", "maxLength": 64, "description": "Версия уведомления о персональных данных `privacyVersion`. Ограничения: максимальная длина 64.", "example": "example" }guestRequestНеобязательноПожелание гостя
guestRequest. Ограничения: максимальная длина 2000.stringПолное определение
{ "type": "string", "maxLength": 2000, "description": "Пожелание гостя `guestRequest`. Ограничения: максимальная длина 2000.", "example": "example" }
Полное определение
{
"type": "object",
"properties": {
"servicePeriodId": {
"type": "string",
"format": "uuid",
"description": "UUID Hallify для `servicePeriodId`.",
"example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
},
"scheduledAt": {
"type": "string",
"format": "date-time",
"description": "Время `scheduledAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
"example": "2026-01-15T12:00:00.000Z"
},
"partySize": {
"type": "integer",
"minimum": 1,
"maximum": 99,
"description": "Целочисленное значение `partySize`. Ограничения: минимум 1; максимум 99.",
"example": 1
},
"contactType": {
"type": "string",
"enum": [
"EMAIL",
"PHONE"
],
"description": "Допустимые значения `contactType`: EMAIL, PHONE.",
"example": "EMAIL"
},
"contact": {
"type": "string",
"minLength": 3,
"maxLength": 254,
"description": "Контакт `contact`. Ограничения: минимальная длина 3; максимальная длина 254.",
"example": "example"
},
"displayName": {
"type": "string",
"maxLength": 120,
"description": "Понятное человеку значение `displayName`. Ограничения: максимальная длина 120.",
"example": "Example name"
},
"termsVersion": {
"type": "string",
"maxLength": 64,
"description": "Версия условий `termsVersion`. Ограничения: максимальная длина 64.",
"example": "example"
},
"privacyVersion": {
"type": "string",
"maxLength": 64,
"description": "Версия уведомления о персональных данных `privacyVersion`. Ограничения: максимальная длина 64.",
"example": "example"
},
"guestRequest": {
"type": "string",
"maxLength": 2000,
"description": "Пожелание гостя `guestRequest`. Ограничения: максимальная длина 2000.",
"example": "example"
}
},
"required": [
"servicePeriodId",
"scheduledAt",
"partySize",
"contactType",
"contact",
"displayName",
"termsVersion",
"privacyVersion"
],
"description": "Публичное намерение подтверждения бронирования. Контакт используется только в собственном процессе проверки и не является токеном доступа.",
"example": {
"servicePeriodId": "81f8e4de-50f0-42ef-baa5-7f4b0580aa16",
"scheduledAt": "2026-08-12T18:30:00.000Z",
"partySize": 2,
"contactType": "EMAIL",
"contact": "guest@example.invalid",
"displayName": "Example Guest",
"termsVersion": "2026-08",
"privacyVersion": "2026-08"
}
}ReservationPublicIntentDto
Ожидающее подтверждение гостя для намерения бронирования или листа ожидания.
intentIdОбязательноИдентификатор намерения бронирования для подтверждения и повторной отправки кода.
string · uuidПолное определение
{ "type": "string", "description": "Идентификатор намерения бронирования для подтверждения и повторной отправки кода.", "format": "uuid", "example": "fd46d9cb-163b-4669-8f68-6b8456779efd" }verificationIdОбязательноИдентификатор проверки личности гостя.
string · uuidПолное определение
{ "type": "string", "description": "Идентификатор проверки личности гостя.", "format": "uuid", "example": "904a18d4-c890-4387-8e14-bc52c879c7ff" }expiresAtОбязательноСрок действия ожидающего намерения бронирования.
string · date-timeПолное определение
{ "type": "string", "description": "Срок действия ожидающего намерения бронирования.", "format": "date-time", "example": "2026-12-31T18:00:00.000Z" }
Полное определение
{
"type": "object",
"description": "Ожидающее подтверждение гостя для намерения бронирования или листа ожидания.",
"required": [
"intentId",
"verificationId",
"expiresAt"
],
"properties": {
"intentId": {
"type": "string",
"description": "Идентификатор намерения бронирования для подтверждения и повторной отправки кода.",
"format": "uuid",
"example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
},
"verificationId": {
"type": "string",
"description": "Идентификатор проверки личности гостя.",
"format": "uuid",
"example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
},
"expiresAt": {
"type": "string",
"description": "Срок действия ожидающего намерения бронирования.",
"format": "date-time",
"example": "2026-12-31T18:00:00.000Z"
}
},
"example": {
"intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
"verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
"expiresAt": "2026-12-31T18:00:00.000Z"
}
}IdempotencyConflictError
Ключ идемпотентности уже обрабатывается или использован повторно с другим телом.
Полное определение
{
"example": {
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
},
"allOf": [
{
"$ref": "#/components/schemas/TranslatedErrorDto"
},
{
"type": "object",
"required": [
"code"
],
"properties": {
"statusCode": {
"type": "integer",
"enum": [
409
],
"description": "Статус конфликта HTTP 409.",
"example": 409
},
"code": {
"type": "string",
"enum": [
"IDEMPOTENCY_REQUEST_NOT_READY",
"IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
"IDEMPOTENCY_REQUEST_IN_PROGRESS",
"IDEMPOTENCY_SCOPE_INCOMPLETE"
],
"description": "Допустимые значения `code`: IDEMPOTENCY_REQUEST_NOT_READY, IDEMPOTENCY_KEY_PAYLOAD_MISMATCH, IDEMPOTENCY_REQUEST_IN_PROGRESS, IDEMPOTENCY_SCOPE_INCOMPLETE.",
"example": "IDEMPOTENCY_REQUEST_NOT_READY"
}
},
"example": {
"code": "IDEMPOTENCY_REQUEST_NOT_READY"
}
}
],
"description": "Ключ идемпотентности уже обрабатывается или использован повторно с другим телом."
}TranslatedErrorDto
Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.
statusCodeОбязательноHTTP-статус, повторённый из ответа.
integerПолное определение
{ "type": "integer", "description": "HTTP-статус, повторённый из ответа.", "example": 400 }errorОбязательноКлюч перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.
stringПолное определение
{ "type": "string", "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.", "example": "errors.request.invalid" }codeОбязательноСтабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями.
stringПолное определение
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями." }messageОбязательноКлюч перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе.
stringПолное определение
{ "type": "string", "example": "errors:http.badRequest", "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе." }translationKeyОбязательноКанонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте.
stringПолное определение
{ "type": "string", "example": "errors:http.badRequest", "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте." }translationValuesНеобязательноНеобязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.
objectПолное определение
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.", "example": { "exampleKey": "example" } }validationErrorsНеобязательноОшибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.
arrayПолное определение
{ "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }detailsНеобязательноНеобязательные сведения о доменных препятствиях или ошибках валидации.
oneOfПолное определение
{ "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }
Полное определение
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-статус, повторённый из ответа.",
"example": 400
},
"error": {
"type": "string",
"description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
"example": "errors.request.invalid"
},
"code": {
"type": "string",
"example": "HTTP_BAD_REQUEST",
"description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
},
"message": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
},
"translationKey": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
"example": {
"exampleKey": "example"
}
},
"validationErrors": {
"description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorDto"
},
"example": [
{
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
]
},
"details": {
"description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"example": [
"example"
]
}
},
"required": [
"statusCode",
"error",
"code",
"message",
"translationKey"
],
"description": "Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.",
"example": {
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}
}ValidationErrorDto
Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.
fieldОбязательноПубличный путь поля. Вложенные свойства и индексы массива разделены точками.
stringПолное определение
{ "type": "string", "example": "email", "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками." }translationKeyОбязательноКлюч перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers.
stringПолное определение
{ "type": "string", "example": "validation:isEmail", "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers." }codeОбязательноСтабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы.
stringПолное определение
{ "type": "string", "example": "isEmail", "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы." }messageОбязательноКлюч перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются.
stringПолное определение
{ "type": "string", "example": "validation:isEmail", "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются." }translationValuesНеобязательноНеобязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.
objectПолное определение
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.", "example": { "exampleKey": "example" } }
Полное определение
{
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "email",
"description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
},
"translationKey": {
"type": "string",
"example": "validation:isEmail",
"description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
},
"code": {
"type": "string",
"example": "isEmail",
"description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
},
"message": {
"type": "string",
"example": "validation:isEmail",
"description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
"example": {
"exampleKey": "example"
}
}
},
"required": [
"field",
"translationKey",
"code",
"message"
],
"description": "Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.",
"example": {
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
}JsonValue
Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.
Полное определение
{
"oneOf": [
{
"type": "string",
"nullable": true,
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"description": "Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.",
"example": "example"
}