การเริ่มต้นใช้งาน REST API

บทแนะนำนี้จะแสดงวิธีเปิดใช้งานการเข้าถึง Fitness REST API, รับโทเค็นการเข้าถึง OAuth และเรียกใช้เมธอด API โดยใช้คำขอ HTTP

หากต้องการใช้ Fitness REST API คุณต้องทำความเข้าใจพื้นฐานของบริการเว็บ RESTful และการแสดง JSON

รับบัญชี Google

หากต้องการใช้ฟิตเนส REST API คุณต้องมีบัญชี 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 Playground ใช้)
  8. ในส่วน URI การเปลี่ยนเส้นทางที่ได้รับอนุญาต ให้ป้อน URL ของเว็บไซต์ที่จะจัดการการตอบกลับ (เช่น https://developers.google.com/oauthplayground คือ URL ที่ใช้โดย OAuth Playground)

  9. คลิกสร้าง รหัสไคลเอ็นต์ OAuth 2.0 และรหัสลับใหม่จะปรากฏในรายการรหัสสำหรับโปรเจ็กต์ของคุณ โดยรหัสไคลเอ็นต์ OAuth 2.0 คือสตริงอักขระ ซึ่งมีลักษณะดังนี้

    780816631155-gbvyo1o7r2pn95qc4ei9d61io4uh48hl.apps.googleusercontent.com

ลองใช้ REST API ใน OAuth Playground

OAuth Playground เป็นวิธีที่ง่ายที่สุดในการทำความคุ้นเคยกับ API ของ Fitbit REST โดยการส่งคำขอ HTTP และสังเกตคำตอบก่อนที่จะเขียนรหัสไคลเอ็นต์

วิธีให้สิทธิ์ฟิตเนส REST API ใน OAuth Playground

  1. ไปที่ OAuth Playground
  2. ในส่วนขั้นตอนที่ 1 เลือกและให้สิทธิ์ API ให้ขยาย Fitness v1 แล้วเลือกขอบเขต "ฟิตเนส" ที่จะใช้
  3. คลิกปุ่ม Authorize API เลือกโปรเจ็กต์คอนโซล Google API ที่จะใช้ และคลิก Allow เมื่อได้รับข้อความแจ้ง คุณจะเข้าถึงและแก้ไขข้อมูลที่เชื่อมโยงกับบัญชีคอนโซล Google API ที่เลือกได้
  4. คลิกปุ่มรหัสการให้สิทธิ์ Exchange สำหรับโทเค็น OAuth Playground จะรวมส่วนหัวนี้ไว้ในส่วนหัวของคำขอ Authorization: โดยอัตโนมัติเมื่อคุณส่งคำขอ HTTP โปรดทราบว่าโทเค็นเพื่อการเข้าถึงจะหมดอายุ หลังจากผ่านไป 60 นาที (3,600 วินาที)

ส่งคำขอ HTTP

ตัวอย่างต่อไปนี้แสดงวิธีส่งคำขอ HTTP เพื่อแสดงรายการแหล่งข้อมูลที่มีอยู่ทั้งหมดและการสร้างแหล่งข้อมูลใหม่ สำหรับ Fitness REST API รูปแบบ URI คือ

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

วิธีแสดงรายการแหล่งข้อมูลที่ใช้ได้ทั้งหมด

  1. ในเมธอด HTTP ให้เลือกรับ
  2. ใน Request URI ให้ป้อน https://www.googleapis.com/fitness/v1/users/me/dataSources
  3. คลิกส่งคำขอ

คำขอและคำตอบจะปรากฏที่ด้านขวาของหน้า หากคำขอสำเร็จ การตอบกลับจะแสดงแหล่งข้อมูลจากตัวอย่างก่อนหน้าในรูปแบบ JSON

วิธีสร้างแหล่งข้อมูล

  1. ในเมธอด HTTP ให้เลือกโพสต์
  2. ใน Request 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

  6. คลิกส่งคำขอ

คำขอและคำตอบจะปรากฏที่ด้านขวาของหน้า คำขอนี้มีโทเค็นเพื่อการเข้าถึง OAuth ในส่วนหัว Authorization ดังนี้

Authorization: Bearer ya29.OAuthTokenValue

หากคำขอสำเร็จ บรรทัดแรกของการตอบกลับจะเป็นดังนี้

HTTP/1.1 200 OK

ใช้ cURL เพื่อเข้าถึง Fit REST API

คุณใช้เครื่องมือบรรทัดคำสั่ง cURL เพื่อเข้าถึง Fit REST API ได้ คุณจะต้องมีโทเค็นเพื่อการเข้าถึง OAuth เพื่อส่งคำขอโดยใช้ cURL (ดูinstructionsก่อนหน้านี้) โปรดทราบว่าโทเค็นเพื่อการเข้าถึงจะหมดอายุหลังจากผ่านไป 1 ชั่วโมง ตัวอย่างต่อไปนี้แสดงสคริปต์ 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 โปรดดูหน้าต่อไปนี้