การใช้คีย์ API

เลือกแพลตฟอร์ม แอนดรอยด์ 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"

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

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

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

เมื่อคุณจำกัดคีย์ API คุณต้องระบุลายนิ้วมือสำหรับใบรับรอง SHA-1 ของ คีย์ Signing ที่ใช้เพื่อรับรองแอปพลิเคชัน มีใบรับรอง 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"

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

ขั้นตอนถัดไป

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