Удаление устройств пользователя (delete devices)

Вендор сообщает умному дому Sber, что пользователь удалил одно или несколько устройств.

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

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

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

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

DELETE /v1/devices

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

Поле Тип Обязательное? Описание
device_ids list<string> ✔︎ Список идентификаторов удаленных устройств
{
    "device_ids": [
        "device1_id": string,
        "device2_id": string
    ]
}

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

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

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

 HTTP/1.1 200 OK

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

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

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

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

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

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

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

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

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

Запрос:

curl -i -X DELETE /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-...
{
    "device_ids": [
        "ABCD_011",
        "ABCD_013"
    ]
}

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

HTTP/1.1 200 OK

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

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

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

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