Получение категорий устройств (get categories)

Обновлено 25 ноября 2022

Приложение-агент на контроллере отправляет в умный дом Sber запрос на получение перечня поддерживаемых умным домом категорий устройств.

Пример ситуации использования:

1. При загрузке агент отрисовывает контрол — выпадающий список поддерживаемых категорий устройств. Чтобы наполнить список, агент отправляет в умный дом Sber запрос на получение перечня поддерживаемых категорий.
2. Умный дом Sber возвращает список категорий.
3. Приложение-агент отрисовывает выпадающий список с актуальным перечнем поддерживаемых категорий.

Формат запроса

Запрос отправляется на эндпоинт информационного API — адрес этого эндпоинта приходит в сообщении с глобальной конфигурацией. Заголовки см. в разделе Заголовки запросов.

GET /v1/mqtt-gate/categories

Формат ответа

Умный дом Sber отправляет ответ приложению-агенту. Заголовки см. в разделе Заголовки запросов.

Успешный ответ:

Поле	Тип	Обязательное?	Описание
categories	list<string>	✔︎	Список доступных категорий устройств (см. Описание устройств)

{
    "categories": [
        "category": string,
        // ...
    ]
}

При возникновении ошибки возвращается объект типа common error:

{
    "code": integer,
    "message": string,
    "details": list<string>
}

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

Приложение-агент запрашивает список поддерживаемых умным домом категорий устройств. Умный дом Sber возвращает две категории: светодиодные ленты и лампы.

Запрос:

curl -i -X GET /v1/mqtt-gate/categories HTTP/1.1 \
-H Host: example.com \
-H Content-Type: application/json \
-H Authorization: Basic qwerty-1234-... \
-H X-Request-Id: abcd-0000-ifgh-...

Успешный ответ:

{
    "categories": [
        "led_strip",
        "light"
    ]
}

Ответ с ошибкой:

{
    "code": 500,
    "message": "Internal server error",
    "details": []
}