การใช้คีย์ API

เลือกแพลตฟอร์ม: Android iOS JavaScript

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

ก่อนเริ่มใช้ Maps SDK สําหรับ Android คุณต้องมีโปรเจ็กต์ที่มีบัญชีสําหรับการเรียกเก็บเงินและ Maps SDK สําหรับ Android เปิดใช้อยู่ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อตั้งค่าใน 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 คุณต้องระบุลายนิ้วมือสําหรับใบรับรอง SHA-1 ของคีย์การลงนามที่ใช้ลงนามแอปพลิเคชัน ใบรับรองมี 2 ประเภท ได้แก่

  • ใบรับรองการแก้ไขข้อบกพร่อง: ใช้ใบรับรองประเภทนี้กับแอปที่คุณกําลังทดสอบ และรหัสอื่นๆ ที่ไม่ได้ใช้งานจริงเท่านั้น อย่าพยายามเผยแพร่แอปที่ลงนามด้วยใบรับรองการแก้ไขข้อบกพร่อง เครื่องมือ Android SDK จะสร้างใบรับรองนี้โดยอัตโนมัติเมื่อคุณเรียกใช้บิลด์การแก้ไขข้อบกพร่อง
  • เผยแพร่ใบรับรอง: ใช้ใบรับรองนี้เมื่อคุณพร้อมเปิดตัวแอปใน App Store เครื่องมือ Android SDK จะสร้างใบรับรองนี้เมื่อคุณเรียกใช้รุ่นการเผยแพร่

ดูข้อมูลเพิ่มเติมเกี่ยวกับการลงชื่อในใบรับรองและใบรับรองแอปพลิเคชัน Android ได้ในคําแนะนํารับรองแอป

สําหรับคําแนะนําในการค้นหาลายนิ้วมือของใบรับรองที่ลงนาม โปรดดูที่ข้อมูลอ้างอิงด้านล่าง

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

คอนโซล

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

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

  2. เลือกคีย์ API ที่ต้องการตั้งค่าการจํากัด หน้าพร็อพเพอร์ตี้ของคีย์ API จะปรากฏขึ้น
  3. ในส่วนการจํากัดคีย์ ให้กําหนดข้อจํากัดต่อไปนี้
    • ข้อจำกัดแอปพลิเคชัน:
      1. เลือกแอป Android
      2. คลิก + เพิ่มชื่อแพ็กเกจและลายนิ้วมือ
      3. ป้อนชื่อแพ็กเกจและลายนิ้วมือสําหรับใบรับรอง SHA-1 ตัวอย่างเช่น 
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • ข้อจำกัด API:
      1. คลิกจํากัดคีย์
      2. เลือก Maps SDK สําหรับ Android จากเมนูแบบเลื่อนลงเลือก API หาก Maps SDK สําหรับ Android ไม่อยู่ในรายการ คุณจะต้องเปิดใช้
  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-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

ขั้นตอนต่อไป

ตอนนี้คุณมีคีย์ API แล้ว ให้สร้างและกําหนดค่าโปรเจ็กต์ตามที่อธิบายไว้ในตั้งค่าโปรเจ็กต์ Android Studio