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

นักพัฒนาแอปในเขตเศรษฐกิจยุโรป (EEA)

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

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

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

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

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

คอนโซล

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

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

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

Cloud SDK

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

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

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

Google ขอแนะนําอย่างยิ่งให้คุณจํากัดคีย์ API โดยจํากัดการใช้งานไว้เฉพาะ 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. เลือก Routes API จากเมนูแบบเลื่อนลงเลือก API หาก Routes API ไม่อยู่ในรายการ คุณจะต้องเปิดใช้
  4. คลิกบันทึกเพื่อทําการเปลี่ยนแปลงให้เสร็จสมบูรณ์

Cloud SDK

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

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

ล้างข้อจำกัดที่มีอยู่สำหรับคีย์ที่มีอยู่ 

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

ตั้งข้อจำกัดใหม่ให้กับคีย์ที่มีอยู่ 

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=routes.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

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

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

https://routes.googleapis.com/directions/v2:computeRoutes?key=YOUR_API_KEY

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