Протокол программного управления устройствами
С помощью данного API пользователь может самостоятельно автоматизировать управление устройствами, подключенными к платформе умного дома Яндекса.
Для пользовательских приложений поддерживается управление устройствами, группами и сценариями.
Хост для всех запросов к API: https://api.iot.yandex.net
| Метод | Ресурс | OAuth scope | Описание |
|---|---|---|---|
| GET | /v1.0/user/info | iot:view | Получение полной информации об умном доме пользователя |
| GET | /v1.0/devices/{device_id} | iot:view | Получение информации о состоянии устройства |
| POST | /v1.0/devices/actions | iot:control | Управление умениями устройств |
| GET | /v1.0/groups/{group_id} | iot:view | Получение информации о состоянии группы устройств |
| POST | /v1.0/groups/{group_id}/actions | iot:control | Управление умениями группы устройств |
| POST | /v1.0/scenarios/{scenario_id}/actions | iot:control | Управление запуском сценария |
| DELETE | /v1.0/devices/{device_id} | iot:control | Удаление пользовательского устройства |
| Метод | Ресурс | OAuth scope | Описание |
|---|---|---|---|
| GET | /v1.0/user/info | iot:view | Получение полной информации об умном доме пользователя |
| GET | /v1.0/devices/{device_id} | iot:view | Получение информации о состоянии устройства |
| POST | /v1.0/devices/actions | iot:control | Управление умениями устройств |
| GET | /v1.0/groups/{group_id} | iot:view | Получение информации о состоянии группы устройств |
| POST | /v1.0/groups/{group_id}/actions | iot:control | Управление умениями группы устройств |
| POST | /v1.0/scenarios/{scenario_id}/actions | iot:control | Управление запуском сценария |
| DELETE | /v1.0/devices/{device_id} | iot:control | Удаление пользовательского устройства |
Доступ и авторизация
Для использования API платформы необходимо зарегистрировать приложение на сервере авторизации Яндекс OAuth и запросить необходимые доступы для устройств умного дома (iot:view, iot:control).
После того, как пользователь дал приложению необходимые доступы, его токен можно использовать для запросов к API платформы умного дома. Токен необходимо указывать в каждом запросе к API в заголовке Authorization:
curl -i -X GET 'https://api.iot.yandex.net/v1.0/user/info' \
-H 'Authorization: Bearer YOUR_OAUTH_TOKEN'Больше о том, как запрашивать разрешение пользователя на доступ к данным, читайте в документации по OAuth-авторизации.
