Авторизация
x-hallify-widget-context: <HALLIFY_STOREFRONT_WIDGET_CONTEXT>Краткосрочный server-authenticated widget presentation proof. Связывает настроенный frame origin с точными проверенными parent binding и connection authority. Новый widget-спрос требует этот proof; существующие native capabilities сохраняют отдельные права и исходные сроки.
Параметры
locatorПуть · ОбязательноПубличный QR-идентификатор физического стола из 24 символов. Его разрешённый непрозрачный контекст должен соответствовать этой попытке присоединения, текущему идентификатору Hallify и сессии обслуживания.
stringПолное определение
{ "type": "string", "minLength": 24, "maxLength": 24, "pattern": "^[A-Za-z0-9_-]{24}$", "example": "qr_demo_locator_00000001" }idempotency-keyЗаголовок · ОбязательноОбязательный ключ идемпотентности длиной до 128 символов.
stringПолное определение
{ "type": "string", "minLength": 1, "maxLength": 128, "example": "example" }originЗаголовок · ОбязательноФактический Origin запроса, которым управляет браузер: используется для проверки разрешённого источника представления и его текущей привязки ресурса. Браузерные клиенты сохраняют это значение; авторизацию гостя предоставляет отдельный ключ запроса присоединения или участия в сессии.
string · uriПолное определение
{ "type": "string", "format": "uri", "example": "https://example.test/resource" }
Тело запроса
Обязательно
Непрозрачный контекст разрешения идентификатора, разрешённый способ присоединения и текущий шестизначный PIN только для SESSION_PIN. STAFF_APPROVAL не принимает PIN, выбранный клиентом слот или решение сотрудника. Перед допуском повторно проверяются фактический Origin и текущие права Hallify.
application/json
Полное определение
{
"$ref": "#/components/schemas/CreateTablePublicJoinDto"
}Ответы
201Исходная квитанция присоединения и её приватный ключ, ограниченный этим запросом.
Полное определение
{
"$ref": "#/components/schemas/TablePublicJoinCreatedDto"
}{
"id": "4186fdc1-e9b6-4378-8bdc-6c7727b0c09f",
"status": "PENDING_APPROVAL",
"revision": 1,
"expiresAt": "2026-12-31T18:00:00.000Z",
"requestToken": "synthetic-example-credentialxxxxxxxxxxxxxxx"
}400Некорректный формат переданного идентификатора, запроса или ключа доступа.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}401QR-ключ, текущие права Hallify или точный Origin запроса не разрешены.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}404Текущий публичный идентификатор, привязка представления или принадлежащий ему ресурс Hallify недоступны.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 404,
"error": "errors:http.notFound",
"code": "HTTP_NOT_FOUND",
"message": "errors:http.notFound",
"translationKey": "errors:http.notFound"
}409Конфликт идемпотентности или документированный доменный конфликт конкретной операции
Полное определение
{
"$ref": "#/components/schemas/TablePublicCommandConflictDto"
}{
"statusCode": 409,
"error": "errors:http.conflict",
"code": "TABLE_PUBLIC_REVISION_CONFLICT",
"message": "errors:http.conflict",
"translationKey": "errors:http.conflict"
}429Исчерпан установленный лимит запросов присоединения Hallify или попыток PIN. Подождите перед новой командой.
Заголовки ответа
Retry-AfterЦелое количество секунд ожидания перед повтором отклонённого запроса.
integerПолное определение
{
"type": "integer",
"minimum": 1,
"example": 60
}Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 429,
"error": "errors:http.tooManyRequests",
"code": "HTTP_TOO_MANY_REQUESTS",
"message": "errors:http.tooManyRequests",
"translationKey": "errors:http.tooManyRequests"
}503Невозможно безопасно использовать QR-ключи или достоверное состояние Hallify.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Схемы
CreateTablePublicJoinDto
Запрос допуска гостя, привязанный к непрозрачному контексту идентификатора физического стола и текущему Origin представления. Допуск обеспечивается PIN-кодом сессии или последующим одобрением сотрудника; владелец допуска выбирает слот Hallify.
joinContextОбязательноНепрозрачный краткосрочный контекст, полученный при разрешении публичного идентификатора стола.
stringПолное определение
{ "type": "string", "maxLength": 22000, "description": "Непрозрачный краткосрочный контекст, полученный при разрешении публичного идентификатора стола.", "example": "example" }methodОбязательноСпособ нового допуска к участию в сессии, разрешённый текущей политикой заведения.
stringПолное определение
{ "type": "string", "enum": [ "SESSION_PIN", "STAFF_APPROVAL" ], "example": "STAFF_APPROVAL", "description": "Способ нового допуска к участию в сессии, разрешённый текущей политикой заведения." }pinНеобязательноТекущий шестизначный PIN сессии обслуживания. Обязателен для SESSION_PIN и должен отсутствовать для STAFF_APPROVAL.
stringПолное определение
{ "type": "string", "pattern": "^\\d{6}$", "minLength": 6, "maxLength": 6, "description": "Текущий шестизначный PIN сессии обслуживания. Обязателен для SESSION_PIN и должен отсутствовать для STAFF_APPROVAL.", "example": "000001" }
Полное определение
{
"type": "object",
"properties": {
"joinContext": {
"type": "string",
"maxLength": 22000,
"description": "Непрозрачный краткосрочный контекст, полученный при разрешении публичного идентификатора стола.",
"example": "example"
},
"method": {
"type": "string",
"enum": [
"SESSION_PIN",
"STAFF_APPROVAL"
],
"example": "STAFF_APPROVAL",
"description": "Способ нового допуска к участию в сессии, разрешённый текущей политикой заведения."
},
"pin": {
"type": "string",
"pattern": "^\\d{6}$",
"minLength": 6,
"maxLength": 6,
"description": "Текущий шестизначный PIN сессии обслуживания. Обязателен для SESSION_PIN и должен отсутствовать для STAFF_APPROVAL.",
"example": "000001"
}
},
"description": "Запрос допуска гостя, привязанный к непрозрачному контексту идентификатора физического стола и текущему Origin представления. Допуск обеспечивается PIN-кодом сессии или последующим одобрением сотрудника; владелец допуска выбирает слот Hallify.",
"required": [
"joinContext",
"method"
],
"example": {
"joinContext": "example",
"method": "STAFF_APPROVAL"
}
}TablePublicJoinCreatedDto
Исходная квитанция присоединения Hallify с приватным ключом для чтения запроса допуска и получения участия по нему. Получение участия по одобренному запросу создаёт отдельное участие в сессии.
idОбязательноИдентификатор принадлежащего гостю запроса присоединения.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "Идентификатор принадлежащего гостю запроса присоединения.", "example": "4186fdc1-e9b6-4378-8bdc-6c7727b0c09f" }statusОбязательноРешение по допуску Hallify и состояние получения участия.
stringПолное определение
{ "type": "string", "enum": [ "PENDING_APPROVAL", "APPROVED", "CLAIMED", "REJECTED", "EXPIRED", "REVOKED" ], "description": "Решение по допуску Hallify и состояние получения участия.", "example": "PENDING_APPROVAL" }revisionОбязательноОптимистическая ревизия запроса присоединения.
integerПолное определение
{ "type": "integer", "minimum": 1, "description": "Оптимистическая ревизия запроса присоединения.", "example": 1 }expiresAtОбязательноКрайний срок первого получения участия по одобренному запросу.
string · date-timeПолное определение
{ "type": "string", "format": "date-time", "description": "Крайний срок первого получения участия по одобренному запросу.", "example": "2026-12-31T18:00:00.000Z" }requestTokenОбязательноПриватный ключ, ограниченный этим запросом присоединения; не предоставляет чтение счёта стола.
stringПолное определение
{ "type": "string", "minLength": 43, "maxLength": 43, "description": "Приватный ключ, ограниченный этим запросом присоединения; не предоставляет чтение счёта стола.", "example": "synthetic-example-credentialxxxxxxxxxxxxxxx" }
Полное определение
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Идентификатор принадлежащего гостю запроса присоединения.",
"example": "4186fdc1-e9b6-4378-8bdc-6c7727b0c09f"
},
"status": {
"type": "string",
"enum": [
"PENDING_APPROVAL",
"APPROVED",
"CLAIMED",
"REJECTED",
"EXPIRED",
"REVOKED"
],
"description": "Решение по допуску Hallify и состояние получения участия.",
"example": "PENDING_APPROVAL"
},
"revision": {
"type": "integer",
"minimum": 1,
"description": "Оптимистическая ревизия запроса присоединения.",
"example": 1
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Крайний срок первого получения участия по одобренному запросу.",
"example": "2026-12-31T18:00:00.000Z"
},
"requestToken": {
"type": "string",
"minLength": 43,
"maxLength": 43,
"description": "Приватный ключ, ограниченный этим запросом присоединения; не предоставляет чтение счёта стола.",
"example": "synthetic-example-credentialxxxxxxxxxxxxxxx"
}
},
"description": "Исходная квитанция присоединения Hallify с приватным ключом для чтения запроса допуска и получения участия по нему. Получение участия по одобренному запросу создаёт отдельное участие в сессии.",
"required": [
"id",
"status",
"revision",
"expiresAt",
"requestToken"
],
"example": {
"id": "4186fdc1-e9b6-4378-8bdc-6c7727b0c09f",
"status": "PENDING_APPROVAL",
"revision": 1,
"expiresAt": "2026-12-31T18:00:00.000Z",
"requestToken": "synthetic-example-credentialxxxxxxxxxxxxxxx"
}
}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"
}TablePublicCommandConflictDto
Конфликт QR-команды Hallify: выполняющийся или не совпадающий запрос идемпотентности, устаревшая ревизия ресурса, изменённое состояние присоединения либо недоступный слот гостя Hallify. Восстановление повтором сохраняет исходное тело команды и область авторизации.
Полное определение
{
"description": "Конфликт QR-команды Hallify: выполняющийся или не совпадающий запрос идемпотентности, устаревшая ревизия ресурса, изменённое состояние присоединения либо недоступный слот гостя Hallify. Восстановление повтором сохраняет исходное тело команды и область авторизации.",
"example": {
"statusCode": 409,
"error": "errors:http.conflict",
"code": "TABLE_PUBLIC_REVISION_CONFLICT",
"message": "errors:http.conflict",
"translationKey": "errors:http.conflict"
},
"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",
"TABLE_PUBLIC_REVISION_CONFLICT",
"TABLE_PUBLIC_JOIN_STATE_CONFLICT",
"TABLE_PUBLIC_SLOT_UNAVAILABLE"
],
"description": "Стабильный код конфликта идемпотентности или доменного конфликта конкретной операции.",
"example": "IDEMPOTENCY_REQUEST_NOT_READY"
}
},
"example": {
"code": "IDEMPOTENCY_REQUEST_NOT_READY"
}
}
]
}