Breadcrumbs

Быстрая регистрация

Метод используется для быстрой регистрации в Панели управления Клиента (см. в руководстве по Панели управления Клиента). В результате вызова метода:

  1. Создается новый пользователь в статусе Активный, который не привязан ни к одному аккаунту.

  2. Платформа отправляет на указанный email уведомление по событию Подтверждение email с ссылкой и одноразовым токеном.

  3. Метод возвращает информацию о созданном пользователе. Код ответа 201 Created.

Для завершения быстрой регистрации и продолжения работы пользователю нужно подтвердить указанный email с помощью токена из уведомления (см. Подтверждение email).

POST {reseller_domain}/internal_api/sign_up

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

Авторизация

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

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

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 нового пользователя, который будет использоваться как логин для входа в Панель управления Клиента

password

form

string

Обязательный

Пароль нового пользователя для входа в Панель управления Клиента. Требования к паролю см. в 

agreement_confirmed

form

bool

Опциональный

Признак принятия соглашения Уведомление о конфиденциальности и Политика конфиденциальности (см. и Получение настроек реселлера):

  • true — новый пользователь принимает соглашение. В зависимости от настроек реселлера принятие соглашения может быть обязательным.

  • false — новый пользователь не принимает соглашение.

captcha_token

form

string

Опциональный

Токен пользователя, полученный от reCAPTCHA после нажатия кнопки регистрации. Обязательный, если в настройках кастомизации задано use_captcha_service = true (см. Получение настроек кастомизации)

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

Название

Тип данных

Описание

data

object

Данные ответа


id

string

ID пользователя


type

string

Тип данных


attributes

object

Информация о созданном пользователе



first_name

string

Имя созданного пользователя



last_name

string

Фамилия созданного пользователя



middle_name

string

Отчество созданного пользователя — пустое значение



email

string

Email созданного пользователя, который используется как логин для входа в Панель управления Клиента

meta

object

Дополнительная информация


server_current_time

string

Текущие дата и время сервера

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

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

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

JSON
{
    "data": {
        "id": "2477",
        "type": "users",
        "attributes": {
            "first_name": "Fadel",
            "last_name": "Parisian",
            "middle_name": "",
            "email": "user@example.com"
        }
    },
    "meta": {
        "server_current_time": "2023-06-30 T12:34:56.199973+0300"
    }
}