Регистрация по приглашению

Метод используется для регистрации нового пользователя в Панели управления Клиента после принятия приглашения присоединиться к аккаунту (см. action = sign_up в Приглашенные пользователи). В результате метод возвращает следующую информацию:

Если MFA не используется — набор токенов для дальнейшей работы пользователя.
Если MFA используется — сообщение о необходимости войти в Панель управления Клиента для получения набора токенов (см. Вход).

Если приглашение было отправлено существующему пользователю (см. action = sign_in в Приглашенные пользователи), используется другой метод (см. Вход).

POST {reseller_domain}/internal_api/sign_up_by_invitation

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

Авторизация

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

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
reseller_domain	path	string	Обязательный	Доменное имя реселлера
first_name	form	string	Обязательный	Имя приглашенного пользователя. Не менее 2 символов. Не может состоять только из цифр и специальных символов
last_name	form	string	Обязательный	Фамилия приглашенного пользователя. Не менее 2 символов. Не может состоять только из цифр и специальных символов
email	form	string	Обязательный	Уникальный email приглашенного пользователя, который будет использоваться как логин для входа в Панель управления Клиента. Значения `email` и `invitation_token` должны быть из одного приглашения
password	form	string	Обязательный	Пароль приглашенного пользователя для входа в Панель управления Клиента. Требования к паролю см. в
invitation_token	form	string	Обязательный	Токен из приглашения. Значения `email` и `invitation_token` должны быть из одного приглашения
agreement_confirmed	form	bool	Опциональный	Признак принятия соглашения Уведомление о конфиденциальности и Политика конфиденциальности (см. и Получение настроек реселлера): true — новый пользователь принимает соглашение. В зависимости от настроек реселлера принятие соглашения может быть обязательным. false — новый пользователь не принимает соглашение.
captcha_token	form	string	Опциональный	Токен пользователя, полученный от reCAPTCHA после нажатия кнопки регистрации. Обязательный, если в настройках кастомизации задано `use_captcha_service = true` (см. Получение настроек кастомизации )

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

Метод возвращает набор токенов пользователя или сообщение о необходимости войти в Панель управления Клиента для получения набора токенов аналогично методу Подтверждение email.

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

Bash

curl --location --request POST 'https://test.activeplatform.com/internal_api/sign_up_by_invitation' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--data-raw '{
    "data": {
        "attributes": {
            "first_name": "Nelle",
            "last_name": "Larkin",
            "email": "user@example.com",
            "password": "12345678",
            "invitation_token": "invitationTokenExample",
            "agreement_confirmed": true
        }
    }
}'

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

MFA не используется

JSON

Cookie: jwt_refresh=refreshTokenExample

{
    "access": "accessTokenExample",
    "csrf": "csrfTokenExample==",
    "refresh_expires_at": "2023-01-01T12:34:56.000+00:00"
}

MFA используется

JSON

{
    "status": "login_required"
}