Авторизация
Персональный доступ передаётся в body: public-guest-native-read-capability.
Руководство по подключениюПараметры
originЗаголовок · ОбязательноФактический Origin, переданный браузером. Обязателен для канонических и привязанных наблюдателей; проверяется по настроенному каноническому адресу или текущей привязке представления ресурса Hallify.
stringПолное определение
{ "type": "string", "maxLength": 2048, "example": "example" }
Тело запроса
Обязательно
Точный поддерживаемый ресурс Hallify и его текущий приватный ключ. Права передаются в теле; cookie и заголовки учётной записи браузера не предоставляют запасную авторизацию.
application/json
Полное определение
{
"$ref": "#/components/schemas/IssuePublicGuestObserverTicketDto"
}Ответы
200Приватный одноразовый билет, привязанный к Origin, и несекретная привязка сессии. Ключ ресурса Hallify не возвращается.
Заголовки ответа
Cache-ControlОтвет, содержащий ключ доступа, никогда не кешируется.
stringПолное определение
{
"type": "string",
"enum": [
"no-store"
],
"example": "no-store"
}Полное определение
{
"$ref": "#/components/schemas/PublicGuestObserverTicketDto"
}{
"ticket": "gpot1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"expiresAt": "2026-12-31T18:00:00.000Z",
"scopeBinding": "gpos1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}400Некорректный формат ресурса или ключа доступа.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}401Текущие права наблюдателя недоступны или истекли.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}403Фактический Origin браузера отсутствует или не разрешён.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 403,
"error": "errors:http.forbidden",
"code": "HTTP_FORBIDDEN",
"message": "errors:http.forbidden",
"translationKey": "errors:http.forbidden"
}404Права READ ресурса Hallify недоступны; наличие ресурса не раскрывается.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 404,
"error": "errors:http.notFound",
"code": "HTTP_NOT_FOUND",
"message": "errors:http.notFound",
"translationKey": "errors:http.notFound"
}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Не удалось завершить выдачу билета в установленных пределах.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Схемы
IssuePublicGuestObserverTicketDto
Приватная команда допуска с текущим ключом READ одного запланированного предзаказа, бронирования, записи листа ожидания или QR-сессии стола Hallify. Владелец ресурса проверяет точный ресурс и фактический Origin браузера перед выдачей билета наблюдения; ключи учётной записи и устройства не предоставляют прав.
kindОбязательноТип ресурса Hallify с реализованным допуском наблюдателей, разрешённый переданным текущим ключом READ. Запланированный предзаказ, бронирование, лист ожидания и сессия стола проверяются своими доменами.
allOfПолное определение
{ "description": "Тип ресурса Hallify с реализованным допуском наблюдателей, разрешённый переданным текущим ключом READ. Запланированный предзаказ, бронирование, лист ожидания и сессия стола проверяются своими доменами.", "allOf": [ { "$ref": "#/components/schemas/PublicObserverTicketResourceKind" } ], "example": "PREORDER" }resourceIdОбязательноТочный UUID исполнения предзаказа, бронирования, записи листа ожидания или сессии стола Hallify. Текущий ключ должен принадлежать этому ресурсу.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "Точный UUID исполнения предзаказа, бронирования, записи листа ожидания или сессии стола Hallify. Текущий ключ должен принадлежать этому ресурсу.", "example": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568" }capabilityОбязательноТекущий приватный ключ READ выбранного ресурса Hallify. Передавайте прямо в теле этой команды; не помещайте в URL, Redux, журналы или механизм авторизации учётной записи браузера.
stringПолное определение
{ "type": "string", "minLength": 20, "maxLength": 1024, "writeOnly": true, "description": "Текущий приватный ключ READ выбранного ресурса Hallify. Передавайте прямо в теле этой команды; не помещайте в URL, Redux, журналы или механизм авторизации учётной записи браузера.", "example": "https://example.test/resource" }
Полное определение
{
"type": "object",
"properties": {
"kind": {
"description": "Тип ресурса Hallify с реализованным допуском наблюдателей, разрешённый переданным текущим ключом READ. Запланированный предзаказ, бронирование, лист ожидания и сессия стола проверяются своими доменами.",
"allOf": [
{
"$ref": "#/components/schemas/PublicObserverTicketResourceKind"
}
],
"example": "PREORDER"
},
"resourceId": {
"type": "string",
"format": "uuid",
"description": "Точный UUID исполнения предзаказа, бронирования, записи листа ожидания или сессии стола Hallify. Текущий ключ должен принадлежать этому ресурсу.",
"example": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568"
},
"capability": {
"type": "string",
"minLength": 20,
"maxLength": 1024,
"writeOnly": true,
"description": "Текущий приватный ключ READ выбранного ресурса Hallify. Передавайте прямо в теле этой команды; не помещайте в URL, Redux, журналы или механизм авторизации учётной записи браузера.",
"example": "https://example.test/resource"
}
},
"description": "Приватная команда допуска с текущим ключом READ одного запланированного предзаказа, бронирования, записи листа ожидания или QR-сессии стола Hallify. Владелец ресурса проверяет точный ресурс и фактический Origin браузера перед выдачей билета наблюдения; ключи учётной записи и устройства не предоставляют прав.",
"required": [
"kind",
"resourceId",
"capability"
],
"example": {
"kind": "PREORDER",
"resourceId": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568",
"capability": "https://example.test/resource"
}
}PublicObserverTicketResourceKind
Тип ресурса Hallify с реализованным допуском наблюдателей, разрешённый переданным текущим ключом READ. Запланированный предзаказ, бронирование, лист ожидания и сессия стола проверяются своими доменами.
Полное определение
{
"type": "string",
"enum": [
"PREORDER",
"RESERVATION",
"WAITLIST",
"TABLE_SESSION"
],
"description": "Тип ресурса Hallify с реализованным допуском наблюдателей, разрешённый переданным текущим ключом READ. Запланированный предзаказ, бронирование, лист ожидания и сессия стола проверяются своими доменами.",
"example": "PREORDER"
}PublicGuestObserverTicketDto
Приватная квитанция одного одноразового допуска к наблюдению за ресурсом Hallify с привязкой к Origin. Срок базы данных ограничивает приём билета, а текущее разрешение на наблюдение остаётся ограничено действующими правами ресурса и представления. Привязка области определяет несекретное пространство имён сессии.
ticketОбязательноПриватный одноразовый билет перехода к WebSocket. Передайте отдельным подпротоколом вместе с hallify.socket.v1; сервер возвращает только стабильный протокол. Храните значение в памяти, вне URL, cookie и Redux.
stringПолное определение
{ "type": "string", "minLength": 49, "maxLength": 49, "pattern": "^gpot1_[A-Za-z0-9_-]{43}$", "example": "gpot1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "description": "Приватный одноразовый билет перехода к WebSocket. Передайте отдельным подпротоколом вместе с hallify.socket.v1; сервер возвращает только стабильный протокол. Храните значение в памяти, вне URL, cookie и Redux." }expiresAtОбязательноСрок допуска, назначенный базой данных: не более 30 секунд и не позднее текущих разрешённых сроков ресурса Hallify и представления. Это не срок действия текущего разрешения на наблюдение.
string · date-timeПолное определение
{ "type": "string", "format": "date-time", "description": "Срок допуска, назначенный базой данных: не более 30 секунд и не позднее текущих разрешённых сроков ресурса Hallify и представления. Это не срок действия текущего разрешения на наблюдение.", "example": "2026-12-31T18:00:00.000Z" }scopeBindingОбязательноНесекретная привязка прав ресурса для области сессии Socket. Добавьте двоеточие и непустой клиентский контекст длиной до 128 символов; действующий допуск ресурса Hallify по-прежнему обязателен.
stringПолное определение
{ "type": "string", "minLength": 49, "maxLength": 49, "pattern": "^gpos1_[A-Za-z0-9_-]{43}$", "example": "gpos1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "description": "Несекретная привязка прав ресурса для области сессии Socket. Добавьте двоеточие и непустой клиентский контекст длиной до 128 символов; действующий допуск ресурса Hallify по-прежнему обязателен." }
Полное определение
{
"type": "object",
"properties": {
"ticket": {
"type": "string",
"minLength": 49,
"maxLength": 49,
"pattern": "^gpot1_[A-Za-z0-9_-]{43}$",
"example": "gpot1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"description": "Приватный одноразовый билет перехода к WebSocket. Передайте отдельным подпротоколом вместе с hallify.socket.v1; сервер возвращает только стабильный протокол. Храните значение в памяти, вне URL, cookie и Redux."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Срок допуска, назначенный базой данных: не более 30 секунд и не позднее текущих разрешённых сроков ресурса Hallify и представления. Это не срок действия текущего разрешения на наблюдение.",
"example": "2026-12-31T18:00:00.000Z"
},
"scopeBinding": {
"type": "string",
"minLength": 49,
"maxLength": 49,
"pattern": "^gpos1_[A-Za-z0-9_-]{43}$",
"example": "gpos1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"description": "Несекретная привязка прав ресурса для области сессии Socket. Добавьте двоеточие и непустой клиентский контекст длиной до 128 символов; действующий допуск ресурса Hallify по-прежнему обязателен."
}
},
"description": "Приватная квитанция одного одноразового допуска к наблюдению за ресурсом Hallify с привязкой к Origin. Срок базы данных ограничивает приём билета, а текущее разрешение на наблюдение остаётся ограничено действующими правами ресурса и представления. Привязка области определяет несекретное пространство имён сессии.",
"required": [
"ticket",
"expiresAt",
"scopeBinding"
],
"example": {
"ticket": "gpot1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"expiresAt": "2026-12-31T18:00:00.000Z",
"scopeBinding": "gpos1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
}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"
}