การเริ่มต้นใช้งาน 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. ไปที่คอนโซล 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

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

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

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

  1. ไปที่ OAuth Playground
  2. ในส่วนขั้นตอนที่ 1 เลือกและให้สิทธิ์ API ให้ขยายการออกกําลังกาย เวอร์ชัน 1 แล้วเลือกขอบเขตการออกกําลังกายที่จะใช้
  3. คลิกปุ่มให้สิทธิ์ API เลือกโปรเจ็กต์คอนโซล Google API ที่จะใช้ แล้วคลิกอนุญาตเมื่อได้รับข้อความแจ้ง คุณจะสามารถเข้าถึงและ แก้ไขข้อมูลที่เชื่อมโยงกับบัญชี Google API Console ที่เลือกได้
  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 ให้เลือก GET
  2. ป้อน https://www.googleapis.com/fitness/v1/users/me/dataSources ใน URI คําขอ
  3. คลิกส่งคําขอ

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

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

  1. ในเมธอด HTTP ให้เลือก POST
  2. ป้อน https://www.googleapis.com/fitness/v1/users/me/dataSources ใน URI คําขอ
  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. คลิกปิดในหน้าต่าง Body Body

  6. คลิกส่งคําขอ

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

Authorization: Bearer ya29.OAuthTokenValue

หากคําขอประสบความสําเร็จ บรรทัดแรกของคําตอบคือ

HTTP/1.1 200 OK

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

คุณใช้เครื่องมือบรรทัดคําสั่ง cURL เพื่อเข้าถึง Fit REST API ได้ คุณต้องมีโทเค็นเพื่อการเข้าถึง 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 โปรดดูหน้าต่อไปนี้