Как использовать API

Имея токен доступа и выполнив начальный вызов списка устройств, вы теперь готовы использовать API SDM для доступа к своему устройству и управления им.

Перечислите структуры и устройства

Используйте curl для выполнения простого вызова GET к конечной точке structures :

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/structures' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

Успешный вызов возвращает список структур для счетов, связанных с вашимDevice Access проект:

{
  "structures": [
    {
      "name": "enterprises/project-id/structures/structure-id",
      "traits": {
        "sdm.structures.traits.Info": {
          "customName": "structure-name"
        }
      }
    }
  ]
}

Если вы еще этого не сделали, выполните вызов GET к конечной точке devices , чтобы получить список устройств:

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

Успешный вызов возвращает список устройств, подключенных к вашему Device AccessПроект. Каждое устройство имеет свой уникальный список доступных характеристик:

{
  "devices": [
    {
      "name": "enterprises/project-id/devices/device-id",
      "type": "sdm.devices.types.device-type",
      "traits": { ... },
      "parentRelations": [
        {
          "parent": "enterprises/project-id/structures/structure-id/rooms/room-id",
          "displayName": "device-room-name"
        }
      ]
    }
  ]
}

Скопируйте device-id для каждого устройства, он понадобится вам для других вызовов API.

Получить информацию об устройстве

Чтобы получить информацию о конкретном устройстве, выполните вызов GET к конечной точке device-id :

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

Ответ должен быть аналогичен предыдущему, но только для конкретного устройства:

{
  "name": "enterprises/project-id/devices/device-id",
  "type": "sdm.devices.types.device-type",
  "traits": { ... },
  "parentRelations": [
    {
      "parent": "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName": "device-room-name"
    }
  ]
}

Выполнить команду

После подтверждения доступа с помощью успешного вызова GET попробуйте выполнить команду в зависимости от типа авторизованного вами устройства:

curl -X POST \
  'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id:executeCommand' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer access-token' \
  --data-raw '{
    "command" : "sdm.devices.commands.ThermostatMode.SetMode",
    "params" : {
      "mode" : "HEAT"
    }
  }'

curl -X POST \
  'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id:executeCommand' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer access-token' \
  --data-raw '{
    "command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
    "params" : {}
  }'

Если ваш звонок успешен, произойдет следующее:

{}

{
  "results" : {
    "streamUrls" : {
      "rtspUrl" : "rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken"
    },
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
    "streamToken" : "g.0.streamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

Поиск неисправностей

Неаутентифицированный

Токены доступа для API SDM действительны только в течение 1 часа. Если вы получили ответ «НЕАУТЕНТИФИКАЦИЯ», вероятно, срок действия токена истёк. Используйте токен обновления , чтобы получить новый токен доступа.

Другие ошибки

Полный список кодов ошибок см. в справочнике кодов ошибок. Device Access коды ошибок.