Передача состояния устройств (post state)

Вендор уведомляет умный дом Sber об изменении состояния устройства пользователя.

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

  1. Состояние функции устройства по какой-то причине изменилось. Например, лампочку отключили от электричества или изменили ее цвет в приложении вендора.
  2. Вендор уведомляет умный дом Sber об изменении состояния устройства.
  3. Умный дом Sber меняет состояние устройства в приложении Салют, на SberPortal, SberBox и других устройствах с ассистентами Салют.

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

Вендор отправляет уведомление на эндпоинт умного дома Sber: https://partners.iot.sberdevices.ru/. Заголовки см. в разделе Заголовки запросов.

POST /v1/state

Тело запроса:

Поле Тип Обязательное? Описание
devices dict<string, object> ✔︎ Устройства, состояние которых изменилось. Для каждого устройства передаются ID устройства в системе вендора и состояние его функций
ID <string> ✔︎ ID устройства в системе вендора
states list<object> ✔︎ Список состояний функций (см. Состояние устройства (state))
{
    "devices": {
        "id": {
            "states": [
                 {
                     "key": string,
                     "value": {
                         "type": string,
                         "type_value": object
                     }
                 },
                 {
                     // ...
                 }
           ]
        }
    }
}

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

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

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

HTTP/1.1 200 OK

При возникновении ошибки умный дом может возвращать:

  • Список errors, содержащий объекты error. Каждый объект указывает на конкретные устройства, обновить состояние которых не удалось.
  • Общую ошибку common error. Описывает проблему в целом и отправляется, только если проблему не удалось соотнести с конкретными устройствами.

Если вендор уведомил о состоянии нескольких устройств, и состояние части из них умный дом смог обновить, а при обновлении остальных произошла ошибка, умный дом отправит ответ с ошибкой — в нем будет список устройств с необновленными состояниями.

Ошибка конкретного устройства:

{
    "errors": [
        {
            "id": string,
            "code": integer,
            "message": string
        }
    ]
}

Общая ошибка:

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

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

Вендор уведомляет об изменении состояния функций online и on_off розетки.

Запрос:

curl -i -X POST /v1/devices HTTP/1.1 \
-H Host: example.com \
-H Content-Type: application/json \
-H Authorization: Bearer qwerty-1234-... \
-H X-Request-Id: abcd-0000-ifgh-...
{
    "devices": {
        "ABCD_003": {
            "states": [
                {
                    "key": "online",
                    "value": {
                        "type": "BOOL",
                        "bool_value": true
                    }
                },
                {
                    "key": "on_off",
                    "value": {
                        "type": "BOOL",
                        "bool_value": true
                    }
                }
            ]
        }
    }
}

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

HTTP/1.1 200 OK

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

{
    "errors": [
        {
            "id": "ABCD_003",
            "code": 500,
            "message": "System error"
        }
    ]
}

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней