Обменять начальный токен гостевого кабинета

Примеры запросов

Демонстрационные данные. Примеры не отправляют запросы. В своей интеграции подставьте значения, полученные на предыдущих шагах.

cURL

curl --request POST 'https://api.hallify.co/guest-portal/exchange' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "token": "gpb2_synthetic-example-credentialxxxxxxxxxxxxxxx"
}'

Пример ответа

Кратковременный токен продолжения гостевого кабинета.

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

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

Авторизация

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

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

Параметры

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

Тело запроса

Обязательно

Начальный токен, извлечённый из фрагмента URL и обмениваемый ровно один раз.

application/json

ExchangeGuestPortalTokenDto

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

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

Ответы

200Кратковременный токен продолжения гостевого кабинета.

GuestPortalBootstrapExchangeResultDto

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

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

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

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

Схемы

ExchangeGuestPortalTokenDto

Запрос одноразового обмена начального токена гостевого кабинета.

tokenОбязательно: Начальный токен, извлечённый из фрагмента URL.
string
Полное определение
{ "type": "string", "minLength": 48, "maxLength": 48, "pattern": "^gpb2_[A-Za-z0-9_-]{43}$", "example": "gpb2_synthetic-example-credentialxxxxxxxxxxxxxxx", "description": "Начальный токен, извлечённый из фрагмента URL." }

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

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "minLength": 48,
      "maxLength": 48,
      "pattern": "^gpb2_[A-Za-z0-9_-]{43}$",
      "example": "gpb2_synthetic-example-credentialxxxxxxxxxxxxxxx",
      "description": "Начальный токен, извлечённый из фрагмента URL."
    }
  },
  "required": [
    "token"
  ],
  "description": "Запрос одноразового обмена начального токена гостевого кабинета.",
  "example": {
    "token": "gpb2_synthetic-example-credentialxxxxxxxxxxxxxxx"
  }
}

GuestPortalBootstrapExchangeResultDto

Кратковременный токен продолжения после однократного использования начального токена.

tokenОбязательно: Заменённый токен продолжения гостевого кабинета.
string
Полное определение
{ "type": "string", "minLength": 32, "description": "Заменённый токен продолжения гостевого кабинета.", "example": "synthetic-example-credentialxxxx" }
expiresAtОбязательно: Абсолютный срок действия токена продолжения.
string · date-time
Полное определение
{ "type": "string", "format": "date-time", "description": "Абсолютный срок действия токена продолжения.", "example": "2026-12-31T18:00:00.000Z" }

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

{
  "type": "object",
  "description": "Кратковременный токен продолжения после однократного использования начального токена.",
  "required": [
    "token",
    "expiresAt"
  ],
  "properties": {
    "token": {
      "type": "string",
      "minLength": 32,
      "description": "Заменённый токен продолжения гостевого кабинета.",
      "example": "synthetic-example-credentialxxxx"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Абсолютный срок действия токена продолжения.",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "example": {
    "token": "synthetic-example-credentialxxxx",
    "expiresAt": "2026-12-31T18:00:00.000Z"
  }
}