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

Клиент − юридическое или физическое лицо, которое является владельцем зарегистрированных устройств в MTС IoT HUB.

Создание клиента необходимо для определения отношения подключенного устройства к клиенту. Доступна возможность создавать множество клиентов и управлять ими.

Для создания клиента необходимо использовать метод POST /front-api-srv/api/v1.1/client. В запросе укажите значения параметров, необходимые для регистрации клиента.

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
name	body	string	+	Наименование клиента	Компания Потребитель
shortName	body	string	-	Краткое наименование клиента	Потребитель
contacts	body	array of objects	-	Контактные данные клиента	-
customParams	body	array of objects	-	Специфичные данные. Заполняется на усмотрение продукта. Будут передаваться с запросами на получение данных клиента и на запрос изменения данных о клиенте. Объем данных не должен превышать 1024 байта	-

object “contacts”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
name	body	string	+	Наименование контактных данных	Телефон
type	body	string	+	Тип контактных данных. Enum: “phone”, “email”	phone
value	body	string	+	Значение контакта	+79999999999

object “customParams”

Параметр	Тип	Тип данных	Обяз.	Описание	Пример
name	body	string	-	Имя параметра дополнительных данных	msisdn
value	body	string	-	Значение параметра дополнительных данных	79999999999

Пример тела запроса:

1
{
2
    "name": "Компания Потребитель",
3
    "shortName": "Потребитель",
4
    "contacts": [
5
        {
6
            "name": "Телефон",
7
            "type": "phone",
8
            "value": "+79999999999"
9
        }
10
    ],
11
    "customParams": [
12
        {
13
            "name": "msisdn",
14
            "value": "79999999999"
15
        }
16
    ]
17
}

После успешного выполнения запроса будет получен ответ с подтверждением, который содержит сохраненные данные и идентификаторы, присвоенные при создании сущности. Значения идентификаторов (clientId; tenantId) будут использоваться в дальнейших шагах бизнес-процесса.

В случае ошибки обработки запроса в ответе будет получен код ошибки, по которому можно определить ее характер и устранить возможную проблему.

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

1
{
2
    "name": "Компания Потребитель",
3
    "shortName": "Потребитель",
4
    "contacts": [
5
        {
6
            "type": "phone",
7
            "value": "+79999999999"
8
        }
9
    ],
10
    "customParams": [
11
        {
12
            "name": "msisdn",
13
            "value": "79999999999"
14
        }
15
    ],
16
    "id": "d00a0b00-0000-0000-af00-0caca0bc000d",
17
    "tenantId": "00000fec-000b-0000-a000-ec0b00f0f0e0",
18
    "childs": []
19
}