مرجع Nest API

Nest API یک خانه یا ساختمان فیزیکی را به‌عنوان یک سازه مدل‌سازی می‌کند، با ترموستات‌های یادگیری Nest، Nest Protect و Nest Cams به‌عنوان دستگاه‌هایی در ساختار. این ساختار همچنین حاوی اطلاعاتی درباره کل خانه است (مانند وضعیت خارج از خانه یا ETA، یا ساعات شلوغی فعال).

هر عنصر داده در ساختار با یک URL منبع (به نام "موقعیت های داده") در یک سند JSON مشترک آدرس پذیر است. هر مکان داده می تواند رشته ها، اعداد، بولی ها، اشیاء والد/فرزند یا آرایه ها را ذخیره کند.

مدل داده را با این مرجع API تعاملی کاوش کنید.

از API، می‌توانید داده‌ها را از مکان‌ها در سطوح مختلف در مدل داده همگام‌سازی کنید، به عنوان مثال:

  • یک ساختار کامل، از جمله تمام دستگاه ها
  • یک دستگاه واحد در یک ساختار
  • گروهی از مقادیر داده (دمای فعلی و محیط)
  • یک مقدار داده واحد (وضعیت سلامت باتری)

محصولات شما باید متفکرانه به رویدادهایی مانند موارد زیر پاسخ دهند:

با این حال، به خاطر داشته باشید که هر یک از اشیاء مبتنی بر دستگاه تحت محدودیت های دنیای واقعی کار می کنند. به عنوان مثال، هنگامی که گرمای اضطراری فعال است، ترموستات نباید کولر گازی را روشن کند. API ما برای محافظت از دستگاه‌های ما و خانه کاربر طراحی شده است و از برخی اقدامات در صورت شگفت‌انگیز یا خطرناک بودن جلوگیری می‌کند.

مجوزها و داده های دستگاه مشترک

توانایی خواندن یا نوشتن در یک مکان داده توسط مجوزها کنترل می شود. گروه‌های مجوز دسترسی خواندن، نوشتن، یا خواندن/نوشتن را به مقادیر داده انتخابی در دستگاه‌ها و ساختارها فراهم می‌کنند.

برای اطلاعات بیشتر، به نمای کلی مجوزها مراجعه کنید.

داده ها و حریم خصوصی

داده های مربوط به محصولات خانگی می تواند بسیار شخصی باشد. داده های حسگر خانه حاوی اطلاعاتی درباره نحوه زندگی مردم در فضای شخصی است. امنیت و مدیریت آن داده ها بسیار مهم است و تمرکز قابل توجهی در Nest دارد. ما به کاربران کاملاً روشن می‌کنیم که چه نوع داده‌هایی داریم، چگونه استفاده می‌شود و کجا می‌توانند آن را کنترل کنند.

درباره نظرات ما در مورد حریم خصوصی بیشتر بیاموزید.

فراداده

فراداده اطلاعات اضافی است که هنگام برقراری تماس با نقطه پایانی سطح ریشه ارائه می شود:

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

نشانه دسترسی

پس از مجوز کاربر، محصول شما از یک رمز دسترسی برای برقراری تماس‌های API با سرویس Nest استفاده می‌کند. این نشانه دسترسی به عنوان مدرکی است که نشان می دهد یک کاربر به محصول شما اجازه داده است که از طرف او تماس بگیرد.

جزئیات
برمی گرداند string
مثال: "c.FmDPkzyzaQe..."

client_version

نسخه کلاینت آخرین نسخه مجاز کاربر از یک کلاینت است و با access_token مرتبط است.

هنگامی که مجوزهای یک کلاینت را به روز می کنید، نسخه سرویس گیرنده افزایش می یابد و به کاربر اطلاع داده می شود که یک به روز رسانی در دسترس است. کاربران شما قبل از اینکه بتوانند از محصول به روز شده شما استفاده کنند، باید این به‌روزرسانی مشتری را بپذیرند.

جزئیات
برمی گرداند number
مثال: 1، 17، 42

شناسه کاربر

شناسه کاربر به شما امکان می دهد تا کاربران را در تماس های API شناسایی کنید. این شناسه برای هر محصول Works with Nest و ترکیب کاربری متفاوت است.

به عنوان مثال، اگر کاربر 1 مجوز Works with Nest محصول A و Works with Nest محصول B را داشته باشد، محصول A یک مقدار user_id برای کاربر 1 دارد و محصول B مقدار user_id متفاوتی برای کاربر 1 دارد.

جزئیات
برمی گرداند string
مثال: z.1.1.7DHps...