การใช้คีย์ API

การสร้างคีย์ 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 และคำสั่งต่อไปนี้

• gcloud alpha services api-keys create

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

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

เมื่อจำกัดคีย์ API ใน Cloud Console ข้อจำกัดของแอปพลิเคชันจะลบล้าง API ที่เปิดใช้ภายใต้การจำกัด API ทำตามแนวทางปฏิบัติแนะนำโดยการสร้างคีย์ API แยกต่างหากสำหรับแต่ละแอป และสำหรับแต่ละแพลตฟอร์มที่แอปนั้นพร้อมใช้งาน

เมื่อคุณจำกัดคีย์ API คุณต้องระบุลายนิ้วมือสำหรับใบรับรอง SHA-1 ของคีย์ Signing ที่ใช้เพื่อรับรองแอปพลิเคชัน มีใบรับรอง 2 ประเภท ได้แก่

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

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

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

• หากคุณใช้ Play App Signing โปรดดูการทำงานร่วมกับผู้ให้บริการ API
• หากคุณจัดการคีย์ Signing ของคุณเอง โปรดดูการลงนามแอปพลิเคชันด้วยตนเอง หรือดูวิธีการสำหรับสภาพแวดล้อมของบิลด์

วิธีจำกัดคีย์ 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. เลือก API การนำทางจากเมนูแบบเลื่อนลงเลือก API หากไม่มี Navigation SDK ในรายการ คุณจะต้องenable SDK ดังกล่าว
หมายเหตุ:ขณะนี้ Navigation SDK พร้อมให้บริการแก่ลูกค้าบางรายเท่านั้น คุณต้องเปิดใช้สำหรับ SDK จึงจะเพิ่มลงในโปรเจ็กต์ Google Cloud และคีย์ 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-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list