شروع به کار با REST API

این آموزش به شما نشان می‌دهد که چگونه می‌توانید دسترسی به Fitness REST API را فعال کنید، نشانه‌های دسترسی OAuth را بدست آورید و روش‌های API را با استفاده از درخواست‌های HTTP فراخوانی کنید.

برای استفاده از Fitness REST API، مهم است که اصول وب سرویس‌های RESTful و نمایش‌های JSON را بدانید.

یک حساب Google دریافت کنید

برای استفاده از Fitness REST API، به یک حساب Google نیاز دارید. اگر قبلاً یک حساب کاربری دارید، پس همه چیز آماده است. همچنین ممکن است بخواهید یک حساب Google جداگانه برای اهداف آزمایشی ایجاد کنید.

شناسه مشتری OAuth 2.0 را درخواست کنید

برای درخواست شناسه مشتری OAuth 2.0 برای Fitness API این مراحل را دنبال کنید.

  1. به کنسول API Google بروید.
  2. یک پروژه را انتخاب کنید یا یک پروژه جدید ایجاد کنید. از همین پروژه برای نسخه های Android و REST برنامه خود استفاده کنید.
  3. برای فعال کردن Fitness API روی Continue کلیک کنید.
  4. برو به اعتبارنامه کلیک کنید.
  5. روی New credentials کلیک کنید، سپس OAuth Client ID را انتخاب کنید.
  6. در قسمت Application type ، Web application را انتخاب کنید.
  7. در زیر مبداهای مجاز جاوا اسکریپت ، نشانی اینترنتی اصلی سایتی را که درخواست‌ها از آن منشأ می‌شوند، وارد کنید (برای مثال https://developers.google.com نشانی اینترنتی مورد استفاده OAuth Playground است).
  8. در قسمت URI تغییر مسیر مجاز ، نشانی وب سایتی را که در آن پاسخ ها رسیدگی می شود وارد کنید (به عنوان مثال https://developers.google.com/oauthplayground نشانی اینترنتی مورد استفاده OAuth Playground است).

  9. روی ایجاد کلیک کنید. شناسه مشتری OAuth 2.0 و راز جدید شما در لیست شناسه های پروژه شما ظاهر می شود. OAuth 2.0 Client ID رشته ای از کاراکترها است، چیزی شبیه به این:

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

REST API را در OAuth Playground امتحان کنید

OAuth Playground ساده ترین راه برای آشنایی با Fitness REST API با ارسال درخواست های HTTP و مشاهده پاسخ ها قبل از نوشتن کد مشتری است.

برای مجوز Fitness REST API در OAuth Playground:

  1. به زمین بازی OAuth بروید.
  2. در مرحله 1 APIها را انتخاب و تأیید کنید ، Fitness v1 را گسترش دهید و دامنه‌های Fitness را برای استفاده انتخاب کنید.
  3. روی دکمه Authorize APIs کلیک کنید، پروژه Google API Console را برای استفاده انتخاب کنید و وقتی از شما خواسته شد روی Allow کلیک کنید. می‌توانید به داده‌های مرتبط با حساب Google API Console انتخاب‌شده دسترسی داشته باشید و آن‌ها را تغییر دهید.
  4. روی دکمه مجوز Exchange for tokens کلیک کنید. وقتی درخواست‌های HTTP را ارسال می‌کنید، OAuth Playground به‌طور خودکار این هدر را در Authorization: درخواست قرار می‌دهد. توجه داشته باشید که رمز دسترسی پس از 60 دقیقه (3600 ثانیه) منقضی می شود.

درخواست های HTTP را ارسال کنید

مثال‌های زیر نحوه ارسال درخواست‌های HTTP برای فهرست کردن همه منابع داده‌های موجود و ایجاد یک منبع داده جدید را نشان می‌دهند. برای Fitness 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. روی Enter request body کلیک کنید.

  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. در پنجره درخواست بدنه ، روی بستن کلیک کنید.

  6. روی ارسال درخواست کلیک کنید.

درخواست و پاسخ در سمت راست صفحه ظاهر می شود. این درخواست شامل نشانه دسترسی OAuth در سربرگ Authorization است:

Authorization: Bearer ya29. OAuthTokenValue

در صورت موفقیت آمیز بودن درخواست، خط اول پاسخ به صورت زیر است:

HTTP/1.1 200 OK

برای دسترسی به Fit REST API از cURL استفاده کنید

می توانید از ابزار خط فرمان 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، این صفحات را ببینید: