بخش مشخصات API، مروری دقیق بر اجزای فنی ضروری برای ادغام با پلتفرم، از جمله حوزههای مجوز، تعاریف نوع داده و ساختارهای نقطه پایانی ارائه میدهد. این API نشاندهنده تکامل استراتژیک API وب Fitbit قدیمی است که بر روی زیرساختهای مدرن بازسازی شده است تا تجربه توسعهدهنده پایدارتر و سازگارتری را تضمین کند.
محدودهها
برای استفاده از محدودههای API گوگل هلث، باید درخواست مجوز خود را بهروزرسانی کنید. محدودهها مشخص میکنند که آیا برنامه شما از عملیات خواندن یا نوشتن پشتیبانی میکند یا خیر. از محدودههایی که برای برنامه شما ضروری نیستند استفاده نکنید. در صورت تغییر طراحی برنامه، همیشه میتوانید بعداً محدودههای بیشتری اضافه کنید.
محدودههای API گوگل هلث یک URL HTTP هستند که با https://www.googleapis.com/auth/googlehealth.{scope} شروع میشوند. برای مثال، https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly.
نگاشتهای محدوده
در اینجا نحوهی نگاشت محدودههای Fitbit Web API به محدودههای Google Health API نشان داده شده است:
| دامنههای API وب Fitbit | محدودههای API سلامت گوگل |
|---|---|
| فعالیت | .فعالیت_و_تناسب_اندام.فقط_خواندنی .activity_and_fitness.فقط نوشتنی |
| قند خون | .معیارها_و_اندازهگیریهای_سلامت.فقط_خواندنی .معیارها_و_اندازهگیریهای_سلامت.فقط_نوشتنی |
| تناسب اندام_قلبی | .فعالیت_و_تناسب_اندام.فقط_خواندنی .activity_and_fitness.فقط نوشتنی |
| الکتروکاردیوگرام | .ecg.فقط خواندنی |
| ضربان قلب | .معیارها_و_اندازهگیریهای_سلامت.فقط_خواندنی .معیارها_و_اندازهگیریهای_سلامت.فقط_نوشتنی |
| اعلانهای ریتم نامنظم | .irn.فقط خواندنی |
| مکان | .مکان.فقط خواندنی |
| تغذیه | .تغذیه.فقط خواندنی .تغذیه.فقط بنویس |
| اشباع اکسیژن | .معیارها_و_اندازهگیریهای_سلامت.فقط_خواندنی .معیارها_و_اندازهگیریهای_سلامت.فقط_نوشتنی |
| پروفایل | .profile.فقط خواندنی .profile.فقط نوشتنی |
| میزان_تنفس | .معیارها_و_اندازهگیریهای_سلامت.فقط_خواندنی .معیارها_و_اندازهگیریهای_سلامت.فقط_نوشتنی |
| تنظیمات | تنظیمات.فقط خواندنی تنظیمات.فقط نوشتنی |
| خواب | .sleep.only (فقط خواندنی) .sleep.only |
| دما | .معیارها_و_اندازهگیریهای_سلامت.فقط_خواندنی .معیارها_و_اندازهگیریهای_سلامت.فقط_نوشتنی |
| وزن | .معیارها_و_اندازهگیریهای_سلامت.فقط_خواندنی .معیارها_و_اندازهگیریهای_سلامت.فقط_نوشتنی |
انواع داده
در اینجا لیستی از انواع دادههای API گوگل هلث و نحوهی نگاشت آنها به API وب فیتبیت ارائه شده است.
| نوع دادهی Web API فیتبیت | نوع داده API سلامت گوگلdataType |
|---|---|
| کالری فعالیت | انرژی فعال سوزانده شدهactive-energy-burned |
| صورتجلسات منطقه فعال | صورتجلسات منطقه فعالactive-zone-minutes |
| شامل تغییراتی در سطوح فعالیت کاربر است | سطح فعالیتactivity-level |
| ارتفاع | ارتفاعaltitude |
| قند خون | قند خونblood-glucose |
| چربی بدن | چربی بدنbody-fat |
caloriesOut در هر منطقه ضربان قلب | کالری در منطقه ضربان قلبcalories-in-heart-rate-zone |
| دما (هسته) | دمای مرکزی بدنcore-body-temperature |
| خلاصه HRV | تغییرپذیری روزانه ضربان قلبdaily-heart-rate-variability |
| خلاصه SpO2 | اشباع اکسیژن روزانهdaily-oxygen-saturation |
| ضربان قلب در حالت استراحت | ضربان قلب در حالت استراحت روزانهdaily-resting-heart-rate |
| دمای پوست | مشتقات دمای خواب روزانهdaily-sleep-temperature-derivations |
| فاصله | فاصلهdistance |
| الکتروکاردیوگرام (ECG) | الکتروکاردیوگرام (ECG)electrocardiogram |
| فعالیت ثبت شده | ورزشexercise |
| طبقات | طبقاتfloors |
| غذا | غذاfood |
| واحد اندازهگیری غذا | واحد اندازهگیری غذاfood-measurement-unit |
| ضربان قلب | ضربان قلبheart-rate |
| HRV روزانه | تغییرپذیری ضربان قلبheart-rate-variability |
| اعلانهای ریتم نامنظم (IRN) | اعلان ریتم نامنظمirregular-rhythm-notification |
| گزارش غذا | گزارش تغذیهnutrition-log |
| SpO2 روزانه | اشباع اکسیژنoxygen-saturation |
| مقدار VO2 Max هنگام دویدن کاربر | حداکثر اکسیژن مصرفی (VO2 Max) را بدویدrun-vo2-max |
| سری زمانی فعالیت، دقیقههای بیتحرک | دوره کم تحرکیsedentary-period |
| خواب | خوابsleep |
| مراحل | مراحلsteps |
| سری زمانی فعالیت، حرکات شنا | دادههای طول شناswim-lengths-data |
caloriesOut مصرفی فعالیت | کل کالریtotal-calories |
| مقدار حداکثر اکسیژن مصرفی (VO2 Max) | حداکثر اکسیژن مصرفی (VO2 Max)vo2-max |
| وزن | وزنweight |
نقاط پایانی
نقاط پایانی REST برای همه انواع داده، یک سینتکس (نحو) ثابت را اتخاذ میکنند.
- نقطه پایانی سرویس : آدرس اینترنتی HTTP پایه به https://health.googleapis.com تغییر میکند.
- سینتکس نقطه پایانی : رابط برنامهنویسی کاربردی گوگل هلث از تعداد محدودی نقطه پایانی پشتیبانی میکند که میتوانند توسط اکثر انواع دادههای پشتیبانیشده مورد استفاده قرار گیرند. این امر سینتکس ثابتی را برای همه انواع دادهها فراهم میکند و استفاده از نقاط پایانی را آسانتر میسازد.
- شناسه کاربر : یا شناسه کاربر یا me باید در سینتکس نقطه پایانی مشخص شوند. هنگام استفاده از me، شناسه کاربر از توکن دسترسی استنباط میشود.
مثال : در اینجا مثالی از نقطه پایانی GET Profile که با استفاده از API Google Health فراخوانی شده است، آورده شده است.
دریافت کنید https://health.googleapis.com/v4/users/me/profile
نگاشتهای نقطه پایانی
برای مشاهدهی فهرستی از انواع دادههای موجود و روشهای API که پشتیبانی میکنند، به جدول انواع دادههای API گوگل هلث مراجعه کنید.
| نوع نقطه پایانی Fitbit Web API | رابط برنامهنویسی کاربردی گوگل هلث |
| GET (گزارش | خلاصه | خلاصه روزانه) که در آن درخواست دادههای یک روز را دارید | متد dailyRollup با windowSize = 1 روز |
| دریافت (درونروزی) جایی که دادههای جزئی را درخواست میکنید | روش فهرست |
| دریافت (سری زمانی) بر اساس تاریخ یا بازه زمانی | متد rollUp یا dailyRollUp شامل یک محدوده تاریخ |
| دریافت (لیست گزارش) | روش فهرست |
| ایجاد و بهروزرسانی لاگها | روش وصله |
| حذف گزارشها | متد حذف دستهای |
| دریافت پروفایل | users.getProfile اطلاعات خاص کاربر را برمیگرداند. users.getSettings واحدها و مناطق زمانی کاربر را برمیگرداند. |
| بهروزرسانی پروفایل | users.updateProfile اطلاعات خاص کاربر را تغییر میدهد. users.updateSettings واحدها و مناطق زمانی کاربر را تغییر میدهد. |
| دریافت شناسه کاربری | users.getIdentity شناسه کاربری قدیمی Fitbit و شناسه کاربری گوگل کاربر را برمیگرداند. |
| دستگاهها را دریافت کنید | users.pairedDevices لیست دستگاههای جفتشده را برمیگرداند. |
| ایجاد اشتراک | projects.subscribers.subscriptions.create به صورت دستی یک اشتراک ایجاد میکند. |
| اشتراکها را حذف کنید | projects.subscribers.subscriptions.delete حذف یک اشتراک |
| دریافت لیست اشتراکها | projects.subscribers.subscriptions.list همه اشتراکها را فهرست میکند. |