مشخصات API

بخش مشخصات 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 سلامت گوگل
دامنه‌های API وب Fitbit محدوده‌های API سلامت گوگل
فعالیت .فعالیت_و_تناسب_اندام.فقط_خواندنی
.activity_and_fitness.فقط نوشتنی
قند خون .معیارها_و_اندازه‌گیری‌های_سلامت.فقط_خواندنی
.معیارها_و_اندازه‌گیری‌های_سلامت.فقط_نوشتنی
تناسب اندام_قلبی .فعالیت_و_تناسب_اندام.فقط_خواندنی
.activity_and_fitness.فقط نوشتنی
الکتروکاردیوگرام .ecg.فقط خواندنی
ضربان قلب .معیارها_و_اندازه‌گیری‌های_سلامت.فقط_خواندنی
.معیارها_و_اندازه‌گیری‌های_سلامت.فقط_نوشتنی
اعلان‌های ریتم نامنظم .irn.فقط خواندنی
مکان .مکان.فقط خواندنی
تغذیه .تغذیه.فقط خواندنی
.تغذیه.فقط بنویس
اشباع اکسیژن .معیارها_و_اندازه‌گیری‌های_سلامت.فقط_خواندنی
.معیارها_و_اندازه‌گیری‌های_سلامت.فقط_نوشتنی
پروفایل .profile.فقط خواندنی
.profile.فقط نوشتنی
میزان_تنفس .معیارها_و_اندازه‌گیری‌های_سلامت.فقط_خواندنی
.معیارها_و_اندازه‌گیری‌های_سلامت.فقط_نوشتنی
تنظیمات تنظیمات.فقط خواندنی
تنظیمات.فقط نوشتنی
خواب .sleep.only (فقط خواندنی)
.sleep.only
دما .معیارها_و_اندازه‌گیری‌های_سلامت.فقط_خواندنی
.معیارها_و_اندازه‌گیری‌های_سلامت.فقط_نوشتنی
وزن .معیارها_و_اندازه‌گیری‌های_سلامت.فقط_خواندنی
.معیارها_و_اندازه‌گیری‌های_سلامت.فقط_نوشتنی

انواع داده

در اینجا لیستی از انواع داده‌های API گوگل هلث و نحوه‌ی نگاشت آنها به API وب فیت‌بیت ارائه شده است.

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

جدول: نگاشت‌های نوع داده‌ی Fitbit Web API به Google Health API
نوع داده‌ی Web API فیت‌بیت نوع داده API سلامت گوگل
dataType		 توضیحات
کالری فعالیت انرژی فعال سوزانده شده
active-energy-burned		 کالری سوزانده شده در طول دوره‌های فعال، شامل BMR برای آن دوره‌ها را نشان می‌دهد. در API گوگل هلث، این مقدار را می‌توان با اضافه کردن BMR به نوع داده‌ی active-energy-burned (که فقط میزان سوخت و ساز بدن را در طول فعالیت، به استثنای میزان پایه، اندازه‌گیری می‌کند) بازسازی کرد.
صورتجلسات منطقه فعال صورتجلسات منطقه فعال
active-zone-minutes
شامل تغییراتی در سطوح فعالیت کاربر است سطح فعالیت
activity-level
ارتفاع ارتفاع
altitude
caloriesBMR فعالیت BMR انرژی پایه سوزانده شده
basal-energy-burned		 کالری سوزانده شده به دلیل میزان متابولیسم پایه (BMR) در یک دوره زمانی خاص.
قند خون قند خون
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

محاسبات

نگاشت‌ها و قوانین در API گوگل هلث با API وب فیت‌بیت متفاوت است.

سطح فعالیت، METs و آستانه‌های گام

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

سطح فعالیت دستگاه‌های ضربان قلب دستگاه‌های غیر ضربان قلب
کم‌تحرک ≤ ۱.۵ METs ≤ ۱.۵ METs
کمی فعال > 1.5 METs و ≤ 4.2 METs > ۱.۵ METs و ≤ ۳.۵ METs
نسبتاً فعال > ۴.۲ METs و < ۶.۰ METs
(مگر اینکه شرایط مربوط به حالت بسیار فعال برقرار باشد)		 > 3.5 METs و < 6.0 METs
(مگر اینکه شرایط مربوط به حالت بسیار فعال برقرار باشد)
بسیار فعال ≥ ۶.۰ METs، یا ≥ ۵.۰ METs با سرعت گام ۱۵۰ گام در دقیقه یا بیشتر

دقایق فعال شامل دقایق ترکیبی MODERATELY_ACTIVE و VERY_ACTIVE است. با این حال، یک دقیقه بسیار فعال فقط در صورتی ثبت می‌شود که در یک دوره حداقل ۱۰ دقیقه‌ای مداوم رخ دهد و حداکثر ۲ دقیقه وقفه با فعالیت کمتر مجاز باشد.

دقایق بی‌تحرکی و خواب

دقایق بی‌تحرکی شامل زمان خواب نمی‌شود. در محاسبه‌ی روزانه، دقایق بی‌تحرکی با کم کردن دقایق خواب و دقایق فعال (کم‌فعال، نسبتاً فعال و بسیار فعال) از کل دقایق روز (۱۴۴۰ دقیقه) محاسبه می‌شود:

Sedentary Minutes = 1440 - Sleep Minutes - Lightly Active Minutes - Moderately Active Minutes - Very Active Minutes

نقاط پایانی

نقاط پایانی 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 همه اشتراک‌ها را فهرست می‌کند.