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

تعرض واجهة برمجة تطبيقات Nest منزلاً أو مبنى في شكل هيكل، مع أجهزة Nest Learning Thermostat وNest Protects وNest Cams كأجهزة في البنية. وتحتوي أيضًا هذه البنية على معلومات حول المنزل ككل (مثل حالة "خارج المنزل" أو "الوقت المقدر للوصول" أو ساعات الذروة النشطة).

يمكن التعامل مع كل عنصر من عناصر البيانات في البنية بعنوان URL للمصدر (يُعرف باسم "data data") في مستند JSON مشترك. يمكن لكل موقع بيانات تخزين سلاسل أو أرقام أو قيم منطقية أو عناصر رئيسية/فرعية أو مصفوفات.

استكشِف نموذج البيانات باستخدام مرجع واجهة برمجة التطبيقات التفاعلي هذا.

من واجهة برمجة التطبيقات، يمكنك مزامنة البيانات من المواقع الجغرافية على مستويات متعددة في نموذج البيانات، على سبيل المثال:

  • بنية كاملة، بما في ذلك جميع الأجهزة
  • جهاز واحد في بنية
  • مجموعة من قيم البيانات (درجة الحرارة الحالية والبيئة المحيطة)
  • قيمة بيانات واحدة (الحالة الصحية للبطارية)

يجب أن تتجاوب منتجاتك جيدًا مع الأحداث التالية:

  • الحضور (داخل المنزل وخارجه)
  • safety (الدخان وأول أكسيد الكربون)
  • الطاقة خلال خلال أوقات اليوم المكلفة
  • الأحداث (الصوت والحركة)

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

الأذونات وبيانات الجهاز المشتركة

يتم التحكّم في إمكانية قراءة الموقع الجغرافي للبيانات أو الكتابة فيه من خلال الأذونات. وتوفِّر مجموعات الأذونات أذونات للقراءة/الكتابة أو القراءة/الكتابة لقيم البيانات المحدَّدة في الأجهزة والبُنى.

لمزيد من المعلومات، اطّلع على نظرة عامة على الأذونات.

البيانات والخصوصية

إنّ البيانات المرتبطة بالمنتجات المنزلية يمكن أن تكون شخصية جدًا. تحتوي بيانات جهاز استشعار المنزل على معلومات حول نمط حياة الأشخاص في مساحتهم الشخصية. ويُعدّ أمان هذه البيانات ومعالجتها أمرًا في غاية الأهمية، محل التركيز بشكل كبير على Nest. نوضّح للمستخدمين بشكل واضح نوع البيانات التي نوفّرها وكيفية استخدامها والأماكن التي يمكنهم التحكّم فيها.

مزيد من المعلومات حول مشاهدات الخصوصية

البيانات الوصفية

البيانات الوصفية هي معلومات إضافية يتم تقديمها عند إجراء استدعاء لنقطة النهاية على مستوى الجذر:

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

رمز الدخول

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

التفاصيل
المرتجعاتstring
مثال: &c;FmDPkzyzaQe..."

عميل_إصدار

إصدار العميل هو آخر إصدار يفوّضه المستخدم للعميل، ويكون مرتبطًا بخدمة access_token.

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

التفاصيل
المرتجعاتnumber
أمثلة: 1، 17، 42

user_id

يسمح لك رقم تعريف المستخدم بتحديد المستخدمين عبر طلبات البيانات من واجهة برمجة التطبيقات. ويختلف هذا المعرّف لكلّ منتج من إصدارات Works with Nest والمستخدم.

على سبيل المثال، إذا كان المستخدم 1 قد فوَّض العمل مع منتج Nest "أ" ويعمل مع منتج Nest "ب"، سيكون للمنتج "أ" قيمة user_id واحدة للمستخدم 1، ويمتلك المنتج "ب" قيمة user_id مختلفة للمستخدم 1.

التفاصيل
المرتجعاتstring
مثال: z.1.1.7DHps...