תחילת העבודה עם API ל-REST

במדריך הזה מוסבר איך להפעיל את הגישה ל-Fitness REST API, ולקבל גישת OAuth ולהפעיל את ה-methods של ה-API באמצעות בקשות HTTP.

כדי להשתמש ב-Fitness REST API, חשוב להבין את העקרונות הבסיסיים של שירותי אינטרנט בארכיטקטורת RESTful וייצוגי JSON.

קבל חשבון Google

כדי להשתמש ב-Fitness REST API, נדרש חשבון Google. אם כבר יש לך חשבון, הכול מוכן. כדאי גם: ליצור חשבון Google נפרד למטרות בדיקה.

בקשת מזהה לקוח ב-OAuth 2.0

כדי לבקש מזהה לקוח ב-OAuth 2.0 ל-Fitness API, צריך לפעול לפי השלבים הבאים.

  1. עוברים אל מסוף Google API.
  2. בוחרים פרויקט או יוצרים פרויקט חדש. שימוש באותו פרויקט בשביל Android ו-REST של האפליקציה שלך.
  3. לוחצים על המשך כדי להפעיל את Fitbit API.
  4. לוחצים על Go to credentials (מעבר אל פרטי הכניסה).
  5. לוחצים על New credentials (פרטי כניסה חדשים) ובוחרים באפשרות OAuth Client ID (מזהה לקוח OAuth).
  6. בקטע Application type (סוג אפליקציה), בוחרים באפשרות Web application.
  7. בקטע מקורות JavaScript מורשים, מזינים את כתובת ה-URL הבסיסית של האתר שממנו יגיעו הבקשות (לדוגמה, https://developers.google.com היא כתובת ה-URL שמשמשת את OAuth Playground).
  8. בקטע URI של הפניה אוטומטית מורשית, מזינים את כתובת ה-URL של האתר שבו תגובות יטופל (לדוגמה https://developers.google.com/oauthplayground היא כתובת ה-URL שמשמשת את OAuth Playground).

  9. לוחצים על יצירה. הסוד ומזהה הלקוח החדשים של OAuth 2.0 מופיעים ברשימה של המזהים בפרויקט. מזהה הלקוח של OAuth 2.0 הוא מחרוזת של תווים, בערך כך:

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

כדאי לנסות את ה-API ל-REST במגרש המשחקים של OAuth

'מגרש המשחקים של OAuth' הוא הדרך הקלה ביותר להכיר כושר API ל-REST על ידי שליחת בקשות HTTP וצפייה בתשובות לפני כותבים קוד לקוח כלשהו.

כדי לאשר את ה-API ל-REST של כושר ב-OAuth Playground:

  1. נכנסים אל OAuth Playground.
  2. בקטע שלב 1 בחירה ו מתן הרשאה לממשקי API, מרחיבים את Fitness v1 ובוחרים היקף הכושר לשימוש.
  3. לוחצים על הלחצן Authorize APIs, ואז בוחרים את הפרויקט ב-Google API Console כדי להשתמש וללחוץ על אישור כשתוצג הבקשה. תהיה לך אפשרות לגשת אל שינוי הנתונים המשויכים לחשבון Google API Console שנבחר.
  4. לוחצים על הלחצן החלפת קוד הרשאה לאסימונים. פרוטוקול OAuth מערכת Playground כוללת את הכותרת הזו באופן אוטומטי בAuthorization: בכותרת הבקשה כששולחים בקשות HTTP. שימו לב שאסימון הגישה יפוג לאחר 60 דקות (3,600 שניות).

שליחת בקשות HTTP

הדוגמאות הבאות ממחישות איך לשלוח בקשות HTTP כדי להציג רשימה של כל מקורות נתונים זמינים, וליצור מקור נתונים חדש. ל-Fitness ב-REST API, הפורמט של ה-URI הוא:

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

כדי להציג רשימה של כל מקורות הנתונים הזמינים:

  1. ב-HTTP Method, בוחרים באפשרות GET.
  2. בקטע URI של בקשה, מזינים https://www.googleapis.com/fitness/v1/users/me/dataSources
  3. לוחצים על שליחת הבקשה.

הבקשה והתגובה יופיעו בצד שמאל של הדף. אם הבקשה בוצעה בהצלחה, התגובה מציגה את מקור הנתונים לדוגמה בפורמט JSON.

כדי ליצור מקור נתונים:

  1. ב-HTTP Method, בוחרים POST.
  2. בקטע URI של בקשה, מזינים https://www.googleapis.com/fitness/v1/users/me/dataSources
  3. לוחצים על הזנת גוף הבקשה.

  4. בחלון Request Body, מעתיקים ומדביקים את קובץ ה-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. בחלון Request Body לוחצים על Close.

  6. לוחצים על שליחת הבקשה.

הבקשה והתגובה יופיעו בצד שמאל של הדף. הבקשה כולל את אסימון הגישה ל-OAuth בכותרת Authorization:

Authorization: Bearer ya29.OAuthTokenValue

אם הבקשה תסתיים בהצלחה, השורה הראשונה בתשובה תהיה:

HTTP/1.1 200 OK

שימוש ב-cURL כדי לגשת ל-API של Fit ל-REST

אפשר להשתמש בכלי שורת הפקודה cURL כדי לגשת התאמה ל-API בארכיטקטורת 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

השלבים הבאים

מידע נוסף על API ל-REST זמין בדפים הבאים: