เอกสารอ้างอิง API ของ Nest

Nest API จําลองโครงสร้างของบ้านหรืออาคารเป็นโครงสร้าง โดยมี Nest Learning Learning Thermostat, Nest Protect และ Nest Cam เป็นอุปกรณ์ในโครงสร้าง โครงสร้างนี้มีข้อมูลเกี่ยวกับบ้านโดยรวม (เช่น โหมด "ไม่อยู่บ้าน" หรือ "เวลาถึงโดยประมาณ" หรือ Rush Hour ที่ใช้งานอยู่)

องค์ประกอบข้อมูลทั้งหมดในโครงสร้างจะจัดการได้ด้วย URL ทรัพยากร (เรียกว่า&&tt;ตําแหน่งข้อมูล") ในเอกสาร JSON ที่แชร์ ตําแหน่งข้อมูลแต่ละแห่งจะจัดเก็บสตริง ตัวเลข บูลีน ออบเจ็กต์หลัก/ย่อย หรืออาร์เรย์ได้

สํารวจโมเดลข้อมูลด้วยเอกสารอ้างอิง API แบบอินเทอร์แอกทีฟนี้

จาก API คุณจะซิงค์ข้อมูลจากสถานที่ต่างๆ ได้หลายระดับในโมเดลข้อมูล เช่น

  • โครงสร้างทั้งหมด รวมถึงอุปกรณ์ทั้งหมด
  • อุปกรณ์เดียวในโครงสร้าง
  • กลุ่มค่าข้อมูล (อุณหภูมิปัจจุบันและอุณหภูมิแวดล้อม)
  • ค่าข้อมูลเดียว (สถานะแบตเตอรี่)

ผลิตภัณฑ์ควรตอบสนองต่อกิจกรรมต่อไปนี้อย่างรอบคอบ

แต่อย่าลืมว่า ออบเจ็กต์ตามอุปกรณ์แต่ละรายการจะทํางานภายใต้ข้อจํากัดในชีวิตจริง เช่น ตัวควบคุมอุณหภูมิไม่ควรเรียกใช้เครื่องปรับอากาศเมื่อเปิดใช้เครื่องทําความร้อนฉุกเฉิน API ของเราถูกออกแบบมาเพื่อป้องกันทั้งอุปกรณ์และบ้านของผู้ใช้ และจะป้องกันไม่ให้มีการดําเนินการบางอย่างหากจะทําให้ตกใจหรือเป็นอันตราย

สิทธิ์และข้อมูลอุปกรณ์ที่แชร์

ความสามารถในการอ่านหรือเขียนไปยังตําแหน่งข้อมูลจะควบคุมโดยสิทธิ์ กลุ่มสิทธิ์จะมอบสิทธิ์การอ่าน เขียน หรืออ่าน/เขียนให้กับค่าข้อมูลที่เลือกในอุปกรณ์และโครงสร้าง

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมสิทธิ์

ข้อมูลและความเป็นส่วนตัว

ข้อมูลที่เกี่ยวข้องกับผลิตภัณฑ์สําหรับบ้านอาจมีความเป็นส่วนตัว ข้อมูลเซ็นเซอร์ในบ้านมีข้อมูลเกี่ยวกับการใช้ชีวิตในพื้นที่ส่วนตัว การรักษาความปลอดภัยและการจัดการข้อมูลนั้นสําคัญมากและเป็นจุดโฟกัสที่ Nest อย่างมาก เราแจ้งให้ผู้ใช้ทราบอย่างชัดเจนว่าเรามีข้อมูลประเภทใด นําข้อมูลไปใช้อย่างไร และควบคุมได้ที่ไหน

ดูข้อมูลเพิ่มเติมเกี่ยวกับมุมมองเกี่ยวกับความเป็นส่วนตัวของเรา

ข้อมูลเมตา

ข้อมูลเมตาเป็นข้อมูลเพิ่มเติมที่ได้เมื่อเรียกใช้ปลายทางระดับราก

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

การเข้าถึงโทเค็น

หลังจากที่ผู้ใช้ให้สิทธิ์แล้ว ผลิตภัณฑ์ของคุณจะใช้โทเค็นเพื่อการเข้าถึงเพื่อเรียก API ไปยังบริการ Nest โทเค็นเพื่อการเข้าถึงนี้ใช้เป็นหลักฐานว่าผู้ใช้ได้ให้สิทธิ์ผลิตภัณฑ์ของคุณโทรออกในนามของผู้ใช้

รายละเอียด
การคืนสินค้าstring
ตัวอย่าง: "c.FmDPkzyzaQe..."

เวอร์ชันของไคลเอ็นต์

เวอร์ชันไคลเอ็นต์คือไคลเอ็นต์เวอร์ชันสุดท้ายที่ผู้ใช้สร้างขึ้น และเชื่อมโยงกับ access_token

เมื่อคุณอัปเดตสิทธิ์ให้ไคลเอ็นต์ เวอร์ชันไคลเอ็นต์จะเพิ่มขึ้นและผู้ใช้จะได้รับแจ้งว่ามีการอัปเดต ผู้ใช้ต้องยอมรับการอัปเดตไคลเอ็นต์นี้ก่อนจึงจะใช้ผลิตภัณฑ์ที่อัปเดตได้

รายละเอียด
การคืนสินค้าnumber
ตัวอย่าง: 1, 17, 42

user_id

User ID ช่วยให้คุณระบุผู้ใช้ในการเรียก API ได้ ตัวระบุนี้จะแตกต่างกันไปตามชุดผลิตภัณฑ์ Works with Nest แต่ละรายการและผู้ใช้

เช่น หากผู้ใช้ 1 ให้สิทธิ์ผลิตภัณฑ์ Works with Nest A และใช้งานได้กับผลิตภัณฑ์ Nest B

รายละเอียด
การคืนสินค้าstring
ตัวอย่าง: z.1.1.7DHps...