Memberi Otorisasi pada Akun

Setelah project Google Cloud dan Akses Perangkat Anda dibuat, Anda dapat mengotorisasi Akun Google dengan perangkat Google Nest yang didukung untuk SDM API.

Untuk melihat struktur dan perangkat, Anda harus menautkan Akun Google ke Device Access project menggunakan PCM. PCM memungkinkan user memberikan izin kepada developeruntuk mengakses data perangkat dan struktur mereka.

Dalam panduan ini, Anda berperan sebagai user dan developer.

  1. Buka link berikut di browser web, dengan mengganti:

    1. project-id dengan Device Access Project ID Anda
    2. oauth2-client-id dengan Client ID OAuth2 dari Google Cloud Credentials
    https://nestservices.google.com/partnerconnections/project-id/auth?redirect_uri=https://www.google.com&access_type=offline&prompt=consent&client_id=oauth2-client-id&response_type=code&scope=https://www.googleapis.com/auth/sdm.service
  2. Jika Anda baru-baru ini login ke Google dengan beberapa akun, Anda mungkin melihat layar Pilih akun awal dengan daftar Akun Google Anda. Jika ya, pilih Akun Google yang terkait dengan perangkat yang ingin Anda beri otorisasi untuk Device Access.
  3. Layar izin Google Nest adalah PCM itu sendiri. Di sini, Anda dapat memberikan izin struktur dan perangkat. Aktifkan izin untuk rumah Anda (Langkah 1) dan perangkat apa pun di rumah tersebut yang didukung oleh SDM API (Langkah 2), lalu klik Berikutnya.
  4. Di layar Choose an account to continue to Project Name, dengan Project Name adalah nama project Google Cloud Anda, pilih akun Google yang ingin Anda beri otorisasi untuk SDM API. Gunakan Akun Google yang sama seperti sebelumnya.
  5. Setelah memilih akun, Anda mungkin melihat layar peringatan yang menyatakan bahwa Google belum memverifikasi aplikasi ini. Jika demikian, untuk melanjutkan, klik opsi Lanjutan, lalu klik Buka Nama Project (tidak aman). Lihat Google belum memverifikasi aplikasi ini untuk mengetahui informasi selengkapnya.
  6. Di layar Berikan izin Nama Project, klik Izinkan untuk memberikan izin project mengakses Akun Google Anda.
  7. Di layar Konfirmasi pilihan Anda, pastikan izin yang ingin Anda berikan dicentang, lalu klik Izinkan untuk mengonfirmasi.

  8. Anda akan dialihkan ke https://www.google.com. Kode Otorisasi ditampilkan sebagai parameter code di URL, yang harus dalam format ini:

    https://www.google.com?code=authorization-code&scope=https://www.googleapis.com/auth/sdm.service
  9. Salin kode otorisasi.

Mendapatkan token akses

Gunakan kode otorisasi untuk mengambil token akses, yang dapat Anda gunakan untuk memanggil SDM API.

  1. Buka terminal dan jalankan perintah curl berikut, dengan mengganti:

    1. oauth2-client-id dan oauth2-client-secret dengan Client ID dan Secret Klien OAuth2 dari Kredensial Google Cloud
    2. authorization-code dengan kode yang Anda terima pada langkah sebelumnya
    curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&code=authorization-code&grant_type=authorization_code&redirect_uri=https://www.google.com'

  2. Google OAuth menampilkan dua token, token akses dan token refresh.

    {
  "access_token": "access-token",
  "expires_in": 3599,
  "refresh_token": "refresh-token",
  "scope": "https://www.googleapis.com/auth/sdm.service",
  "token_type": "Bearer"
}
     Salin kedua nilai ini. Token akses digunakan untuk memanggil SDM API dan token refresh digunakan untuk mendapatkan token akses baru.

Melakukan panggilan daftar perangkat

Otorisasi belum selesai hingga Anda melakukan panggilan devices.list pertama dengan token akses baru. Panggilan awal ini menyelesaikan proses otorisasi dan mengaktifkan peristiwa jika Anda telah menyiapkan langganan Pub/Sub.

Gunakan curl untuk melakukan panggilan ini untuk endpoint devices:

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 uniknya sendiri yang berisi sifat yang tersedia:

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

Cara menggunakan token refresh

Token akses untuk SDM API hanya berlaku selama 1 jam, seperti yang tercantum dalam parameter expires_in yang ditampilkan oleh Google OAuth. Jika masa berlaku token akses Anda habis, gunakan token refresh untuk mendapatkan token baru.

Perintah ini mirip dengan perintah token akses, kecuali Anda menggunakan grant_type yang berbeda.

  1. Buka terminal dan jalankan perintah curl berikut, dengan mengganti:

    1. oauth2-client-id dan oauth2-client-secret dengan Client ID dan Secret Klien OAuth2 dari Kredensial Google Cloud
    2. refresh-token dengan kode yang Anda terima saat pertama kali mendapatkan token akses.
    curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&refresh_token=refresh-token&grant_type=refresh_token'

  2. Google OAuth menampilkan token akses baru.

    {
  "access_token": "new-access-token",
  "expires_in": 3599,
  "scope": "https://www.googleapis.com/auth/sdm.service",
  "token_type": "Bearer"
}

Pemecahan masalah

Untuk mempelajari lebih lanjut Google OAuth, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.

Token refresh terus habis masa berlakunya

Token refresh dapat berhenti berfungsi setelah 7 hari jika ID klien tidak disetujui adalah salah satu kemungkinan penyebabnya. Masa berlaku token 7 hari tidak terkait dengan persetujuan Komersial atau Sandbox. Akun layanan atau pengguna harus mendapatkan persetujuan dan diaktifkan client ID OAuth 2.0-nya untuk mendapatkan masa aktif token yang lebih lama. Lihat Masa berlaku token refresh untuk mengetahui informasi selengkapnya.

Akses ditolak

Jika Anda telah menyiapkan layar izin OAuth di Google Cloud dan Jenis pengguna adalah Eksternal, Anda akan mendapatkan error "Akses ditolak" jika mencoba menautkan akun dengan Akun Google yang tidak tercantum sebagai pengguna uji coba untuk aplikasi Anda. Pastikan untuk menambahkan Akun Google ke bagian Pengguna uji coba di layar izin OAuth.

Error Partner Connections Manager (PCM)

Untuk mendapatkan bantuan terkait error yang terjadi saat mengakses PCM, lihat Referensi Error Partner Connections Manager (PCM).

Google belum memverifikasi aplikasi ini

SDM API menggunakan cakupan terbatas, yang berarti bahwa setiap aplikasi yang menggunakan cakupan ini selama otorisasi akan "belum diverifikasi", kecuali jika Verifikasi API OAuth telah diselesaikan. Saat menggunakan Device Access untuk penggunaan pribadi, Verifikasi API OAuth tidak diperlukan.

Anda mungkin melihat layar "Google belum memverifikasi aplikasi ini" selama proses otorisasi, yang muncul jika cakupan sdm.service tidak dikonfigurasi di layar izin OAuth Anda di Google Cloud. Layar ini dapat dilewati dengan mengklik opsi Lanjutan, lalu mengklik Buka Project Name (tidak aman).

Lihat Layar aplikasi tidak terverifikasi untuk informasi selengkapnya.

Klien tidak valid

Saat mencoba mendapatkan token akses atau refresh, Anda akan mendapatkan error "Invalid client" jika memberikan Rahasia Klien OAuth 2.0 yang salah. Pastikan nilai client_secret yang Anda gunakan dalam panggilan token akses dan token refresh adalah nilai untuk Client ID OAuth 2.0 yang digunakan, seperti yang ditemukan di halaman Google Cloud Credentials Anda.

Permintaan tidak valid, cakupan wajib tidak ada

Setelah memberikan izin di PCM, Anda mungkin mengalami error "Permintaan tidak valid" "Parameter wajib tidak ada: cakupan". Pastikan nilai scope yang Anda gunakan dalam panggilan otorisasi sama dengan yang Anda tetapkan untuk Klien OAuth 2.0, seperti yang ada di halaman Google Cloud Credentials.

URI pengalihan tidak cocok

Saat melakukan otorisasi, Anda mungkin mengalami error "Redirect uri mismatch". Pastikan nilai redirect_uri yang Anda gunakan dalam panggilan otorisasi sama dengan yang Anda tetapkan untuk Klien OAuth 2.0, seperti yang ditemukan di halaman Kredensial Google Cloud.

Mengubah izin akun

Untuk mengubah izin yang diberikan ke project Device Access , atau memutuskan koneksinya sepenuhnya, buka PCM:

https://nestservices.google.com/partnerconnections

Halaman ini menampilkan semua layanan developer pihak ketiga (Device Access project) yang terhubung ke akun Anda. Pilih project Device Access yang ingin Anda ubah. Gunakan layar berikutnya untuk mengubah izin sesuai keinginan.

Untuk mencabut hanya izin tertentu untuk layanan yang diberi otorisasi, alihkan izin yang ingin Anda cabut dan klik panah kembali untuk menyimpan.

Untuk menghentikan hubungan akun layanan yang diberi otorisasi sepenuhnya, klik Batalkan tautan Akun Google Anda untuk mencabut semua izin dan token akses yang telah diberikan project untuk akun tersebut.

Jika PCM tidak menampilkan layanan yang diinginkan, Anda mungkin perlu melakukan panggilan daftar perangkat terlebih dahulu.

Referensi cepat

Gunakan referensi ini untuk menerapkan langkah-langkah dengan cepat guna memberi otorisasi kepada user dan menautkan Akun Google mereka .

Untuk menggunakan referensi cepat ini, edit setiap variabel placeholder dalam contoh kode dengan nilai untuk integrasi spesifik Anda, lalu salin dan tempel sesuai kebutuhan:

1 PCM

Buka link berikut di browser web, dengan mengganti:

  1. project-id dengan Device Access Project ID Anda
  2. oauth2-client-id dengan Client ID OAuth2 dari Google Cloud Credentials
https://nestservices.google.com/partnerconnections/project-id/auth?redirect_uri=https://www.google.com&access_type=offline&prompt=consent&client_id=oauth2-client-id&response_type=code&scope=https://www.googleapis.com/auth/sdm.service

2 Kode Auth

Anda akan dialihkan ke https://www.google.com. Kode Otorisasi ditampilkan sebagai parameter code di URL, yang harus dalam format ini:

https://www.google.com?code=authorization-code&scope=https://www.googleapis.com/auth/sdm.service

3 Token Akses

Gunakan kode otorisasi untuk mengambil token akses, yang dapat Anda gunakan untuk memanggil SDM API.

Buka terminal dan jalankan perintah curl berikut, dengan mengganti:

  1. oauth2-client-id dan oauth2-client-secret dengan Client ID dan Secret Klien OAuth2 dari Kredensial Google Cloud
  2. authorization-code dengan kode yang Anda terima pada langkah sebelumnya

Google OAuth menampilkan dua token, token akses dan token refresh.

Permintaan

curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&code=authorization-code&grant_type=authorization_code&redirect_uri=https://www.google.com'

Respons

{
  "access_token": "access-token",
  "expires_in": 3599,
  "refresh_token": "refresh-token",
  "scope": "https://www.googleapis.com/auth/sdm.service",
  "token_type": "Bearer"
}

4 Panggilan API

Otorisasi belum selesai hingga Anda melakukan panggilan devices.list pertama dengan token akses baru. Panggilan awal ini menyelesaikan proses otorisasi dan mengaktifkan peristiwa jika Anda telah menyiapkan langganan Pub/Sub.

Anda harus menggunakan salah satu panggilan API yang tercantum untuk cakupan yang ditentukan guna menyelesaikan otorisasi.

sdm.service

perangkat

Lihat referensi API devices.list untuk mengetahui informasi selengkapnya.

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

5 Token Refresh

Token akses untuk SDM API hanya berlaku selama 1 jam, seperti yang tercantum dalam parameter expires_in yang ditampilkan oleh Google OAuth. Jika masa berlaku token akses Anda habis, gunakan token refresh untuk mendapatkan token baru.

Buka terminal dan jalankan perintah curl berikut, dengan mengganti:

  1. oauth2-client-id dan oauth2-client-secret dengan Client ID dan Secret Klien OAuth2 dari Kredensial Google Cloud
  2. refresh-token dengan kode yang Anda terima saat pertama kali mendapatkan token akses.

Google OAuth menampilkan token akses baru.

Permintaan

curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&refresh_token=refresh-token&grant_type=refresh_token'

Tanggapan

{
  "access_token": "new-access-token",
  "expires_in": 3599,
  "scope": "https://www.googleapis.com/auth/sdm.service",
  "token_type": "Bearer"
}
Sebelumnya
1. Memulai
Berikutnya
3. Menggunakan API