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

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

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

קבל חשבון Google

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

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

יש לבצע את השלבים הבאים כדי לבקש מספר לקוח OAuth 2.0 עבור כושר ה-API.

  1. עוברים אל Google API Console.
  2. בוחרים פרויקט או יוצרים פרויקט חדש. תוכלו להשתמש באותו פרויקט לגרסאות של Android ו-REST.
  3. לוחצים על Continue (המשך) כדי להפעיל את API API.
  4. לוחצים על מעבר לפרטי הכניסה.
  5. לוחצים על פרטי כניסה חדשים ובוחרים באפשרות מזהה לקוח OAuth.
  6. בקטע סוג אפליקציה, בוחרים באפשרות אפליקציית אינטרנט.
  7. בקטע מקורות JavaScript מורשים, מזינים את כתובת האתר הבסיסית של האתר שממנו יגיעו הבקשות (לדוגמה, https://developers.google.com היא כתובת ה-URL המשמשת את מגרש המשחקים של OAuth).
  8. בקטע URI של הפניה אוטומטית מורשה, מזינים את כתובת ה-URL של האתר לטיפול בתגובות (לדוגמה, https://developers.google.com/oauthplayground היא כתובת ה-URL המשמשת את מגרש המשחקים של OAuth).

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

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

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

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

כדי לתת הרשאה ל-Health REST API במגרש המשחקים של OAuth:

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

שליחת בקשות HTTP

הדוגמאות הבאות ממחישות איך לשלוח בקשות HTTP כדי לפרט את כל מקורות הנתונים הזמינים וליצור מקור נתונים חדש. ב-Health REST API, הפורמט של 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. בחלון 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 כדי לגשת ל-Fit REST API

תוכלו להשתמש בכלי שורת הפקודה cURL כדי לגשת ל-Fit REST API. כדי לבצע בקשות באמצעות cURL, תצטרכו אסימון גישה ל-OAuth (עיינו בהוראות הקודמות). התוקף של אסימוני הגישה פג לאחר שעה. הדוגמה הבאה מציגה סקריפט 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 API זמין בדפים הבאים: