Валидация токена-приглашения

Метод используется для валидации одноразового токена-приглашения, который платформа создает в результате вызова метода Приглашение пользователя. Если валидация токена успешна, пользователь может принять приглашение и зарегистрироваться в Панели управления Клиента с помощью метода Регистрация по приглашению, если action = sign_up (или войти с помощью метода Вход, если action = sign_in). Для успешной валидации нужно указать токен, который еще не использовался. Срок действия токена не ограничен.

GET {reseller_domain}/internal_api/invitation_token_validation

В этой статье:

Авторизация

Авторизация не требуется.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
reseller_domain	path	string	Обязательный	Доменное имя реселлера
invitation_token_validation	query	string	Обязательный	Токен-приглашение, который платформа отправила на email пользователя в результате вызова метода Приглашение пользователя

Модель ответа

Метод возвращает информацию о приглашенном пользователе. Модель ответа аналогична методу Приглашение пользователя.

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

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/invitation_token_validation?invitation_token=InviteTokenExample1' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en'

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

JSON

{
    "data": {
        "id": "296",
        "type": "invited_users",
        "attributes": {
            "account_id": 1185,
            "status": "active",
            "token": "InviteTokenExample1",
            "role": "admin",
            "email": "user1@example.com",
            "invite_date": "2023-01-16T11:21:03.216155+0300",
            "action": "sign_up"
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}