بدء استخدام واجهة برمجة التطبيقات REST

يوضّح لك هذا البرنامج التعليمي كيفية تفعيل إمكانية الوصول إلى واجهة برمجة تطبيقات Fitness REST والحصول على رموز مميّزة للوصول إلى OAuth واستدعاء طرق واجهة برمجة التطبيقات باستخدام طلبات HTTP.

لاستخدام واجهة برمجة تطبيقات Fitness REST API، من المهم فهم أساسيات خدمات الويب RESTful وتمثيل JSON.

الحصول على حساب Google

لاستخدام واجهة برمجة تطبيقات Fitness REST، يجب أن يكون لديك حساب Google. إذا كنت تملك حسابًا من قبل، فقد انتهيت من إعداد حسابك. كما يمكنك إنشاء حساب Google منفصل لأغراض الاختبار.

طلب معرِّف عميل OAuth 2.0

اتّبِع الخطوات التالية لطلب معرِّف عميل OAuth 2.0 لواجهة Fitness API.

  1. انتقِل إلى وحدة التحكم في واجهة Google API.
  2. اختَر مشروعًا أو أنشِئ مشروعًا جديدًا. استخدِم المشروع نفسه لإصداري Android وREST من تطبيقك.
  3. انقر على متابعة لتفعيل واجهة برمجة تطبيقات Fitness.
  4. انقر على الانتقال إلى بيانات الاعتماد.
  5. انقر على بيانات اعتماد جديدة، ثم اختَر معرِّف عميل OAuth.
  6. ضمن نوع التطبيق، اختَر تطبيق الويب.
  7. ضمن مصادر JavaScript المسموح بها، أدخِل عنوان URL الأساسي للموقع الإلكتروني الذي ستنشأ منه الطلبات (على سبيل المثال، https://developers.google.com هو عنوان URL الذي تستخدمه ساحة OAuth).
  8. ضمن معرِّف الموارد المنتظم (URI) المعتمَد لإعادة التوجيه، أدخِل عنوان URL للموقع الإلكتروني الذي سيتم التعامل مع الردود فيه (على سبيل المثال، https://developers.google.com/oauthplayground هو عنوان URL الذي تستخدمه ميزة OAuth Playground).

  9. انقر على إنشاء. يظهر معرّف عميل OAuth 2.0 وسر عميل OAuth 2.0 الجديد في قائمة المعرفات لمشروعك. معرّف عميل OAuth 2.0 هو سلسلة من الأحرف، شيء يشبه ما يلي:

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

تجربة واجهة برمجة التطبيقات REST في ساحة بروتوكول OAuth

ساحة بروتوكول OAuth هي أسهل طريقة للتعرّف على واجهة برمجة تطبيقات Fitbit REST API من خلال إرسال طلبات HTTP ومراقبة الاستجابة قبل كتابة أي رمز للعميل.

لاعتماد واجهة برمجة تطبيقات Fitness REST في OAuth Playground:

  1. انتقِل إلى ملعب OAuth.
  2. ضمن الخطوة 1، اختيار واجهات برمجة التطبيقات والسماح بها، وسِّع الإصدار 1 من اللياقة البدنية، ثم اختَر نطاقات اللياقة البدنية المطلوب استخدامها.
  3. انقر على الزر Authorize APIs (تفويض واجهات برمجة التطبيقات)، واختَر مشروع وحدة تحكُّم Google API المطلوب استخدامه، ثمّ انقر على Allow (سماح) عندما يُطلب منك ذلك. ستتمكن من الوصول إلى البيانات المرتبطة بحساب Google API Console المحدَّد وتعديلها.
  4. انقر على الزر تبادل رمز تفويض الرموز المميزة. يتضمّن "ملعب OAuth" تلقائيًا هذا العنوان في عنوان طلب Authorization: عند إرسال طلبات HTTP. لاحظ أن رمز الدخول ستنتهي صلاحيته بعد 60 دقيقة (3600 ثانية).

إرسال طلبات HTTP

توضح الأمثلة التالية كيفية إرسال طلبات HTTP لإدراج جميع مصادر البيانات المتاحة، وإنشاء مصدر بيانات جديد. بالنسبة إلى واجهة برمجة تطبيقات Fitness REST، يكون تنسيق URI هو:

https://www.googleapis.com/fitness/v1/resourcePath?parameters

لعرض جميع مصادر البيانات المتاحة:

  1. في طريقة HTTP، اختَر GET.
  2. في عنوان URI للطلب، أدخِل https://www.googleapis.com/fitness/v1/users/me/dataSources.
  3. انقر على إرسال الطلب.

يظهر الطلب والاستجابة على يسار الصفحة. وإذا نجح الطلب، ستعرض الاستجابة مصدر البيانات من المثال السابق بتنسيق JSON.

لإنشاء مصدر بيانات:

  1. في طريقة HTTP، اختَر POST.
  2. في عنوان URI للطلب، أدخِل https://www.googleapis.com/fitness/v1/users/me/dataSources.
  3. انقر على إدخال نص الطلب.

  4. في نافذة نص الطلب، انسخ ملف JSON التالي والصقه:

    {
  "dataStreamName": "MyDataSource",
  "type": "derived",
  "application": {
    "detailsUrl": "http://example.com",
    "name": "Foo Example App",
    "version": "1"
  },
  "dataType": {
    "field": [
      {
        "name": "steps",
        "format": "integer"
      }
    ],
    "name": "com.google.step_count.delta"
  },
  "device": {
    "manufacturer": "Example Manufacturer",
    "model": "ExampleTablet",
    "type": "tablet",
    "uid": "1000001",
    "version": "1"
  }
}

  5. في نافذة نص الطلب، انقر على إغلاق.

  6. انقر على إرسال الطلب.

يظهر الطلب والاستجابة على يسار الصفحة. يتضمّن الطلب رمز الدخول عبر OAuth في عنوان Authorization:

Authorization: Bearer ya29.OAuthTokenValue

إذا تم قبول الطلب، يكون السطر الأول من الرد هو:

HTTP/1.1 200 OK

استخدام cURL للوصول إلى واجهة Fit REST API

يمكنك استخدام أداة سطر الأوامر cURL للوصول إلى واجهة برمجة تطبيقات Fitbit REST. ستحتاج إلى رمز دخول OAuth لتقديم الطلبات باستخدام cURL (راجِع instructions السابقة). تجدر الإشارة إلى أنّ رموز الدخول تنتهي صلاحيتها بعد ساعة. يوضح المثال التالي نصًا برمجيًا بسيطًا bash لسرد جميع مصادر البيانات.

#!/bin/bash
ACCESS_TOKEN=""
curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://www.googleapis.com/fitness/v1/users/me/dataSources

الخطوات التالية

لمزيد من المعلومات عن واجهة برمجة تطبيقات REST، اطّلِع على الصفحات التالية: