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 |
Пример тела запроса:
{
"name": "Компания Потребитель",
"shortName": "Потребитель",
"contacts": [
{
"name": "Телефон",
"type": "phone",
"value": "+79999999999"
}
],
"customParams": [
{
"name": "msisdn",
"value": "79999999999"
}
]
}После успешного выполнения запроса будет получен ответ с подтверждением, который содержит сохраненные данные и идентификаторы, присвоенные при создании сущности. Значения идентификаторов (clientId; tenantId) будут использоваться в дальнейших шагах бизнес-процесса.
В случае ошибки обработки запроса в ответе будет получен код ошибки, по которому можно определить ее характер и устранить возможную проблему.
Пример ответа:
{
"name": "Компания Потребитель",
"shortName": "Потребитель",
"contacts": [
{
"type": "phone",
"value": "+79999999999"
}
],
"customParams": [
{
"name": "msisdn",
"value": "79999999999"
}
],
"id": "d00a0b00-0000-0000-af00-0caca0bc000d",
"tenantId": "00000fec-000b-0000-a000-ec0b00f0f0e0",
"childs": []
}