ผลิตภัณฑ์ Google Maps Platform ปลอดภัยจากการใช้งานโดยไม่ได้รับอนุญาตด้วยการจำกัดการเรียก API ไว้เฉพาะที่มอบข้อมูลรับรองการตรวจสอบสิทธิ์ที่เหมาะสมเท่านั้น ข้อมูลเข้าสู่ระบบเหล่านี้อยู่ในรูปแบบของคีย์ API ซึ่งเป็นสตริงอักขระที่เป็นตัวอักษรและตัวเลขคละกันที่ไม่ซ้ำกันซึ่งเชื่อมโยงบัญชีสำหรับการเรียกเก็บเงินของ Google กับโปรเจ็กต์ และกับ API หรือ SDK ที่เฉพาะเจาะจง
คู่มือนี้แสดงวิธีสร้าง จำกัด และใช้คีย์ API สำหรับ Google Maps Platform
ก่อนเริ่มต้น
ก่อนที่คุณจะเริ่มใช้ Places API คุณต้องมีโปรเจ็กต์ที่มีบัญชีสำหรับการเรียกเก็บเงินและเปิดใช้ Places API แล้ว ดูข้อมูลเพิ่มเติมได้ที่ตั้งค่าใน Cloud Console
การสร้างคีย์ API
คีย์ API คือตัวระบุที่ไม่ซ้ำกันซึ่งจะตรวจสอบสิทธิ์คำขอที่เชื่อมโยงกับโปรเจ็กต์เพื่อวัตถุประสงค์ในการใช้งานและการเรียกเก็บเงิน คุณต้องมีคีย์ API ที่เชื่อมโยงกับโปรเจ็กต์อย่างน้อย 1 รายการ
วิธีสร้างคีย์ API
คอนโซล
-
ไปที่หน้า Google Maps Platform > ข้อมูลเข้าสู่ระบบ
-
ในหน้าข้อมูลเข้าสู่ระบบ ให้คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
กล่องโต้ตอบคีย์ API ที่สร้างจะแสดงคีย์ API ที่คุณสร้างใหม่ -
คลิกปิด
คีย์ 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
คอนโซล
-
ไปที่หน้า Google Maps Platform > ข้อมูลเข้าสู่ระบบ
- เลือกคีย์ API ที่ต้องการตั้งค่าข้อจำกัด หน้าพร็อพเพอร์ตี้คีย์ API จะปรากฏขึ้น
- กำหนดข้อจำกัดต่อไปนี้ในส่วนข้อจำกัดสำคัญ
- ข้อจำกัดแอปพลิเคชัน:
- หากต้องการยอมรับคำขอจากรายการที่อยู่ IP ของเว็บเซิร์ฟเวอร์ที่คุณระบุ ให้เลือกที่อยู่ IP (เว็บเซิร์ฟเวอร์, งาน Cron ฯลฯ) จากรายการการจำกัดแอปพลิเคชัน ระบุที่อยู่ IPv4 หรือ IPv6 หรือซับเน็ตโดยใช้รูปแบบ CIDR อย่างน้อย 1 รายการ ที่อยู่ IP ต้องตรงกับที่อยู่ต้นทางที่เซิร์ฟเวอร์ Google Maps Platform สังเกตเห็น หากใช้ network address Translation (NAT) ปกติแล้วค่านี้มักจะสอดคล้องกับที่อยู่ IP สาธารณะของเครื่อง
- ข้อจำกัด API:
- คลิกจำกัดคีย์
- เลือก Places API หรือ Places API (ใหม่) จากเมนูแบบเลื่อนลงเลือก API โดยเลือกทั้ง 2 อย่างไม่ได้ หาก Places API หรือ Places API (ใหม่) ไม่อยู่ในรายการ คุณต้องenable
- คลิกบันทึกเพื่อสิ้นสุดการเปลี่ยนแปลง
Cloud SDK
Places API (ใหม่)
แสดงรายการคีย์ที่มีอยู่
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="places.googleapis.com" --allowed-ips="IP_ADDRESS"
อ่านเพิ่มเติมเกี่ยวกับ Google Cloud SDK , การติดตั้ง Cloud SDK และคำสั่งต่อไปนี้
Places API
แสดงรายการคีย์ที่มีอยู่
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="places-backend.googleapis.com" --allowed-ips="IP_ADDRESS"
อ่านเพิ่มเติมเกี่ยวกับ Google Cloud SDK , การติดตั้ง Cloud SDK และคำสั่งต่อไปนี้
การเพิ่มคีย์ API ในคำขอของคุณ
คุณต้องใส่คีย์ API ลงในคำขอ Places API ทุกรายการ ในตัวอย่างต่อไปนี้ ให้แทนที่ YOUR_API_KEY
ด้วยคีย์ API
https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=YOUR_API_KEY
ต้องใช้ HTTPS สำหรับคำขอที่ใช้คีย์ API