การใช้คีย์ 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 ในคอนโซลระบบคลาวด์ การจํากัดแอปพลิเคชันจะลบล้าง API ที่เปิดใช้ในส่วนการจํากัด API ทำตามแนวทางปฏิบัติแนะนำโดยสร้างคีย์ API แยกต่างหากสำหรับแต่ละแอปและสำหรับแต่ละแพลตฟอร์มที่แอปนั้นพร้อมให้บริการ

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

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

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

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

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

วิธีจํากัดคีย์ 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. เลือก Navigation SDK จากเมนูแบบเลื่อนลงเลือก API หาก Navigation SDK ไม่แสดงในรายการ คุณต้องเปิดใช้ SDK ดังกล่าว
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/locations/global/keys/KEY_ID \
    --api-target=service=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

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

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

ตั้งค่าโปรเจ็กต์ Android Studio