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

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

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

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

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

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

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

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

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

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

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

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

لتفويض واجهة برمجة تطبيقات Fitness REST في "مساحة بروتوكول OAuth"، اتّبِع الخطوات التالية:

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

إرسال طلبات HTTP

توضح الأمثلة التالية كيفية إرسال طلبات HTTP إلى قائمة بجميع مصادر البيانات المتاحة، وإنشاء مصدر بيانات جديد. لرياضة 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 للوصول إلى واجهة برمجة تطبيقات Fit REST يجب أن يتوفّر رمز الدخول OAuth لإجراء الطلبات. باستخدام أمر cURL (اطّلِع على التعليمات السابقة). تجدر الإشارة إلى أنّ رموز الدخول تنتهي صلاحيتها بعد ساعة. يوضح المثال التالي نص 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، يمكنك الاطّلاع على الصفحات التالية: