Referensi Nest API

Nest API membuat model rumah atau bangunan fisik sebagai struktur, dengan Nest Learning Thermostat, Nest Protect, dan Nest Cam sebagai perangkat dalam struktur. Struktur ini juga berisi informasi tentang rumah secara keseluruhan (seperti status Pergi atau PWT, atau Jam Sibuk aktif).

Setiap elemen data dalam strukturnya dapat diberi alamat oleh URL resource (disebut "lokasi data") dalam dokumen JSON bersama. Setiap lokasi data dapat menyimpan string, angka, boolean, objek induk/turunan, atau array.

Jelajahi model data dengan Referensi API interaktif ini.

Dari API, Anda dapat menyinkronkan data dari lokasi di beberapa tingkat dalam model data, misalnya:

  • keseluruhan struktur, termasuk semua perangkat
  • satu perangkat dalam struktur
  • sekelompok nilai data (suhu saat ini dan ruangan)
  • nilai data tunggal (status kesehatan baterai)

Produk Anda harus merespons dengan cermat peristiwa seperti ini:

  • kehadiran (di rumah dan pergi)
  • safety (asap dan karbon monoksida)
  • penggunaan energi selama waktu yang mahal dalam sehari
  • peristiwa (suara dan gerakan)

Namun, perhatikan bahwa setiap objek berbasis perangkat bekerja di bawah batasan dunia nyata. Misalnya, termostat tidak boleh menjalankan AC saat panas darurat diaktifkan. API kami dirancang untuk mengamankan perangkat kami dan rumah pengguna, dan akan mencegah tindakan tertentu jika hal tersebut mengejutkan atau berbahaya.

Izin dan data perangkat bersama

Kemampuan untuk membaca atau menulis ke lokasi data dikontrol oleh izin. Grup izin menyediakan akses baca, tulis, atau baca/tulis ke nilai data yang dipilih di perangkat dan struktur.

Untuk mengetahui informasi selengkapnya, baca Ringkasan Izin.

Data dan privasi

Data yang terkait dengan produk rumah tangga bisa sangat pribadi. Data sensor rumah berisi informasi tentang cara orang menjalani kehidupan di ruang pribadi mereka. Keamanan dan penanganan data tersebut sangat penting, dan merupakan fokus yang signifikan di Nest. Kami memperjelas kepada pengguna jenis data apa yang kami miliki, cara data tersebut digunakan, dan di mana mereka dapat mengontrolnya.

Pelajari tampilan kami tentang privasi lebih lanjut.

Metadata

Metadata adalah informasi tambahan yang disediakan saat Anda melakukan panggilan ke endpoint tingkat root:

https://developer-api.nest.com/

access_token

Setelah otorisasi pengguna, produk Anda menggunakan token akses untuk melakukan panggilan API ke layanan Nest. Token akses ini berfungsi sebagai bukti bahwa pengguna telah mengizinkan produk Anda untuk melakukan panggilan atas nama pengguna.

Detail
Menampilkanstring
Contoh: "c.FmDPkzyzaQe..."

versi_klien

Versi klien adalah versi klien terakhir yang diberi otorisasi oleh pengguna, dan dikaitkan dengan access_token.

Saat Anda memperbarui izin untuk klien, versi klien akan bertambah, dan pengguna akan diberi tahu bahwa update tersedia. Pengguna harus menyetujui update klien ini sebelum dapat menggunakan produk yang diperbarui.

Detail
Menampilkannumber
Contoh: 1, 17, 42

user_id

User ID memungkinkan Anda mengidentifikasi pengguna di seluruh panggilan API. ID ini berbeda untuk setiap kombinasi Works with Nest dan pengguna.

Misalnya, jika pengguna 1 telah memberi otorisasi Kompatibel dengan produk Nest A dan Kompatibel dengan produk Nest B, produk A memiliki satu nilai user_id untuk pengguna 1, dan produk B memiliki nilai user_id yang berbeda untuk pengguna 1.

Detail
Menampilkanstring
Contoh: z.1.1.7DHps...