Menggunakan API

Dengan token akses di tangan dan panggilan daftar perangkat awal dilakukan, Anda kini siap menggunakan SDM API untuk mengakses dan mengontrol perangkat Anda.

Mencantumkan struktur dan perangkat

Gunakan curl untuk melakukan panggilan GET sederhana ke endpoint structures:

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

Panggilan yang berhasil akan menampilkan daftar struktur untuk akun yang ditautkan ke project Device Access Anda:

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

Jika Anda belum melakukannya, lakukan panggilan GET ke endpoint devices untuk mendapatkan daftar perangkat:

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

Panggilan yang berhasil akan menampilkan daftar perangkat yang ditautkan ke project Device Access Anda. Setiap perangkat memiliki daftar karakteristik uniknya sendiri:

{
  "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"
        }
      ]
    }
  ]
}

Salin device-id untuk setiap perangkat, Anda akan memerlukannya untuk panggilan API lainnya.

Mendapatkan informasi untuk perangkat

Untuk mendapatkan informasi perangkat tertentu, lakukan panggilan GET ke endpoint 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'

Responsnya akan mirip seperti sebelumnya, tetapi hanya untuk perangkat tertentu:

{
  "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"
    }
  ]
}

Jalankan perintah

Setelah memvalidasi akses Anda dengan panggilan GET yang berhasil, coba jalankan perintah bergantung pada jenis perangkat yang telah Anda beri otorisasi:

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" : {}
  }'

Jika panggilan Anda berhasil, hasil berikut akan terjadi:

{}

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

Pemecahan masalah

Tidak diautentikasi

Token akses untuk SDM API hanya valid selama 1 jam. Jika Anda mendapatkan respons UNAUTHENTICATED, kemungkinan masa berlaku token telah berakhir. Gunakan token refresh untuk mendapatkan token akses baru.

Error lainnya

Lihat Referensi Kode Error untuk mengetahui daftar lengkap kode error Device Access .