Создание клиента

Метод Create account используется для создания клиента для текущего реселлера или любого из его нижестоящих реселлеров.

Клиент будет создан без принятия Согласия с общими условиями работы. При входе в Панель управления Клиента для начала работы потребуется их принять (см. Вход в Панель управления Клиента).

В случае создания нового пользователя с уровнем доступа Владелец, для него будет принято

Клиент будет создан с параметром Разрешение на работу по постоплате = Проверка не проводилась (см. Заказ подписки по модели Постоплата). 

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

POST {base_url}/api/v3/resellers/{reseller_id}/accounts

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
dataformobjectОбязательныйИнформация об атрибутах операции

attributesformobjectОбязательныйАтрибуты операции


account_type_idformintegerОбязательныйID типа клиента (см. Просмотр списка типов клиентов)


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

Основное имя клиента (например, название компании для юридического лица)

Использование в primary_name специальных символов, аббревиатур и доменов верхнего уровня (TLD) может быть ограничено на уровне инсталляции (см. Настройки валидации аккаунта в разделе Глобальные настройки).



first_nameformstringОбязательныйИмя лица, уполномоченного на заключение договора


middle_nameformstringОпциональныйОтчество лица, уполномоченного на заключение договора


last_nameformstringОбязательныйФамилия лица, уполномоченного на заключение договора


emailformstringОбязательныйEmail лица, уполномоченного на заключение договора


owner_idformintegerОпциональныйID существующего пользователя, который будет связан с клиентом и получит уровень доступа Владелец в Панель управления Клиента. Обязательный, когда не требуется создавать нового пользователя с уровнем доступа Владелец


new_owner_first_name

formstringОпциональныйИмя нового пользователя с уровнем доступа Владелец, который будет создан и прикреплен к клиенту. Обязательный, если не задан owner_id


new_owner_middle_name

formstringОпциональныйОтчество нового пользователя с уровнем доступа Владелец, который будет создан и прикреплен к клиенту. Может указываться, если не задан owner_id


new_owner_last_name

formstringОпциональныйФамилия нового пользователя с уровнем доступа Владелец, который будет создан и прикреплен к клиенту. Обязательный, если не задан owner_id


new_owner_email

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

Email нового пользователя с уровнем доступа Владелец, который будет создан и прикреплен к клиенту. Обязательный, если не задан owner_id



manager_id

form

integer

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

ID менеджера (сотрудника реселлера), который будет прикреплен к данному клиенту

Менеджер должен иметь роль Менеджер по продажам и статус Активный (см. Получение информации о менеджере)



account_class_key

form

string

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

Ключ правила обслуживания, по которому будет обслуживаться клиент (см. Правила обслуживания)



country

form

string

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

Контакты: Код страны ISO 3166-1 alpha-2

Реселлер может ограничить список стран, доступных при создании клиента. См. раздел Настройки региона в Задание общих системных настроек.



region

form

string

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

Контакты: Регион (Область)



city

form

string

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

Контакты: Город



street

form

string

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

Контакты: Улица



building

form

string

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

Контакты: Дом



office

form

string

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

Контакты: Номер офиса (Помещение)



zip

form

string

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

Контакты: Почтовый индекс



phone

form

string

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

Контакты: Телефон в международном формате:

  • + < код страны > < код города или сети > < номер телефона >.
  • 00 < код страны > < код города или сети > < номер телефона >.


custom_attributesformobjectОпциональныйДополнительные параметры клиента (см. Настройка дополнительных параметров)



dataformarrayОпциональныйИнформация о дополнительных параметрах клиента 




keyform

string

Зависит от типа клиента

Ключ дополнительного параметра клиента




valueform

string

Зависит от типа клиента

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

В зависимости от типа данных значение дополнительного параметра указывается в следующем формате:

  • Логический тип:
    • 1 соответствует true.
    • 0 соответствует false.
  • Дата: ДД.ММ.ГГГГ.
  • Список: Ключ элемента.

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

В случае отсутствия ошибок метод возвращает данные о созданном клиенте (см. Получение информации о клиенте). Статус ответа: 201 Created.

Ошибки

Статус ошибкиТекст ошибкиКомментарий
422Менеджер аккаунта должен иметь роль 'менеджер по продажам' и находится в статусе 'активный'Если требуется прикрепить менеджера к клиенту, необходимо указать ID менеджера (сотрудника реселлера), который имеет роль Менеджер по продажам и статус Активный (см. Получение информации о менеджере)
Клиент не может быть создан с указанной страной. Доступные варианты: <перечень>Реселлер ограничил список стран, доступных при создании клиента. См. раздел Настройки региона в Задание общих системных настроек
Ошибки валидации параметров клиента отображаются аналогично Панели управления Оператора (см. Создание клиента в ActivePlatform. Панель управления Оператора)

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

POST /api/v3/resellers/1/accounts
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
{
    "data": {
        "attributes": {
            "account_type_id": 1,
            "first_name": "Clotilde",
            "middle_name": "",
            "last_name": "Ledner",
            "email": "ClotildeLedner@example.com",
            "new_owner_first_name": "Alba",
            "new_owner_middle_name": "",
            "new_owner_last_name": "Stehr",
            "new_owner_email": "AlbaStehr@example.com",
            "manager_id": 188,
            "account_class_key": "postpaytest",
            "country": "BY",
            "region": "Minsk",
            "city": "Minsk",
            "street": "Mira",
            "building": "1",
            "office": "2",
            "zip": "220000",
            "phone": "+375290000000",
            "custom_attributes": {
                "data": [
                    {
                        "key": "signer_name",
                        "value": "Signer"
                    }
                ]
            }
        }
    }
}

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

{
    "data": {
        "id": "789",
        "type": "accounts",
        "attributes": {
            "created_at": "2021-02-11T10:18:19.148+03:00",
            "updated_at": "2021-02-11T10:18:19.180+03:00",
            "reseller_id": 1,
            "name": "Clotilde  Ledner",
            "account_class_id": 2121,
            "primary_name": "",
            "first_name": "Clotilde",
            "middle_name": "",
            "last_name": "Ledner",
            "country": "BY",
            "region": "Minsk",
            "city": "Minsk",
            "street": "Mira",
            "building": "1",
            "office": "2",
            "zip": "220000",
            "phone": "+375290000000",
            "email": "ClotildeLedner@example.com",
            "status": "active",
            "balance": "0.0",
            "usable_balance": "0.0",
            "current_debt": 0.0,
            "subscription_credit_limit": 10000.0,
            "financial_blocking_threshold": 0.0,
            "account_type_id": 1,
            "manager_id": 188,
            "owner_id": 987,
            "tech_user_id": 987,
            "bill_user_id": 987,
            "custom_attributes": {
                "signer_name": "Signer"
            },
            "manager": {
                "created_at": "2017-10-12T15:27:56.354+03:00",
                "updated_at": "2020-08-07T05:32:53.522+03:00",
                "reseller_id": 1,
                "id": 188,
                "name": "Alena R",
                "status": "active",
                "email": "alena87@example.com",
                "role": "sales",
                "phone": null,
                "photo": null,
                "custom_attributes": {
                    "manager": ""
                }
            },
            "owner": {
                "created_at": "2021-02-11T10:18:19.128+03:00",
                "updated_at": "2021-02-11T10:18:19.128+03:00",
                "email": "AlbaStehr@example.com",
                "account_status": "active",
                "global_status": "active",
                "first_name": "Alba",
                "middle_name": "",
                "last_name": "Stehr"
            },
			"account_product_managers": [],
			"self_registration": false,
            "default_payment_model": "postpay",
            "account_type": {
                "id": 1,
                "name": "Personal BLR",
                "created_at": "2016-08-25T09:26:12.658+03:00",
                "updated_at": "2019-10-02T03:30:11.716+03:00",
                "reseller_id": 1,
                "name_pattern": "%first_name %middle_name %last_name",
                "primary_name": "",
                "key": "personalblr",
                "default_payment_method_id": 2,
                "ancestry": null,
                "use_by_default": false
            },
            "account_class": {
                "id": 2121,
                "reseller_id": 1,
                "name": "POSTPAY",
                "created_at": "2019-12-20T08:52:04.909+03:00",
                "updated_at": "2019-12-20T08:59:36.544+03:00",
                "financial_blocking_threshold": "0.0",
                "due_order_period": 15,
                "subzero_period": 1,
                "stop_subscription_type": "automatically",
                "key": "postpaytest",
                "color": "grey",
                "guaranteed_payment_limit": 1000,
                "guaranteed_payment_period": 7,
                "delete_subscription_type": "automatically",
                "denominated": false,
                "buy_with_negative_balance": false,
                "receipt_day": null,
                "payment_model": "postpay",
                "default": false,
                "due_payment_period": 3,
                "subscription_credit_limit": "10000.0"
            }
        },
        "relationships": {
            "subscriptions": {
                "data": []
            }
        }
    }
}