ดูข้อมูลเกี่ยวกับการใช้และจัดการคีย์ API สำหรับ Firebase

คีย์ API คือสตริงที่ไม่ซ้ำกันซึ่งใช้เพื่อกำหนดเส้นทางคำขอไปยัง Firebase เมื่อโต้ตอบกับ Firebase และบริการของ Google หน้านี้อธิบายถึง ข้อมูลพื้นฐานเกี่ยวกับคีย์ API รวมถึงแนวทางปฏิบัติที่ดีที่สุดสำหรับการใช้งานและ จัดการคีย์ API ด้วยแอป Firebase

สิ่งสำคัญที่สุดที่ควรทราบเกี่ยวกับคีย์ API สําหรับ Firebase มีดังนี้

• API ที่เกี่ยวข้องกับ Firebase ใช้คีย์ API เพื่อระบุโปรเจ็กต์ Firebase หรือแอปเท่านั้น ไม่ได้รับอนุญาตให้เรียก API (เช่นเดียวกับ API อื่นๆ อนุญาต) การให้สิทธิ์สำหรับ API ที่เกี่ยวข้องกับ Firebase ได้รับการจัดการแล้ว แยกต่างหากจากคีย์ API ผ่านสิทธิ์ IAM ของ Google Cloud Firebase Security Rules หรือ Firebase App Check ด้วยเหตุนี้ จึงรวมคีย์ Firebase API ไว้ในโค้ดได้เมื่อคุณใช้กับAPI ที่เกี่ยวข้องกับ Firebase เท่านั้น
• เราขอแนะนำให้คุณ ตรวจสอบและใช้ข้อจำกัดที่เหมาะสม และขีดจำกัดกับคีย์ API ทั้งหมด (รวมถึงคีย์ Firebase API ด้วย) กล่าวโดยละเอียดคือ ให้จำกัดคีย์ไว้สำหรับ API ที่คุณใช้จริงในแอปและจำกัดโควต้า (หากมี) โปรดทราบว่า ที่จัดสรรโดย Firebase ทั้งหมด คีย์ API มี "ข้อจำกัด API" ใช้โดยค่าเริ่มต้น
• ใช้คีย์ API ที่ Firebase จัดสรรเท่านั้นสําหรับAPI ที่เกี่ยวข้องกับ Firebase สําหรับ API อื่นๆ ทั้งหมด (เช่น Places API สําหรับ Maps หรือ Google AI Gemini API) ให้ใช้คีย์ API แยกต่างหาก
• เราขอแนะนำให้คุณรักษาความปลอดภัยให้กับ Realtime Database ของคุณ Cloud Firestore และ ข้อมูล Cloud Storage โดยใช้ Firebase Security Rules อย่าใช้การจํากัดคีย์ API เพียงอย่างเดียว

ข้อมูลทั่วไปเกี่ยวกับคีย์ API และ Firebase

คีย์ API สำหรับ Firebase แตกต่างจากคีย์ API ทั่วไป

คีย์ API สำหรับบริการ Firebase ไม่ได้ใช้เพื่อควบคุมการเข้าถึงทรัพยากรแบ็กเอนด์ ซึ่งทำได้ด้วย Firebase Security Rules เท่านั้น (เพื่อควบคุมผู้ใช้ปลายทางที่สามารถเข้าถึงทรัพยากร) และ Firebase App Check (เพื่อควบคุมแอปที่สามารถเข้าถึงทรัพยากร)

โดยปกติแล้ว คุณจำเป็นต้องป้องกันคีย์ API อย่างรวดเร็ว (ตัวอย่างเช่น โดยใช้บริการห้องนิรภัยหรือตั้งค่าคีย์เป็นตัวแปรสภาพแวดล้อม) อย่างไรก็ตาม คีย์ API สำหรับบริการ Firebase สามารถรวมไว้ในโค้ดหรือการกำหนดค่าที่เช็คอินได้

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

รักษาความปลอดภัยให้ Realtime Database, Cloud Firestore และ Cloud Storage ข้อมูล โดยใช้ Firebase Security Rules อย่าใช้เพียงการจํากัดและ/หรือการปิดบังคีย์ API

การสร้างคีย์ API

โปรเจ็กต์ Firebase มีคีย์ API ได้หลายรายการ โดยคีย์ API แต่ละรายการจะมีได้เพียงคีย์เดียว เชื่อมโยงกับโปรเจ็กต์ Firebase โปรเจ็กต์เดียว

Firebase จะสร้างคีย์ API สำหรับโปรเจ็กต์โดยอัตโนมัติเมื่อคุณดำเนินการ ดังต่อไปนี้:

• สร้างโปรเจ็กต์ Firebase > สร้างอัตโนมัติ Browser key รายการ
• สร้างแอป Firebase ใน Apple > สร้างอัตโนมัติ iOS key รายการ
• สร้างแอป Firebase สำหรับ Android > Android key สร้างโดยอัตโนมัติ

สำคัญ: โดยค่าเริ่มต้น คีย์ API ที่ Firebase สร้างโดยอัตโนมัติจะจำกัดอยู่ในรายการ API ที่กำหนดให้ไคลเอ็นต์ต้องระบุคีย์ API ควบคู่ไปกับคําเรียก ดูคำถามที่พบบ่อยที่ว่าคีย์ API สำหรับบริการ Firebase ถูกจํากัดโดยค่าเริ่มต้นไหม

คุณยังสร้างคีย์ API ของคุณเองในคอนโซล Google Cloud ได้ด้วย เช่น สําหรับการพัฒนาหรือการแก้ไขข้อบกพร่อง ดูข้อมูลเพิ่มเติมเกี่ยวกับเวลาที่ระบบอาจแนะนำฟีเจอร์นี้ในหน้านี้ในภายหลัง

การค้นหาคีย์ API

คุณดูและจัดการคีย์ API ทั้งหมดของโปรเจ็กต์ได้ใน API และ บริการ > ข้อมูลเข้าสู่ระบบ ในคอนโซล Google Cloud

นอกจากนี้ คุณยังดูว่าคีย์ API ใดจับคู่กับแอป Firebase โดยอัตโนมัติได้ที่ตำแหน่งต่อไปนี้ โดยค่าเริ่มต้น แอป Firebase ทั้งหมดของโปรเจ็กต์สำหรับแพลตฟอร์มเดียวกัน (Apple เทียบกับ Android เทียบกับเว็บ) จะใช้คีย์ API เดียวกัน

• แอป Apple ของ Firebase — ค้นหาคีย์ API ที่จับคู่โดยอัตโนมัติในไฟล์การกําหนดค่า Firebase GoogleService-Info.plist ในช่อง API_KEY

• แอป Android ของ Firebase - ค้นหาคีย์ API ที่ตรงกันโดยอัตโนมัติในไฟล์การกําหนดค่า Firebase google-services.json ในช่อง current_key

• เว็บแอป Firebase - ค้นหาคีย์ API ที่ตรงกันโดยอัตโนมัติในออบเจ็กต์การกําหนดค่า Firebase ในช่อง apiKey

การใช้คีย์ API

คีย์ API ใช้เพื่อระบุโปรเจ็กต์ Firebase ของคุณเมื่อโต้ตอบกับ บริการ Firebase/Google กล่าวโดยละเอียดคือ จะใช้เพื่อเชื่อมโยงคำขอ API กับโปรเจ็กต์ของคุณสำหรับโควต้าและการเรียกเก็บเงิน และยังมีประโยชน์ในการเข้าถึงข้อมูลสาธารณะด้วย

เช่น คุณสามารถใช้คีย์ API อย่างชัดเจนโดยการส่งค่าของคีย์ไปยังการเรียก REST API ในฐานะพารามิเตอร์การค้นหา ตัวอย่างนี้แสดงวิธีส่งคำขอ ไปยัง API สำหรับ Dynamic Links ลิงก์ย่อ:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=API_KEY

เมื่อแอปเรียกใช้ Firebase API ที่ต้องมีคีย์ API ที่ไคลเอ็นต์บนอุปกรณ์เคลื่อนที่/เว็บระบุไว้ แอปจะค้นหาคีย์ API ของโปรเจ็กต์ในไฟล์/ออบเจ็กต์การกําหนดค่า Firebase โดยอัตโนมัติ อย่างไรก็ตาม คุณสามารถ ระบุคีย์ API สำหรับแอปของคุณโดยใช้กลไกที่แตกต่างกัน รวมถึงสภาพแวดล้อม ตัวแปร

ตรวจสอบและใช้ข้อจำกัดที่เหมาะสมกับคีย์ API (แนะนำ)

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

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

หมายเหตุ: หากคีย์ API ที่คุณใช้สำหรับบริการ Firebase มี "ข้อจำกัด API" และคุณได้รับข้อผิดพลาด API_KEY_SERVICE_BLOCKED หรือ Forbidden 403 ให้ตรวจสอบว่าคีย์ API มีAPI ที่จำเป็นทั้งหมดรวมอยู่ในรายการที่อนุญาต "ข้อจำกัด API" ของคีย์

ตรวจสอบ API ที่เพิ่มลงในรายการที่อนุญาตโดยอัตโนมัติสําหรับคีย์ Firebase API

เมื่อ Firebase สร้างคีย์ API ในโปรเจ็กต์ของคุณ เราจะเพิ่ม"ข้อจํากัด API" ลงในคีย์นั้นโดยอัตโนมัติ API ที่เพิ่มลงในรายการที่อนุญาตนี้คือ API ที่เกี่ยวข้องกับ Firebase ซึ่งกำหนดให้ไคลเอ็นต์ระบุคีย์ API พร้อมกับการเรียกใช้ โปรดทราบว่า API ส่วนใหญ่ที่จําเป็นสําหรับการใช้บริการ Firebase ไม่จำเป็นต้องอยู่ในรายการที่อนุญาตสําหรับคีย์ API

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

หมายเหตุ: ในช่วงเดือนพฤษภาคม 2024 Firebase จะใช้ข้อจำกัด API กับ คีย์ API ที่มีอยู่และที่ไม่จำกัด ซึ่งจัดสรรโดย Firebase ดูข้อมูลเพิ่มเติมในคำถามที่พบบ่อยที่ว่าคีย์ API สำหรับบริการ Firebase ถูกจํากัดโดยค่าเริ่มต้นไหม

จำกัดโควตาให้น้อยลงหากคุณใช้ Authentication ตามรหัสผ่าน

ไม่ว่าคุณจะใช้ตัวเลือกการตรวจสอบสิทธิ์ใดก็ตาม ให้รักษาความปลอดภัยให้กับ Realtime Database, Cloud Firestore และ Cloud Storage ข้อมูลโดยใช้ Firebase Security Rules

หากคุณใช้ Firebase Authentication แบบใช้รหัสผ่านและมีคนใช้ API ของคุณ ผู้ใช้จะไม่สามารถเข้าถึงฐานข้อมูลของโปรเจ็กต์ Firebase ทั้งหมด หรือ Cloud Storage ตราบใดที่ข้อมูลนี้ได้รับการคุ้มครองโดย Firebase Security Rules อย่างไรก็ตาม พวกเขาสามารถใช้คีย์ API ของคุณเพื่อเข้าถึง ปลายทางการตรวจสอบสิทธิ์ของ Firebase และส่งคำขอการตรวจสอบสิทธิ์กับ โปรเจ็กต์ของคุณ

เพื่อลดความเสี่ยงที่ผู้อื่นอาจใช้คีย์ API ในทางที่ผิด ในการโจมตีแบบบรูตฟอร์ซ คุณจะสามารถลดโควต้าเริ่มต้นของ identitytoolkit.googleapis.com ปลายทางเพื่อแสดงการรับส่งข้อมูลปกติ ความคาดหวังของแอปของคุณได้ โปรดทราบว่าหากคุณจำกัดโควต้านี้และแอปของคุณ ได้ผู้ใช้เพิ่มขึ้นอย่างกะทันหัน คุณอาจได้รับข้อผิดพลาดในการลงชื่อเข้าใช้จนกว่าจะเพิ่มโควต้า คุณสามารถเปลี่ยนโควต้า API ของโปรเจ็กต์ได้ใน คอนโซล Google Cloud

ใช้คีย์ API ที่จำกัดแยกต่างหากสำหรับบริการที่ไม่ใช่ Firebase

แม้ว่าโดยทั่วไปแล้วคีย์ API ที่ใช้สําหรับบริการ Firebase ไม่จำเป็นต้องเก็บไว้เป็นความลับ แต่คุณควรใช้ความระมัดระวังเพิ่มเติมกับคีย์ API ที่ใช้กับ Google Cloud API อื่นๆ

หากคุณใช้ Google Cloud API (ในแพลตฟอร์มใดก็ตาม) ที่ไม่ใช่สำหรับ Firebase เราขอแนะนำอย่างยิ่งให้สร้างคีย์ API แยกต่างหากและมีข้อจำกัด เพื่อใช้กับ API เหล่านั้น ซึ่งมีความสำคัญโดยเฉพาะอย่างยิ่งหาก API ใช้สำหรับ บริการ Google Cloud ที่เรียกเก็บเงินได้

เช่น หากคุณใช้ Firebase ML และ Cloud Vision API ใน iOS คุณควรสร้างคีย์ API แยกต่างหากเพื่อใช้เข้าถึง Cloud Vision API เท่านั้น

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

ดูวิธีการสร้างคีย์เฉพาะ API

วิธีการเหล่านี้อธิบายวิธีสร้างคีย์ API แบบจำกัดที่แยกต่างหากสำหรับ fake API ที่ชื่อ Super Service API

ขั้นตอนที่ 1: กำหนดค่าคีย์ API ที่มีอยู่เพื่อไม่ให้สิทธิ์การเข้าถึง Super Service API

1. เปิดข้อมูลเข้าสู่ระบบ ของคอนโซล Google Cloud เลือกโปรเจ็กต์เมื่อได้รับข้อความแจ้ง

2. สำหรับคีย์ API ที่มีอยู่ในรายการ ให้เปิดมุมมองการแก้ไข

3. ในส่วนการจํากัด API ให้เลือกจํากัดคีย์ จากนั้นเพิ่ม API ทั้งหมดที่คุณต้องการให้คีย์ API มีสิทธิ์เข้าถึงลงในรายการ ตรวจสอบว่า เพื่อไม่รวม API ที่คุณจะสร้างคีย์ API แยกต่างหาก (ในตัวอย่างนี้คือ Super Service API)

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

ตอนนี้คีย์ API ที่มีอยู่จะไม่ให้สิทธิ์เข้าถึง Super Service API แต่คีย์แต่ละรายการจะยังคงใช้งานได้กับ API ที่คุณเพิ่มลงในรายการข้อจํากัด API ของ Super Service API

สำคัญ: หากเปิดใช้ API เพิ่มเติมในอนาคต คุณต้องเพิ่ม API เหล่านั้นลงในรายการข้อจำกัด API ของคีย์ API ที่เกี่ยวข้อง

ขั้นตอนที่ 2: สร้างและใช้คีย์ API ใหม่สำหรับการเข้าถึง Super Service API

1. กลับไปที่หน้าข้อมูลเข้าสู่ระบบ ตรวจสอบว่ายังเลือกโปรเจ็กต์ Firebase อยู่

2. คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API โปรดจดบันทึกคีย์ API ใหม่ จากนั้น ให้คลิกจำกัดคีย์

3. ในส่วนการจํากัด API ให้เลือกจํากัดคีย์ จากนั้นเพิ่ม Super Service API เท่านั้นลงในรายการ

   คีย์ API ใหม่นี้จะให้สิทธิ์เข้าถึงเฉพาะ Super Service API เท่านั้น

4. กำหนดค่าแอปและบริการให้ใช้คีย์ API ใหม่

ใช้คีย์ API สำหรับสภาพแวดล้อมที่เฉพาะเจาะจง (แนะนำ)

หากคุณตั้งค่าโปรเจ็กต์ Firebase ที่แตกต่างกันสําหรับสภาพแวดล้อมที่แตกต่างกัน เช่น การทดลองใช้และเวอร์ชันที่ใช้งานจริง อินสแตนซ์แอปแต่ละรายการต้องโต้ตอบกับโปรเจ็กต์ Firebase ที่เกี่ยวข้อง ตัวอย่างเช่น อินสแตนซ์ของแอปทดลองใช้ควร อย่าพูดคุยกับโปรเจ็กต์ Firebase เวอร์ชันที่ใช้งานจริง ซึ่งหมายความว่าแอปที่ใช้เวอร์ชันที่เตรียมใช้งานต้องใช้คีย์ API ที่เชื่อมโยงกับโปรเจ็กต์ Firebase ที่ใช้เวอร์ชันที่เตรียมใช้งาน

หากต้องการลดปัญหาในการโปรโมตการเปลี่ยนแปลงโค้ดจากการพัฒนาไปยังช่วงเตรียมความพร้อมและไปยังเวอร์ชันที่ใช้งานจริง ให้ตั้งค่าคีย์ API เป็นตัวแปรสภาพแวดล้อมหรือรวมไว้ในไฟล์การกําหนดค่าแทนการรวมไว้ในโค้ด

โปรดทราบว่าหากใช้ Firebase Local Emulator Suite สําหรับการพัฒนาควบคู่ไปกับ Firebase ML คุณต้องสร้างและใช้คีย์ API สําหรับแก้ไขข้อบกพร่องเท่านั้น คำสั่ง สำหรับการสร้างคีย์ประเภทนั้น จะอยู่ใน Firebase ML เอกสาร

คำถามที่พบบ่อยและการแก้ปัญหา

คำถามที่พบบ่อย

คีย์ API สำหรับบริการ Firebase ถูกจํากัดโดยค่าเริ่มต้นไหม

ใช่ โดยค่าเริ่มต้น คีย์ API ทั้งหมดที่ Firebase จัดสรรโดยอัตโนมัติเพื่อใช้กับ API ที่เกี่ยวข้องกับ Firebase จะมี"ข้อจํากัด API" มีผลโดยอัตโนมัติ ดูรายการ API ที่เกี่ยวข้องกับ Firebase ที่อยู่ในรายการที่อนุญาตนี้

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

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

สำคัญ: API ที่เกี่ยวข้องกับ Firebase ไม่มีที่ใช้คีย์ API เป็นการให้สิทธิ์ ในการเรียก API คีย์ API ที่ส่งไปพร้อมกับการเรียก API จะใช้เพื่อระบุโปรเจ็กต์หรือแอป Firebase เท่านั้น

คุณดูคีย์ API ทั้งหมดและ "ข้อจํากัด API" ของคีย์เหล่านั้นได้ในแผงAPI และบริการ > ข้อมูลเข้าสู่ระบบ ในคอนโซล Google Cloud

โปรดทราบข้อมูลต่อไปนี้เกี่ยวกับวิธีที่ Firebase ใช้ "ข้อจํากัดของ API" เหล่านี้

• ตั้งแต่เดือนพฤษภาคม 2024 เป็นต้นไป คีย์ API ใหม่ทั้งหมดที่ Firebase จัดสรรโดยอัตโนมัติจะจำกัดไว้ที่รายการ API ที่เกี่ยวข้องกับ Firebase โดยอัตโนมัติ

• ในช่วงเดือนพฤษภาคม 2024 คีย์ API ที่มีอยู่ทั้งหมดและไม่จำกัดที่ Firebase มี ที่จัดสรรโดยอัตโนมัติก่อนหน้านี้ถูกจำกัดไว้เฉพาะ รายการ API ที่เกี่ยวข้องกับ Firebase และ API ใดๆ ของโปรเจ็กต์ที่เปิดใช้อยู่ในปัจจุบัน

• คีย์ API ที่มีอยู่และถูกจํากัดอยู่แล้วซึ่ง Firebase ได้จัดสรรโดยอัตโนมัติก่อนหน้านี้จะไม่มีการเปลี่ยนแปลง

• คีย์ API ที่มีอยู่ซึ่ง Firebase ไม่ได้จัดสรรโดยอัตโนมัติจะไม่มีการเปลี่ยนแปลง

สำคัญ: หากคุณใช้ Google Cloud API (บนแพลตฟอร์มใดก็ตาม) ที่ไม่ใช่สำหรับ เราขอแนะนำเป็นอย่างยิ่งให้ใช้บริการ / ผลิตภัณฑ์ Firebase การสร้างคีย์ API แยกต่างหากและถูกจำกัด เพื่อใช้กับ API เหล่านั้น

ฉันจะระบุคีย์ API ได้อย่างไร เชื่อมโยงกับแอป Firebase ของฉันไหม

คุณใช้ตัวเลือกใดก็ได้ต่อไปนี้เพื่อระบุว่าคีย์ API ใดเชื่อมโยงกับแอป Firebase

คอนโซล Firebase

1. ไปที่ การตั้งค่าโปรเจ็กต์ จากนั้นเลื่อนลงไปที่การ์ดแอปของคุณ

2. เลือกแอปที่สนใจ

3. รับไฟล์/ออบเจ็กต์การกำหนดค่า Firebase สำหรับแอปที่สนใจ จากนั้น ค้นหาคีย์ API:

   • Apple: ดาวน์โหลด GoogleService-Info.plist แล้วค้นหาช่อง API_KEY

   • Android: ดาวน์โหลด google-services.json ค้นหาค่ากำหนดสำหรับ แอปที่คุณสนใจ (มองหาชื่อแพ็กเกจ) แล้วหา ช่อง current_key

   • เว็บ: เลือกตัวเลือกกําหนดค่า แล้วค้นหาช่อง apiKey

Firebase CLI

1. รับไฟล์/ออบเจ็กต์การกําหนดค่า Firebase สําหรับแอปที่ต้องการโดยเรียกใช้คําสั่งต่อไปนี้

   firebase apps:sdkconfig PLATFORM FIREBASE_APP_ID

   • PLATFORM (ข้อใดข้อหนึ่ง): IOS | ANDROID | WEB
   • FIREBASE_APP_ID: ตัวระบุที่ไม่ซ้ำกันที่ Firebase กำหนดให้สำหรับ แอป Firebase (ค้นหารหัสแอป)

2. ในการกำหนดค่า Firebase ที่พิมพ์ของแอป ให้ค้นหาคีย์ API ของแอปดังนี้

   • Apple: หาช่อง API_KEY

   • Android: ค้นหาค่ากำหนดสำหรับแอปที่สนใจ (มองหา ชื่อแพ็กเกจ) แล้วหาฟิลด์ current_key

   • เว็บ: ค้นหาช่อง apiKey

REST API

1. รับ apiKeyId (UID) ของคีย์ API โดยการเรียกใช้การเรียก ปลายทางที่เกี่ยวข้องสำหรับแอปที่สนใจ แล้วส่ง apiKeyId ไปยังขั้นตอนถัดไป

   • Apple: โทรหา projects.iosApps.get
   • Android: โทรหา projects.androidApps.get
   • เว็บ: โทร projects.webApps.get

2. รับสตริงคีย์ API โดยการเรียกใช้ projects.locations.keys.getKeyString

   keyString นี้เป็นค่าเดียวกับที่พบในแท็ก อาร์ติแฟกต์การกำหนดค่า (Apple | Android | เว็บ)

ฉันมีคีย์ API 2 รายการแสดงสําหรับแอป Firebase เดียวกันในไฟล์/ออบเจ็กต์การกําหนดค่า Firebase ได้ไหม

• แอป Firebase สำหรับ Apple - แอปแต่ละแอปมีไฟล์การกําหนดค่าของตนเองและแสดงคีย์ API ได้เพียงรายการเดียว

• แอป Android ใน Firebase — แอป Android ทั้งหมดในโปรเจ็กต์ Firebase จะแสดงอยู่ในไฟล์การกําหนดค่าเดียวกัน และแอปแต่ละแอปจะมีคีย์ API แสดงอยู่ได้เพียงรายการเดียว อย่างไรก็ตาม แอปแต่ละแอปในไฟล์การกําหนดค่านี้อาจมีคีย์ที่ต่างกัน

• เว็บแอป Firebase — แต่ละแอปจะมีอ็อบเจ็กต์การกำหนดค่าของตัวเองและมีได้เพียง แสดงรายการคีย์ API 1 รายการ

แต่คุณสามารถใช้คีย์ API หลายรายการกับแอปเดียวได้ คุณต้องระบุกลไกให้แอปเข้าถึงคีย์ API อื่นๆ เหล่านี้ เช่น ผ่านตัวแปรสภาพแวดล้อม กลไกในการเข้าถึงคีย์ API อื่นๆ ต้องไม่อ้างอิงคีย์เหล่านั้น คีย์ API แสดงอยู่ในไฟล์/ออบเจ็กต์การกำหนดค่า Firebase

Firebase ทำงานอย่างไร รู้ว่าคีย์ API ใดจับคู่กับแอป (เช่น ในการกำหนดค่า Firebase ไฟล์/ออบเจ็กต์) หรือไม่

เมื่อคุณรับไฟล์/ออบเจ็กต์การกําหนดค่า Firebase ของแอปเป็นครั้งแรก Firebase จะตรวจสอบว่ามีคีย์ API ใดอยู่ในโปรเจ็กต์ที่มี"ข้อจํากัดของแอปพลิเคชัน" ที่ตรงกับแอปหรือไม่ (เช่น รหัสแพ็กเกจที่ตรงกันสําหรับแอป Apple)

หาก Firebase ไม่พบคีย์ที่จำกัดที่ตรงกัน ระบบจะแสดงคีย์นั้นไว้ใน ไฟล์การกำหนดค่า/ออบเจ็กต์ iOS key สำหรับแอป Apple และ Android key สำหรับ แอป Android และ Browser key สำหรับเว็บแอป (หากมีคีย์เหล่านี้อยู่ และไม่มี "ข้อจำกัดของแอปพลิเคชัน" ที่ทำให้ไม่จับคู่กับ แอป)

ฉันสามารถดำเนินการด้วยตัวเองได้ไหม ลบคีย์และฟิลด์ API ออกจากไฟล์/ออบเจ็กต์การกำหนดค่า Firebase ไหม

ได้ คุณลบคีย์ API ออกจากไฟล์/ออบเจ็กต์การกำหนดค่าได้ด้วยตัวเอง อย่างไรก็ตาม คุณต้องระบุกลไกอื่นๆ เพื่อให้แอปเข้าถึงคีย์ API ได้ (เช่น ผ่านตัวแปรสภาพแวดล้อม) มิเช่นนั้น การเรียกบริการ Firebase ทั้งหมด จะล้มเหลว

ฉันสามารถดำเนินการด้วยตัวเองได้ไหม แก้ไขไฟล์/ออบเจ็กต์การกำหนดค่า Firebase ด้วยคีย์ API อื่นไหม

ได้ คุณสามารถแก้ไขไฟล์/ออบเจ็กต์การกำหนดค่าเพื่อเชื่อมโยงคีย์ API อื่นด้วยตนเองได้ กับแอป

การแก้ไขคีย์ API ในการกำหนดค่า Firebase ด้วยตนเอง เป็นไฟล์/object ได้ แต่ไม่แนะนำ เนื่องจากจะเพิ่มโอกาสที่จะเกิดปัญหาในการเข้าถึงบริการ Firebase อย่างไรก็ตาม หากเลือกแก้ไขไฟล์/ออบเจ็กต์การกําหนดค่า ให้ทําดังนี้

• ตรวจสอบว่าคีย์ API มีขอบเขตเป็นรหัสโปรเจ็กต์ที่แสดงในไฟล์/ออบเจ็กต์การกําหนดค่า
• ตรวจสอบว่าไม่มี "ข้อจำกัดของคีย์ API" ที่จะขัดขวางการใช้ API คีย์ที่ใช้กับแอปนั้นด้วย
• ตรวจสอบว่าคีย์ API มี "ข้อจํากัด API" ที่เหมาะสม ดูรายการ API ที่เกี่ยวข้องกับ Firebase ที่ต้องอยู่ในรายการที่อนุญาตสําหรับบริการ/ผลิตภัณฑ์ Firebase แต่ละรายการ

โปรดทราบว่าหากคุณรับไฟล์/ออบเจ็กต์การกําหนดค่าของแอปอีกครั้งจากคอนโซล ระบบจะแสดงคีย์ API ที่Firebase จับคู่กับแอปนั้นโดยอัตโนมัติเสมอ คุณจึงต้องแก้ไขด้วยตนเองอีกครั้งตามต้องการ

ฉันจะย้าย คีย์ API จากโปรเจ็กต์ Firebase หนึ่งไปยังอีกโปรเจ็กต์หนึ่งใช่ไหม

ไม่ได้ คีย์ API จะระบุเฉพาะโปรเจ็กต์หนึ่งๆ เท่านั้นและย้ายไปยังโปรเจ็กต์อื่นไม่ได้

จะเกิดอะไรขึ้นหากฉัน ลบคีย์ API ที่ระบุไว้ในคอนโซล Google Cloud ไหม

หากคุณลบคีย์ API ที่มีแอปใช้งานอยู่ การเรียก API จากแอปนั้น จะล้มเหลว คุณอาจได้รับรายงาน อีเมล หรือข้อผิดพลาดที่ระบุว่าคุณพยายามใช้คีย์ API ที่ไม่ถูกต้อง

การลบคีย์ API เป็นการดำเนินการแบบถาวรและยกเลิกไม่ได้

API ใดบ้างที่ต้องอยู่ในรายการที่อนุญาต "ข้อจํากัด API" สําหรับคีย์ API ของ Firebase

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

สำคัญ: API ที่เกี่ยวข้องกับ Firebase ไม่มีที่ใช้คีย์ API เป็นการให้สิทธิ์ ในการเรียก API คีย์ API ที่ส่งไปพร้อมกับการเรียก API จะใช้เพื่อระบุโปรเจ็กต์หรือแอป Firebase เท่านั้น

ใช้ตารางต่อไปนี้เพื่อระบุว่า API ใดที่เกี่ยวข้องกับ Firebase ที่ต้องรวมไว้ในรายการที่อนุญาต "การจํากัด API" สําหรับคีย์ API ของ Firebase อย่าลืมว่า ควรใช้คีย์ Firebase API กับบริการ Firebase เท่านั้น ดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างคีย์ API ที่จำกัดแยกต่างหากสำหรับ API บางประเภท

คุณสามารถดูและจัดการคีย์ API ของโปรเจ็กต์ได้ในแผงAPI และบริการ > ข้อมูลเข้าสู่ระบบ ในคอนโซล Google Cloud

หมายเหตุ: หากได้รับข้อผิดพลาด API_KEY_SERVICE_BLOCKED หรือ Forbidden 403 และพยายามเรียก API ที่เกี่ยวข้องกับ Firebase และคีย์ API ที่คุณใช้อยู่ API ที่จำเป็นซึ่งระบุไว้ในตารางนี้ โปรดติดต่อ ทีมสนับสนุน Firebase

ชื่อ API (ชื่อบริการ)	ชื่อที่แสดงของ API	บริการ / ผลิตภัณฑ์ Firebase ที่เชื่อมโยง
firebase.googleapis.com	Firebase Management API	ผลิตภัณฑ์ทั้งหมด
logging.googleapis.com	Cloud Logging API	ผลิตภัณฑ์ทั้งหมด
firebaseinstallations.googleapis.com	API การติดตั้ง Firebase	Cloud Messaging Crashlytics In-App Messaging Performance Monitoring Remote Config Firebase ML
firebaseappcheck.googleapis.com	Firebase App Check API	App Check
firebaseappdistribution.googleapis.com	Firebase App Distribution API	App Distribution
firebaseapptesters.googleapis.com	API ผู้ทดสอบแอป Firebase	App Distribution
identitytoolkit.googleapis.com	Identity Toolkit API	Authentication
securetoken.googleapis.com	API บริการโทเค็น	Authentication
firebaserules.googleapis.com *	Firebase Rules API	Cloud Firestore, Cloud Storage, Realtime Database
datastore.googleapis.com	API ของ Cloud Datastore	Cloud Firestore
firestore.googleapis.com	Google Cloud Firestore API	Cloud Firestore
fcmregistrations.googleapis.com	API การลงทะเบียน FCM	Cloud Messaging
firebasestorage.googleapis.com	Cloud Storage for Firebase API	Cloud Storage
firebasedynamiclinks.googleapis.com	API ลิงก์แบบไดนามิกของ Firebase	Dynamic Links
firebasehosting.googleapis.com *	Firebase Hosting API	Hosting
firebaseinappmessaging.googleapis.com	API การรับส่งข้อความในแอปของ Firebase	In-App Messaging
firebaseml.googleapis.com	Firebase ML API	Firebase ML
mlkit.googleapis.com **	API ของ ML Kit	Firebase ML
mobilecrashreporting.googleapis.com	Mobile Crash Reporting API	Performance Monitoring
play.googleapis.com	API ของ Google Play สำหรับนักพัฒนาแอป Android	Performance Monitoring
firebaseremoteconfig.googleapis.com	Firebase Remote Config API	Performance Monitoring, Remote Config
firebaseremoteconfigrealtime.googleapis.com	API เรียลไทม์ของการกำหนดค่าระยะไกลของ Firebase	Performance Monitoring, Remote Config
cloudconfig.googleapis.com **	ไม่มี	Remote Config
firebasedatabase.googleapis.com *	API ฐานข้อมูลเรียลไทม์ของ Firebase	Realtime Database
firebasevertexai.googleapis.com	Vertex AI ใน Firebase API	Vertex AI in Firebase

^{* ต้องระบุเฉพาะในกรณีที่คุณใช้คีย์ Firebase API กับเครื่องมือของบุคคลที่สามหรือการเข้าถึง REST โดยตรงไปยังบริการ/ผลิตภัณฑ์ Firebase}

^{** จำเป็นสำหรับ SDK ของผลิตภัณฑ์เวอร์ชันก่อนหน้า หากคุณกำลังใช้ ของ SDK เวอร์ชันล่าสุด API นี้ไม่จำเป็นต้องอยู่ใน จากรายการที่อนุญาต}

การแก้ปัญหา

ฉันจะแก้ไขข้อผิดพลาด API_KEY_SERVICE_BLOCKED หรือข้อผิดพลาด 403 "ไม่อนุญาต" ที่ระบุว่าคำขอไปยัง API นี้ถูกบล็อกได้อย่างไร

ทำตามคำแนะนำในคำถามที่พบบ่อยนี้หากคุณได้รับAPI_KEY_SERVICE_BLOCKEDข้อผิดพลาดหรือข้อผิดพลาดที่มีลักษณะดังต่อไปนี้

Forbidden: 403 POST https://example-service.googleapis.com/method: Requests to this API example-service.googleapis.com method google.example-service.rest.method are blocked.

คีย์ API ที่แอปของคุณใช้เพื่อเรียก API "การจำกัด API" และรายการที่อนุญาตของคีย์ไม่มี API นั้น

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

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

ฉันจะแก้ไขข้อผิดพลาดนี้ได้อย่างไร "ดึงข้อมูลรหัสการวัดของแอป Firebase นี้จากเซิร์ฟเวอร์ไม่สำเร็จ"

คีย์ API ที่เว็บแอปใช้อาจมี "ข้อจำกัดของ API" มาใช้กับโทรศัพท์ ในกรณีนี้ ให้ตรวจสอบว่า Firebase Management API อยู่ในรายการ API ที่อนุญาต

ฉันได้รับอีเมลหรือข้อผิดพลาดที่ คีย์ API ของฉันไม่ถูกต้อง เกิดอะไรขึ้นและฉันจะแก้ไขปัญหานี้ได้อย่างไร

สาเหตุที่พบบ่อยที่สุดบางประการสำหรับคีย์ API ที่ไม่ถูกต้องมีดังนี้

• คีย์ API มี "ข้อจำกัดของคีย์ API" ใช้กับคีย์ที่ทำให้จับคู่กับแอปที่พยายามใช้คีย์ไม่ได้ ("Application Restrictions") หรือไม่สามารถใช้ได้สำหรับ API ที่เรียก ("API ข้อจำกัด")

• ลบคีย์ API ออกจากโปรเจ็กต์ในคอนโซล Google Cloud แล้ว

• ระบบไม่ได้สร้างคีย์ API สำหรับรหัสโปรเจ็กต์ที่แสดงในไฟล์/ออบเจ็กต์การกําหนดค่า Firebase ของแอป

วิธีหนึ่งในการแก้ไขปัญหานี้คือรับไฟล์/ออบเจ็กต์การกําหนดค่า Firebase เวอร์ชันอัปเดตของแอป แล้วแทนที่ไฟล์/ออบเจ็กต์การกําหนดค่าเก่าด้วยไฟล์/ออบเจ็กต์ที่อัปเดตใหม่ ก่อนที่จะส่งไฟล์การกําหนดค่าให้ดาวน์โหลดหรือแสดงออบเจ็กต์การกําหนดค่าในคอนโซล Firebase จะตรวจสอบว่าคีย์ API ที่แสดงตรงกับแอป