ใช้คีย์ API กับ Distance Matrix API (เดิม)

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

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

ก่อนเริ่มต้น

ก่อนที่จะเริ่มใช้ Distance Matrix API (เดิม) คุณต้องมีโปรเจ็กต์ที่มีบัญชีสำหรับการเรียกเก็บเงินและเปิดใช้ Distance Matrix API (เดิม) ดูข้อมูลเพิ่มเติมได้ที่ตั้งค่าในคอนโซล Cloud

สร้างคีย์ 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 นี้จะสอดคล้องกับที่อยู่ IP สาธารณะของเครื่อง
    • ข้อจำกัด API:
      1. คลิกจำกัดคีย์
      2. เลือก Distance Matrix API (เดิม) จากเมนูแบบเลื่อนลงเลือก API หาก Distance Matrix 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=distance-matrix-backend.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

เพิ่มคีย์ API ลงในคำขอ

คุณต้องใส่คีย์ API ในคำขอ Distance Matrix API (เดิม) ทุกรายการ ในตัวอย่างต่อไปนี้ ให้แทนที่ YOUR_API_KEY ด้วยคีย์ API ของคุณ

https://maps.googleapis.com/maps/api/distancematrix/json?origins=Seattle&destinations=San+Francisco&key=YOUR_API_KEY

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