ใช้คีย์ API กับ Geolocation API

ผลิตภัณฑ์ Google Maps Platform มีความปลอดภัยไม่ให้ใช้งานโดยไม่ได้รับอนุญาตด้วยการจํากัดการเรียก API สําหรับข้อมูลรับรองการตรวจสอบสิทธิ์ที่ถูกต้องเท่านั้น ข้อมูลเข้าสู่ระบบเหล่านี้จะอยู่ในรูปแบบของคีย์ API ซึ่งเป็นสตริงที่เป็นตัวอักษรและตัวเลขคละกันแบบไม่ซ้ําซึ่งเชื่อมโยงบัญชีสําหรับการเรียกเก็บเงินของ Google กับโปรเจ็กต์และ API หรือ SDK ที่เจาะจง

คู่มือนี้จะแสดงวิธีสร้าง จํากัด และใช้คีย์ API สําหรับ Google Maps Platform

ข้อควรทราบก่อนที่จะเริ่มต้น

ก่อนเริ่มใช้ Geolocation API คุณต้องมีโปรเจ็กต์ที่เปิดใช้บัญชีสําหรับการเรียกเก็บเงินและ Geolocation API เปิดอยู่ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อตั้งค่าใน Cloud Console

การสร้างคีย์ API

คีย์ API คือตัวระบุที่ไม่ซ้ํากัน ซึ่งจะตรวจสอบสิทธิ์คําขอที่เชื่อมโยงกับโปรเจ็กต์เพื่อการใช้งานและการเรียกเก็บเงิน คุณต้องมีคีย์ API อย่างน้อย 1 รายการที่เชื่อมโยงกับโปรเจ็กต์

วิธีสร้างคีย์ API

คอนโซล

  1. ไปที่หน้า Google Maps Platform > ข้อมูลเข้าสู่ระบบ

    ไปที่หน้าข้อมูลเข้าสู่ระบบ

  2. ในหน้าข้อมูลเข้าสู่ระบบ ให้คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
    กล่องโต้ตอบสร้างคีย์ API จะแสดงคีย์ API ที่สร้างขึ้นใหม่
  3. คลิกปิด
    คีย์ API ใหม่จะปรากฏในหน้าข้อมูลเข้าสู่ระบบในส่วนคีย์ API
    (โปรดอย่าลืมจํากัดคีย์ API ก่อนนําไปใช้ในเวอร์ชันที่ใช้งานจริง)

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

อ่านเพิ่มเติมเกี่ยวกับ Google Cloud SDK, การติดตั้ง Cloud SDK และคําสั่งต่อไปนี้

การจํากัดคีย์ API

Google ขอแนะนําอย่างยิ่งให้คุณจํากัดคีย์ API ด้วยการจํากัดการใช้งานสําหรับ API เหล่านั้นซึ่งจําเป็นต้องใช้สําหรับแอปพลิเคชันเท่านั้น การจํากัดคีย์ API จะเป็นการเพิ่มความปลอดภัยให้กับแอปพลิเคชันของคุณโดยการป้องกันคีย์จากคําขอที่ไม่มีการรับประกัน สําหรับข้อมูลเพิ่มเติม โปรดดูแนวทางปฏิบัติที่ดีที่สุดด้านความปลอดภัย API

วิธีจํากัดคีย์ API

คอนโซล

  1. ไปที่หน้า Google Maps Platform > ข้อมูลเข้าสู่ระบบ

    ไปที่หน้าข้อมูลเข้าสู่ระบบ

  2. เลือกคีย์ API ที่ต้องการตั้งค่าการจํากัด หน้าพร็อพเพอร์ตี้ของคีย์ API จะปรากฏขึ้น
  3. ในส่วนการจํากัดคีย์ ให้กําหนดข้อจํากัดต่อไปนี้
    • ข้อจำกัดแอปพลิเคชัน:
      1. หากต้องการยอมรับคําขอจากรายการที่อยู่ IP ของเว็บเซิร์ฟเวอร์ที่คุณระบุ ให้เลือกที่อยู่ IP (เว็บเซิร์ฟเวอร์, งาน Cron) จากรายการข้อจํากัดของแอปพลิเคชัน ระบุที่อยู่ IPv4 หรือ IPv6 หรือซับเน็ตอย่างน้อย 1 รายการโดยใช้ระบบ CIDR ที่อยู่ IP ต้องตรงกับที่อยู่ต้นทางซึ่งเซิร์ฟเวอร์ Google Maps Platform ตรวจพบ หากคุณใช้การแปลที่อยู่เครือข่าย (NAT) โดยปกติแล้วปัญหานี้จะเกี่ยวกับที่อยู่ IP สาธารณะของเครื่องของคุณ
    • ข้อจำกัด API:
      1. คลิกจํากัดคีย์
      2. เลือก API ตําแหน่งทางภูมิศาสตร์จากรายการแบบเลื่อนลงเลือก API หาก Geolocation API ไม่อยู่ในรายการ คุณจะต้องเปิดใช้
  4. หากต้องการเสร็จสิ้นการเปลี่ยนแปลง คลิกบันทึก

Cloud SDK

แสดงรายการคีย์ที่มีอยู่ 

gcloud services api-keys list --project="PROJECT"

ล้างข้อจํากัดที่มีอยู่ในคีย์ที่มีอยู่ 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

กําหนดข้อจํากัดใหม่ให้กับคีย์ที่มีอยู่ 

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api-target="geolocation.googleapis.com"
    --allowed-ips="IP_ADDRESS"

อ่านเพิ่มเติมเกี่ยวกับ Google Cloud SDK, การติดตั้ง Cloud SDK และคําสั่งต่อไปนี้

การเพิ่มคีย์ API ลงในคําขอ

คุณต้องรวมคีย์ API กับคําขอ API ตําแหน่งทางภูมิศาสตร์ทุกรายการ ในตัวอย่างต่อไปนี้ ให้แทนที่ YOUR_API_KEY ด้วยคีย์ API

https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_API_KEY

ต้องใช้ HTTPS สําหรับคําขอที่ใช้คีย์ API