Подтвердить целевой повторный вход в Guest Portal

Авторизация

Персональный доступ передаётся в body: guest-portal-reentry-one-time-code.

Руководство по подключению

Параметры

Параметров пути, запроса и обычных заголовков нет. Проверьте авторизацию и тело запроса ниже.

Тело запроса

Обязательно

Одноразовый код повторного входа, связанный с исходным существующим контактом, его точной версией и областью Portal.

application/json

GuestPortalReentryConfirmationDto

Полное определение

{
  "$ref": "#/components/schemas/GuestPortalReentryConfirmationDto"
}

Ответы

200Новое ограниченное continuation Guest Portal.

GuestPortalReentryContinuationDto

Полное определение

{
  "$ref": "#/components/schemas/GuestPortalReentryContinuationDto"
}

Пример ответа · 200 · application/json

{
  "token": "synthetic-example-credential",
  "expiresAt": "2026-12-31T18:00:00.000Z"
}

400Неверные входные данные или одноразовый код; гость и контакт не раскрываются.

TranslatedErrorDto

Полное определение

{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}

Пример ответа · 400 · application/json

{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}

429Исчерпан ограниченный бюджет проверок IP или hint.

Заголовки ответа

Retry-After

Целое количество секунд ожидания перед повтором отклонённого запроса.

integer

Полное определение

{
  "type": "integer",
  "minimum": 1,
  "example": 60
}

TranslatedErrorDto

Полное определение

{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}

Пример ответа · 429 · application/json

{
  "statusCode": 429,
  "error": "errors:http.tooManyRequests",
  "code": "HTTP_TOO_MANY_REQUESTS",
  "message": "errors:http.tooManyRequests",
  "translationKey": "errors:http.tooManyRequests"
}

503Notification capability недоступна.

TranslatedErrorDto

Полное определение

{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}

Пример ответа · 503 · application/json

{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Схемы

GuestPortalReentryConfirmationDto

Подтверждение одноразового кода с фиксированной целью для исходного подтверждённого гостевого контакта.

requestIdОбязательно: Исходный идентификатор одноразового запроса.
string · uuid
Полное определение
{ "type": "string", "description": "Исходный идентификатор одноразового запроса.", "format": "uuid", "example": "8b92d522-894a-427c-8509-9f0795659b5b" }
codeОбязательно: Одноразовый код, отправленный исходному подтверждённому контакту.
string
Полное определение
{ "type": "string", "description": "Одноразовый код, отправленный исходному подтверждённому контакту.", "pattern": "^[0-9]{6}$", "minLength": 6, "maxLength": 6, "writeOnly": true, "example": "000001" }

Полное определение

{
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "Исходный идентификатор одноразового запроса.",
      "format": "uuid",
      "example": "8b92d522-894a-427c-8509-9f0795659b5b"
    },
    "code": {
      "type": "string",
      "description": "Одноразовый код, отправленный исходному подтверждённому контакту.",
      "pattern": "^[0-9]{6}$",
      "minLength": 6,
      "maxLength": 6,
      "writeOnly": true,
      "example": "000001"
    }
  },
  "description": "Подтверждение одноразового кода с фиксированной целью для исходного подтверждённого гостевого контакта.",
  "required": [
    "requestId",
    "code"
  ],
  "example": {
    "requestId": "8b92d522-894a-427c-8509-9f0795659b5b",
    "code": "000001"
  }
}

GuestPortalReentryContinuationDto

Новое приватное continuation Guest Portal после атомарной одноразовой проверки.

tokenОбязательно: Новое краткосрочное continuation Guest Portal; храните его приватно только в сессии Portal.
string
Полное определение
{ "type": "string", "description": "Новое краткосрочное continuation Guest Portal; храните его приватно только в сессии Portal.", "readOnly": true, "example": "synthetic-example-credential" }
expiresAtОбязательно: Срок continuation.
string · date-time
Полное определение
{ "type": "string", "description": "Срок continuation.", "format": "date-time", "example": "2026-12-31T18:00:00.000Z" }
reentryContextНеобязательно: Необязательная цель восстановления без права чтения для тех же исходных контакта и области доступа. Не даёт доступа к Portal, inbox или push.
allOf
Полное определение
{ "description": "Необязательная цель восстановления без права чтения для тех же исходных контакта и области доступа. Не даёт доступа к Portal, inbox или push.", "allOf": [ { "$ref": "#/components/schemas/GuestPortalReentryContextDto" } ], "example": { "hint": "gpr1_synthetic_recovery_context_example_not_a_runtime_credential_0000000000", "expiresAt": "2026-12-31T18:00:00.000Z" } }

Полное определение

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "Новое краткосрочное continuation Guest Portal; храните его приватно только в сессии Portal.",
      "readOnly": true,
      "example": "synthetic-example-credential"
    },
    "expiresAt": {
      "type": "string",
      "description": "Срок continuation.",
      "format": "date-time",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "reentryContext": {
      "description": "Необязательная цель восстановления без права чтения для тех же исходных контакта и области доступа. Не даёт доступа к Portal, inbox или push.",
      "allOf": [
        {
          "$ref": "#/components/schemas/GuestPortalReentryContextDto"
        }
      ],
      "example": {
        "hint": "gpr1_synthetic_recovery_context_example_not_a_runtime_credential_0000000000",
        "expiresAt": "2026-12-31T18:00:00.000Z"
      }
    }
  },
  "description": "Новое приватное continuation Guest Portal после атомарной одноразовой проверки.",
  "required": [
    "token",
    "expiresAt"
  ],
  "example": {
    "token": "synthetic-example-credential",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  }
}

GuestPortalReentryContextDto

Контекст восстановления исходного существующего контакта гостя и области кабинета не предоставляет права чтения. Для непроверенного кандидата по-прежнему требуется успешное подтверждение OTP. Контекст разрешает только целевой сценарий повторного входа, но не доступ к кабинету, входящим сообщениям или push.

hintОбязательно: Непрозрачная подсказка для восстановления с проверкой подлинности. Храните её только для выбора исходного контекста: она не является токеном доступа к порталу гостя или разрешением на push.
string
Полное определение
{ "type": "string", "description": "Непрозрачная подсказка для восстановления с проверкой подлинности. Храните её только для выбора исходного контекста: она не является токеном доступа к порталу гостя или разрешением на push.", "minLength": 64, "maxLength": 2048, "pattern": "^gpr1_[A-Za-z0-9_-]+$", "example": "gpr1_synthetic_recovery_context_example_not_a_runtime_credential_0000000000", "readOnly": true }
expiresAtОбязательно: Абсолютный срок действия контекста восстановления. Перед каждым запросом кода и подтверждением сервер проверяет текущего гостя, исходный контакт и область доступа портала.
string · date-time
Полное определение
{ "type": "string", "description": "Абсолютный срок действия контекста восстановления. Перед каждым запросом кода и подтверждением сервер проверяет текущего гостя, исходный контакт и область доступа портала.", "format": "date-time", "readOnly": true, "example": "2026-12-31T18:00:00.000Z" }

Полное определение

{
  "type": "object",
  "properties": {
    "hint": {
      "type": "string",
      "description": "Непрозрачная подсказка для восстановления с проверкой подлинности. Храните её только для выбора исходного контекста: она не является токеном доступа к порталу гостя или разрешением на push.",
      "minLength": 64,
      "maxLength": 2048,
      "pattern": "^gpr1_[A-Za-z0-9_-]+$",
      "example": "gpr1_synthetic_recovery_context_example_not_a_runtime_credential_0000000000",
      "readOnly": true
    },
    "expiresAt": {
      "type": "string",
      "description": "Абсолютный срок действия контекста восстановления. Перед каждым запросом кода и подтверждением сервер проверяет текущего гостя, исходный контакт и область доступа портала.",
      "format": "date-time",
      "readOnly": true,
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "description": "Контекст восстановления исходного существующего контакта гостя и области кабинета не предоставляет права чтения. Для непроверенного кандидата по-прежнему требуется успешное подтверждение OTP. Контекст разрешает только целевой сценарий повторного входа, но не доступ к кабинету, входящим сообщениям или push.",
  "required": [
    "hint",
    "expiresAt"
  ],
  "example": {
    "hint": "gpr1_synthetic_recovery_context_example_not_a_runtime_credential_0000000000",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  }
}

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"
}