Авторизация
Authorization: Bearer <HALLIFY_TABLE_JOIN_TOKEN>Гостевой ключ одного запроса присоединения к столу, привязанный к заведению, сессии, ресурсу представления и Origin браузера. Не предоставляет участие в сессии стола до успешного получения участия в Hallify.
Параметры
joinIdПуть · ОбязательноЗапрос допуска к столу Hallify, решение или состояние получения участия по которому запрашивается. Исходные заведение, сессия и источник представления остаются неизменными.
string · uuidПолное определение
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }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" }
Ответы
200Исходный приватный ключ участия в сессии стола и его область Hallify.
Полное определение
{
"$ref": "#/components/schemas/TablePublicMembershipCreatedDto"
}{
"membershipId": "4db41e65-a63b-4932-883c-e6c4306ce684",
"tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
"tableSessionGuestId": "cbca9476-6eef-441b-874e-918d61f54560",
"revision": 1,
"expiresAt": "2026-12-31T18:00:00.000Z",
"capability": "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.
Заголовки ответа
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"
}Схемы
TablePublicMembershipCreatedDto
Исходное участие Hallify с приватным ключом, ограниченным основной сессией обслуживания и операционным слотом гостя. Действительность зависит от текущих эпох доступа, отзыва и прав представления.
membershipIdОбязательноПредоставленное участие в сессии стола Hallify.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "Предоставленное участие в сессии стола Hallify.", "example": "4db41e65-a63b-4932-883c-e6c4306ce684" }tableSessionIdОбязательноОсновная сессия обслуживания Hallify, которой ограничено участие.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "Основная сессия обслуживания Hallify, которой ограничено участие.", "example": "9b456a94-f735-466f-84ba-67aa863b2905" }tableSessionGuestIdОбязательноОперационный слот гостя Hallify, назначенный владельцем допуска.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "Операционный слот гостя Hallify, назначенный владельцем допуска.", "example": "cbca9476-6eef-441b-874e-918d61f54560" }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" }capabilityОбязательноПриватный ключ с областью одной сессии. Храните отдельно от транспорта учётной записи и состояния Redux.
stringПолное определение
{ "type": "string", "minLength": 43, "maxLength": 43, "description": "Приватный ключ с областью одной сессии. Храните отдельно от транспорта учётной записи и состояния Redux.", "example": "synthetic-example-credentialxxxxxxxxxxxxxxx" }
Полное определение
{
"type": "object",
"properties": {
"membershipId": {
"type": "string",
"format": "uuid",
"description": "Предоставленное участие в сессии стола Hallify.",
"example": "4db41e65-a63b-4932-883c-e6c4306ce684"
},
"tableSessionId": {
"type": "string",
"format": "uuid",
"description": "Основная сессия обслуживания Hallify, которой ограничено участие.",
"example": "9b456a94-f735-466f-84ba-67aa863b2905"
},
"tableSessionGuestId": {
"type": "string",
"format": "uuid",
"description": "Операционный слот гостя Hallify, назначенный владельцем допуска.",
"example": "cbca9476-6eef-441b-874e-918d61f54560"
},
"revision": {
"type": "integer",
"minimum": 1,
"description": "Ревизия прав участия в сессии.",
"example": 1
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Время окончания действия ключа участия в сессии.",
"example": "2026-12-31T18:00:00.000Z"
},
"capability": {
"type": "string",
"minLength": 43,
"maxLength": 43,
"description": "Приватный ключ с областью одной сессии. Храните отдельно от транспорта учётной записи и состояния Redux.",
"example": "synthetic-example-credentialxxxxxxxxxxxxxxx"
}
},
"description": "Исходное участие Hallify с приватным ключом, ограниченным основной сессией обслуживания и операционным слотом гостя. Действительность зависит от текущих эпох доступа, отзыва и прав представления.",
"required": [
"membershipId",
"tableSessionId",
"tableSessionGuestId",
"revision",
"expiresAt",
"capability"
],
"example": {
"membershipId": "4db41e65-a63b-4932-883c-e6c4306ce684",
"tableSessionId": "9b456a94-f735-466f-84ba-67aa863b2905",
"tableSessionGuestId": "cbca9476-6eef-441b-874e-918d61f54560",
"revision": 1,
"expiresAt": "2026-12-31T18:00:00.000Z",
"capability": "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"
}
}
]
}