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

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

ในการใช้ REST API ของฟิตเนส คุณต้องเข้าใจพื้นฐานของ บริการเว็บที่มีประสิทธิภาพ และการแสดง JSON

รับบัญชี Google

หากต้องการใช้ Fitness REST API คุณต้องมีบัญชี Google หากมีบัญชีอยู่แล้ว ทุกอย่างก็พร้อมใช้งานแล้ว คุณอาจต้องสร้างบัญชี Google แยกต่างหากเพื่อวัตถุประสงค์ในการทดสอบด้วย

ขอรหัสไคลเอ็นต์ OAuth 2.0

ทำตามขั้นตอนต่อไปนี้เพื่อขอรหัสไคลเอ็นต์ OAuth 2.0 สำหรับ Fitness API

  1. ไปที่หน้า Google API Console
  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 เป็นวิธีที่ง่ายที่สุดในการทำความคุ้นเคยกับ Fitness REST API ด้วยการส่งคำขอ HTTP และสังเกตการตอบกลับก่อน เขียนโค้ดไคลเอ็นต์

วิธีให้สิทธิ์ Fitness REST API ใน OAuth Playground

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

ส่งคำขอ HTTP

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