ใช้คีย์ API

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

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

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

ก่อนเริ่มใช้ Maps Embed API คุณต้องมีโปรเจ็กต์ที่มีบัญชีสำหรับการเรียกเก็บเงินและ เปิดใช้ Maps Embed 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"

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

จำกัดคีย์ API

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

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

คอนโซล

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

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

  2. เลือกคีย์ API ที่ต้องการตั้งค่าข้อจำกัด หน้าพร็อพเพอร์ตี้คีย์ API จะปรากฏขึ้น
  3. ใต้ข้อจำกัดของคีย์ ให้กำหนดข้อจำกัดต่อไปนี้
    • ข้อจำกัดแอปพลิเคชัน:
      1. หากต้องการยอมรับคำขอจากรายการเว็บไซต์ที่คุณระบุ ให้เลือก HTTP ที่มา (เว็บไซต์) จากรายการแอปพลิเคชัน ข้อจำกัด
      2. ระบุเว็บไซต์อ้างอิงอย่างน้อย 1 เว็บไซต์ คุณใช้ไวลด์การ์ดได้ เพื่อให้สิทธิ์โดเมนย่อยทั้งหมด (เช่น https://*.google.com ยอมรับเว็บไซต์ทั้งหมดที่ลงท้ายด้วย .google.com เมื่อเข้าถึงผ่าน HTTPS) โปรดทราบว่าหากคุณระบุ www.domain.com โดเมนจะทำหน้าที่เป็นไวลด์การ์ด www.domain.com/* และ ให้สิทธิ์เส้นทางย่อยในชื่อโฮสต์นั้น เฉพาะรูปแบบ URL ที่มา https:// และ http:// เท่านั้น ที่รองรับ
    • ข้อจำกัด API:
      1. คลิกจำกัดคีย์
      2. เลือก Maps Embed API จากเมนูแบบเลื่อนลงของเลือก API หากไม่มี Maps Embed API ในรายการ คุณจะต้อง เปิดใช้
      3. หากโครงการของคุณใช้ Places Library ให้เลือก Places API ด้วย ในทำนองเดียวกัน หากโปรเจ็กต์ใช้บริการอื่นๆ ใน JavaScript API (บริการเส้นทาง บริการเมทริกซ์ระยะทาง บริการยกระดับ และ/หรือ บริการเข้ารหัสพิกัดภูมิศาสตร์) คุณต้องเปิดใช้และเลือก 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="maps-embed-backend.googleapis.com"
    --allowed-referrers="referer"

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

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

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

  https://www.google.com/maps/embed/v1/MAP_MODE?key=YOUR_API_KEY&parameters