بدء استخدام REST API

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

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

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

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

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

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

اتّبِع هذه الخطوات لطلب معرِّف عميل OAuth 2.0 لواجهة برمجة تطبيقات الصلاحية.

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

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

تجربة واجهة برمجة تطبيقات REST API في ملعب Play OAuth

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

لتفويض واجهة برمجة تطبيقات REST Fitness في "مساحة لعب OAuth".

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

إرسال طلبات HTTP

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

#!/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 API، يُرجى الاطّلاع على الصفحات التالية: