Авторизация
Персональный доступ передаётся в body: reservation-verification-code.
Руководство по подключениюПараметры
publicHandleПуть · ОбязательноНепрозрачный публичный идентификатор канала для поиска опубликованной гостевой конфигурации одного заведения. Не является ключом доступа.
stringПолное определение
{ "type": "string", "example": "example" }intentIdПуть · ОбязательноUUID Hallify. До чтения или изменения ресурса проверяется его принадлежность всем родительским арендаторам и агрегатам маршрута.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }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/VerifyPublicIntentDto"
}Ответы
200Возвращает квитанцию созданного гостевого бронирования или записи листа ожидания и токен управления.
Полное определение
{
"$ref": "#/components/schemas/ReservationPublicVerifyIntentResultDto"
}{
"kind": "RESERVATION",
"entityId": "6b288694-8b6d-49cd-8007-264ca7224921",
"referenceCode": "EXAMPLE",
"revision": 1,
"status": "REQUESTED",
"eventIds": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
],
"manageToken": "synthetic-example-credential",
"manageTokenExpiresAt": "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"
}Схемы
VerifyPublicIntentDto
Проверяет код контакта и атомарно преобразует действующее намерение в бронирование или запись листа ожидания, используя удержанную вместимость.
codeОбязательноСтабильный код
codeдля классификации или идентификации.stringПолное определение
{ "type": "string", "pattern": "^\\d{6}$", "description": "Стабильный код `code` для классификации или идентификации.", "example": "000001" }
Полное определение
{
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{6}$",
"description": "Стабильный код `code` для классификации или идентификации.",
"example": "000001"
}
},
"required": [
"code"
],
"description": "Проверяет код контакта и атомарно преобразует действующее намерение в бронирование или запись листа ожидания, используя удержанную вместимость.",
"example": {
"code": "000001"
}
}ReservationPublicVerifyIntentResultDto
Результат подтверждённого бронирования или листа ожидания и гостевой токен управления.
Полное определение
{
"description": "Результат подтверждённого бронирования или листа ожидания и гостевой токен управления.",
"oneOf": [
{
"type": "object",
"description": "Результат подтверждённого намерения бронирования.",
"required": [
"kind",
"entityId",
"referenceCode",
"revision",
"status",
"eventIds",
"manageToken",
"manageTokenExpiresAt"
],
"properties": {
"kind": {
"type": "string",
"description": "Тип созданной сущности, управляемой гостем.",
"enum": [
"RESERVATION"
],
"example": "RESERVATION"
},
"entityId": {
"type": "string",
"description": "Идентификатор созданного бронирования или записи листа ожидания.",
"format": "uuid",
"example": "6b288694-8b6d-49cd-8007-264ca7224921"
},
"referenceCode": {
"type": "string",
"description": "Ссылочный код для гостя.",
"example": "EXAMPLE"
},
"revision": {
"type": "integer",
"description": "Текущая ревизия сущности.",
"example": 1
},
"status": {
"type": "string",
"description": "Итоговый статус бронирования или листа ожидания.",
"enum": [
"REQUESTED",
"BOOKED",
"CONFIRMED",
"ARRIVED",
"SEATED",
"CANCELED",
"NO_SHOW",
"DECLINED",
"EXPIRED"
],
"example": "REQUESTED"
},
"eventIds": {
"type": "array",
"description": "События, созданные этой командой.",
"items": {
"type": "string",
"description": "Идентификатор события активности бронирования.",
"format": "uuid",
"example": "6825b43e-93d6-4f3b-8171-c1661099fae8"
},
"example": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
]
},
"manageToken": {
"type": "string",
"description": "Секретный гостевой токен для последующих запросов управления. Используйте указанный в документации заголовок гостевой авторизации; никогда не записывайте токен в журналы.",
"example": "synthetic-example-credential"
},
"manageTokenExpiresAt": {
"type": "string",
"description": "Срок действия гостевого токена управления.",
"format": "date-time",
"example": "2026-12-31T18:00:00.000Z"
}
},
"example": {
"kind": "RESERVATION",
"entityId": "6b288694-8b6d-49cd-8007-264ca7224921",
"referenceCode": "EXAMPLE",
"revision": 1,
"status": "REQUESTED",
"eventIds": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
],
"manageToken": "synthetic-example-credential",
"manageTokenExpiresAt": "2026-12-31T18:00:00.000Z"
}
},
{
"type": "object",
"description": "Результат подтверждённого намерения листа ожидания.",
"required": [
"kind",
"entityId",
"referenceCode",
"revision",
"status",
"eventIds",
"manageToken",
"manageTokenExpiresAt"
],
"properties": {
"kind": {
"type": "string",
"description": "Тип созданной сущности, управляемой гостем.",
"enum": [
"WAITLIST"
],
"example": "WAITLIST"
},
"entityId": {
"type": "string",
"description": "Идентификатор созданного бронирования или записи листа ожидания.",
"format": "uuid",
"example": "6b288694-8b6d-49cd-8007-264ca7224921"
},
"referenceCode": {
"type": "string",
"description": "Ссылочный код для гостя.",
"example": "EXAMPLE"
},
"revision": {
"type": "integer",
"description": "Текущая ревизия сущности.",
"example": 1
},
"status": {
"type": "string",
"description": "Итоговый статус бронирования или листа ожидания.",
"enum": [
"WAITING",
"NOTIFIED",
"CLAIMED",
"SKIPPED",
"SEATED",
"CANCELED",
"NO_SHOW"
],
"example": "WAITING"
},
"eventIds": {
"type": "array",
"description": "События, созданные этой командой.",
"items": {
"type": "string",
"description": "Идентификатор события активности бронирования.",
"format": "uuid",
"example": "6825b43e-93d6-4f3b-8171-c1661099fae8"
},
"example": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
]
},
"manageToken": {
"type": "string",
"description": "Секретный гостевой токен для последующих запросов управления. Используйте указанный в документации заголовок гостевой авторизации; никогда не записывайте токен в журналы.",
"example": "synthetic-example-credential"
},
"manageTokenExpiresAt": {
"type": "string",
"description": "Срок действия гостевого токена управления.",
"format": "date-time",
"example": "2026-12-31T18:00:00.000Z"
}
},
"example": {
"kind": "WAITLIST",
"entityId": "6b288694-8b6d-49cd-8007-264ca7224921",
"referenceCode": "EXAMPLE",
"revision": 1,
"status": "WAITING",
"eventIds": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
],
"manageToken": "synthetic-example-credential",
"manageTokenExpiresAt": "2026-12-31T18:00:00.000Z"
}
}
],
"example": {
"kind": "RESERVATION",
"entityId": "6b288694-8b6d-49cd-8007-264ca7224921",
"referenceCode": "EXAMPLE",
"revision": 1,
"status": "REQUESTED",
"eventIds": [
"6825b43e-93d6-4f3b-8171-c1661099fae8"
],
"manageToken": "synthetic-example-credential",
"manageTokenExpiresAt": "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"
}