واجهة برمجة تطبيقات البنية

يمكن للمستخدمين إضافة ثلاث تركيبات كحد أقصى، مع أجهزة متعددة لكل بنية.

تتوفّر جميع القيم الواردة أدناه ضمن كل structures/structure_id في مستند JSON.

معرّف_البنية

رقم تعريف البنية عند استدعاء موقع البيانات هذا، يمكنك الوصول إلى قيم البيانات في هذه البنية.

التفاصيل
https://developer-api.nest.com/structures/structure_id/structure_id
المرتجعاتstring
مثال: "VqFabWH21nw..."
الوصولللقراءة فقط
متوفّر فيقراءة الترموستات / v1-v6
الترموستات للقراءة/الكتابة / v1-v6
الدخان+أول أكسيد الكربون / v1-v5
القراءة عن بُعد / v1-v2
القراءة/الكتابة / v1-v2
الكتابة للقراءة / v1-v2
قراءة الرمز البريدي / قراءة الفيديو / 1-الإصدار 1- قراءة الصور / 1-الإصدار 3

جهاز ترموستات

قائمة بأجهزة الترموستات في البنية حسب معرّف الجهاز الفريد هذه مصفوفة من كائنات JSON تتضمن جميع أجهزة الترموستات في البنية.

التفاصيل
https://developer-api.nest.com/structures/structure_id/thermostats
المرتجعاتarray
مثال: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
الوصولللقراءة فقط
متوفّر فيقراءة الترموستات / v1-v6
الترموستات للقراءة/الكتابة / v1-v6
قراءة الدخان+أول أكسيد الكربون / v1-v5
القراءة عن بعد / v1-v2
القراءة/الكتابة / v1-v2
الكتابة أثناء الكتابة / v1-v2
قراءة الكاميرا / v2-v3
قراءة الكاميرا/الإصدار 2/الإصدار 2/الإصدار 2

منبّهات_الدخان

قائمة بإنذارات الدخان وأول أكسيد الكربون في البنية حسب معرّف الجهاز الفريد. هذه مصفوفة من كائنات JSON تتضمن جميع إنذارات الدخان وأول أكسيد الكربون في البنية.

التفاصيل
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms
المرتجعاتarray
مثال: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
الوصولللقراءة فقط
متوفّر فيقراءة الترموستات / v1-v6
الترموستات للقراءة/الكتابة / v1-v6
قراءة الدخان+أول أكسيد الكربون / v1-v5
القراءة عن بعد / v1-v2
القراءة/الكتابة / v1-v2
الكتابة أثناء الكتابة / v1-v2
قراءة الكاميرا / v2-v3
قراءة الكاميرا/الإصدار 2/الإصدار 2/الإصدار 2

كاميرا

قائمة الكاميرات في البنية، حسب معرّف الجهاز الفريد. وهذه مصفوفة من كائنات JSON تتضمن كل الكاميرات في البنية.

التفاصيل
https://developer-api.nest.com/structures/structure_id/cameras
المرتجعاتarray
مثال: [ "awJo6rH...",... ]
الوصولللقراءة فقط
متوفّر فيقراءة الترموستات / الإصدار 4-v6
الترموستات للقراءة/الكتابة / v4-v6
الدخان+أول أكسيد الكربون / v4-v5
القراءة عن بُعد / v2
القراءة/الكتابة / v2
الكتابة النصية / الإصدار 2
القراءة بالكاميرا / الإصدار 1-v3
قراءة الكاميرا + الصور / الإصدار 1-v4
قراءة الصور/الإصدار 1/الإصدار 3+

بَعِيدًا

يشير إلى حالة الإشغال للبنية.

لدى الهيكل حالتان مرتبطتان بالحضور: home أو away. عندما لا تستشعر أجهزة استشعار الحركة في المنزل، ستتغيّر البنية من home إلى away.

التفاصيل
https://developer-api.nest.com/structures/structure_id/away
المرتجعاتstring
القيم: "home", "away"
الوصولالقراءة/الكتابة
متوفّر فيالقراءة:
الترموستات للقراءة / v1-v6
قراءة ترموستات/كتابة / v1-v6
قراءة الدخان+أول أكسيد الكربون / v1-v5
القراءة Away / v1-v2
القراءة/الكتابة / v1-v2
الكتابة v1/v2/الإصدار 1-

الاسم

الاسم المعروض للبنية من تحديد المستخدم.

التفاصيل
https://developer-api.nest.com/structures/structure_id/name
المرتجعاتstring
أمثلة: "&الصفحة الرئيسية"، "&الصفحة الرئيسية"، "&منزل، البحر"&، "&"
الوصولالقراءة/الكتابة
متوفّر فيللقراءة:
قراءة الملفات

رمز_البلد

رمز البلد، بتنسيق ISO 3166 alpha-2.

التفاصيل
https://developer-api.nest.com/structures/structure_id/country_code
المرتجعاتstring
أمثلة: "US", "CA", "UK"
الوصولللقراءة فقط
متوفّر فيقراءة الترموستات / v1-v6
الترموستات للقراءة/الكتابة / v1-v6
قراءة الدخان + x

الرمز_البريدي

الرمز البريدي حسب البلد

التفاصيل
https://developer-api.nest.com/structures/structure_id/postal_code
المرتجعاتstring
أمثلة: "94304", "94304-1027", "EC1A 1BB"
الوصولللقراءة فقط
متوفّر فيقراءة الرمز البريدي / الإصدار 1-v2

قمة_المدة_بدء_الوقت

تمثّل هذه السمة وقت بدء حدث ساعة الذروة بتنسيق ISO 8601.

التفاصيل
https://developer-api.nest.com/structures/structure_id/peak_period_start_time
المرتجعاتstring
مثال: "2016-12-31T23:59:59.000Z"
الوصولللقراءة فقط
متوفّر فيقراءة الترموستات / الإصدار 1-v6
الترموستات للقراءة/الكتابة / v1-v6
قراءة الطاقة / v1-v2

وقت الذروة

تمثّل هذه السمة وقت انتهاء حدث ساعة الذروة بتنسيق ISO 8601.

التفاصيل
https://developer-api.nest.com/structures/structure_id/peak_period_end_time
المرتجعاتstring
مثال: "2016-12-31T23:59:59.000Z"
الوصولللقراءة فقط
متوفّر فيقراءة الترموستات / الإصدار 1-v6
الترموستات للقراءة/الكتابة / v1-v6
قراءة الطاقة / v1-v2

المنطقة الزمنية

المنطقة الزمنية في البنية بتنسيق المنطقة الزمنية IANA.

التفاصيل
https://developer-api.nest.com/structures/structure_id/time_zone
المرتجعاتstring
مثال: "America/Los_Angeles"
الوصولللقراءة فقط
متوفّر فيقراءة الترموستات / الإصدار 1-v6
الترموستات للقراءة/الكتابة / v1-v6
قراءة الدخان + x

وصول

الوقت المقدر للوصول هو كائن يمكن ضبطه على البنية. ويتم استخدامه لإعلام Nest بأنّه من المتوقّع أن يعود المستخدم إلى المنزل في وقت معيّن. للحصول على مزيد من المعلومات حول كيفية إجراء مكالمة باستخدام "الوقت المقدّر للوصول"، يُرجى الاطّلاع على دليل للاستخدام خارج المنزل.

التفاصيل
https://developer-api.nest.com/structures/structure_id/eta
المرتجعاتobject
مثال: "myTripID1024", "2014-10-31T22:42:00.000Z", "2016-12-31T23:59:59.000Z"
المعلّمات
trip_idسلسلة من تحديد المستخدم تحدِّد الرحلة
estimated_arrival_window_begin طابع زمني بتنسيق ISO 8601.
يجب أن تكون القيمة أعلى من NOW.
estimated_arrival_window_endطابع زمني بتنسيق ISO 8601.
يجب أن تكون القيمة أعلى من estimated_arrival_window_begin.
الوصولللكتابة فقط
متوفّر فيالوقت المقدر للوصول للكتابة / الإصدار 1-v2

بدء_الوقت

الطابع الزمني لأوّل وقت متوقع للوصول بتنسيق ISO 8601. يُستخدم لتشغيل الإجراءات أو الأحداث.

التفاصيل
https://developer-api.nest.com/structures/structure_id/eta_begin
المرتجعاتstring
مثال: "2016-12-31T23:59:59.000Z"
الوصولللقراءة فقط
متوفّر فيقراءة الوقت المقدر للوصول / الإصدار 1

rhr_enrollment

حالة التسجيل في برنامج Rush Hour Rewards

التفاصيل
https://developer-api.nest.com/structures/structure_id/rhr_enrollment
المرتجعاتboolean
القيم: صحيح، خطأ
الوصولللقراءة فقط
متوفّر فيقراءة الطاقة / الإصدار 1-v2

wwn_security_state

تنظيم حالة الأمان

التفاصيل
https://developer-api.nest.com/structures/structure_id/wwn_security_state
النوعstring enum
القيم: "ok", "deter"
الوصولللقراءة فقط
متوفّر فيقراءة حالة الأمان / الإصدار 1

أين

عنصر يحتوي على مكانَي المعرّفات (where_id وname) للأجهزة في البنية. name هو الاسم المعروض للجهاز. يمكن أن تكون أي اسم غرفة من قائمة نقدمها، أو اسم مخصص.

لمزيد من المعلومات عن wheres، يُرجى الاطّلاع على دليل البنية.

تعرّف على مزيد من المعلومات حول أماكن استخدام أجهزة Nest Thermostat وNest Protects وNest Cams.

التفاصيل
https://developer-api.nest.com/structures/structure_id/wheres
المرتجعاتobject
الوصولللقراءة فقط
متوفّر فيالقراءة:
الترموستات للقراءة / v3-v6
قراءة الترموستات / الكتابة / الإصدار 3-v6

حيث_id

هو معرّف فريد من إنشاء Nest يمثّل name.

يتم إنشاء where_id وعرضه تلقائيًا أثناء المكالمة لإنشاء name.

التفاصيل
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id
المرتجعاتstring
مثال: "Fqp6wJI..."
الوصولللقراءة فقط
متوفّر فيالقراءة:
قراءة ترموستات / الإصدار 3-v6
قراءة الترموستات/الكتابة / الإصدار 3-v6
الترموستات
القراءة والكتابة / الدخان

الاسم

الاسم المعروض للجهاز.

التفاصيل
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name
المرتجعاتstring
مثال: "Bedroom"
الوصولقراءة/كتابة
متوفّر فيالقراءة:
الترموستات للقراءة / الإصدار 3-v6
قراءة الترموستات / الكتابة / الإصدار 3-v6 بالمرتبة

co_alarm_state

حالة إنذار أول أكسيد الكربون

التفاصيل
https://developer-api.nest.com/structures/structure_id/co_alarm_state
المرتجعاتstring enum
القيم: "ok", &}{;warning", "emergency"
الوصولللقراءة فقط
متوفّر فيقراءة الدخان+أول أكسيد الكربون / الإصدار 5

حالة_إنذار_الدخان

حالة إنذار الدخان.

التفاصيل
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state
المرتجعاتstring enum
القيم: "ok", &}{;warning", "emergency"
الوصولللقراءة فقط
متوفّر فيقراءة الدخان+أول أكسيد الكربون / الإصدار 5