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

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

ต่อไปนี้คือสิ่งสำคัญที่สุดที่ควรเรียนรู้ เกี่ยวกับคีย์ API สำหรับ Firebase

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

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

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

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

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

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

รักษาความปลอดภัยของ Realtime Database, Cloud Firestore และ ข้อมูล Cloud Storage โดยใช้ กฎการรักษาความปลอดภัยของ Firebase อย่าพึ่งการจำกัดเพียงอย่างเดียว และ/หรือบดบังคีย์ 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 Console ตัวอย่างเช่น สำหรับการพัฒนาหรือการแก้ไขข้อบกพร่อง ดูข้อมูลเพิ่มเติมเกี่ยวกับ เวลาที่อาจได้รับการแนะนำในหน้านี้ในภายหลัง

กำลังค้นหาคีย์ API

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

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

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

• แอป Firebase บน Android — ค้นหาคีย์ API ที่จับคู่อัตโนมัติใน ไฟล์การกำหนดค่า Firebase google-services.json ใน current_key

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

การใช้คีย์ API

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

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

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

เมื่อแอปเรียกใช้ Firebase API ซึ่งต้องระบุคีย์ API โดยไคลเอ็นต์บนอุปกรณ์เคลื่อนที่/เว็บ แอปของคุณจะแสดง ไฟล์/ออบเจ็กต์การกำหนดค่า Firebase สำหรับคีย์ API ของโปรเจ็กต์ อย่างไรก็ตาม คุณสามารถ ระบุคีย์ 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 ถูกจำกัดโดยค่าเริ่มต้นไหม

จำกัดโควต้าหากคุณใช้การตรวจสอบสิทธิ์ด้วยรหัสผ่าน

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

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

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

ใช้คีย์ 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

สำคัญ: หากเปิดใช้ 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

   • Web: เลือกตัวเลือก Config แล้วหาช่อง 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 1 รายการ

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

• เว็บแอป 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 Console ใช่ไหม

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

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

ซึ่ง ต้องระบุ API ใน "ข้อจำกัด API" สำหรับคีย์ Firebase API ได้ไหม

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

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

ใช้ตารางต่อไปนี้เพื่อดูว่า API ที่เกี่ยวข้องกับ Firebase ใดที่ต้องใช้ รวมอยู่ใน "ข้อจำกัด API" สำหรับคีย์ Firebase API อย่าลืมว่า ควรใช้คีย์ 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, การรับส่งข้อความในแอป การตรวจสอบประสิทธิภาพ, การกำหนดค่าระยะไกล, Firebase ML
firebaseappcheck.googleapis.com	API ของ Firebase App Check	App Check
firebaseappdistribution.googleapis.com	API การแจกจ่ายแอป Firebase	App Distribution
firebaseapptesters.googleapis.com	API ผู้ทดสอบแอป Firebase	App Distribution
identitytoolkit.googleapis.com	Identity Toolkit API	การตรวจสอบสิทธิ์
securetoken.googleapis.com	API บริการโทเค็น	การตรวจสอบสิทธิ์
firebaserules.googleapis.com *	API กฎของ Firebase	Cloud Firestore, Cloud Storage, Realtime Database
datastore.googleapis.com	API ของ Cloud Datastore	Cloud Firestore
firestore.googleapis.com	API ของ Google Cloud Firestore	Cloud Firestore
fcmregistrations.googleapis.com	API การลงทะเบียน FCM	Cloud Messaging
firebasestorage.googleapis.com	Cloud Storage for Firebase API	Cloud Storage
firebasedynamiclinks.googleapis.com	API ลิงก์แบบไดนามิกของ Firebase	ลิงก์แบบไดนามิก
firebasehosting.googleapis.com *	API โฮสติ้งของ Firebase	โฮสติ้ง
firebaseinappmessaging.googleapis.com	API การรับส่งข้อความในแอปของ Firebase	การรับส่งข้อความในแอป
firebaseml.googleapis.com	API ของ Firebase ML	Firebase ML, Vertex AI สำหรับ Firebase
mlkit.googleapis.com **	API ของ ML Kit	Firebase ML
mobilecrashreporting.googleapis.com	Mobile Crash Reporting API	การตรวจสอบประสิทธิภาพ
play.googleapis.com	API ของ Google Play สำหรับนักพัฒนาแอป Android	การตรวจสอบประสิทธิภาพ
firebaseremoteconfig.googleapis.com	API การกำหนดค่าระยะไกลของ Firebase	การตรวจสอบประสิทธิภาพ, การกำหนดค่าระยะไกล
firebaseremoteconfigrealtime.googleapis.com	API เรียลไทม์ของการกำหนดค่าระยะไกลของ Firebase	การตรวจสอบประสิทธิภาพ, การกำหนดค่าระยะไกล
cloudconfig.googleapis.com **	ไม่มี	การกำหนดค่าระยะไกล
firebasedatabase.googleapis.com *	API ฐานข้อมูลเรียลไทม์ของ Firebase	Realtime Database

^{* จำเป็นเฉพาะในกรณีที่คุณใช้คีย์ 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 จากนั้นแทนที่ไฟล์การกำหนดค่า/ออบเจ็กต์เก่าด้วยไฟล์/ออบเจ็กต์ที่อัปเดตใหม่ ก่อนส่งไฟล์การกำหนดค่าเพื่อดาวน์โหลดหรือแสดงออบเจ็กต์การกำหนดค่าใน Console, Firebase จะตรวจสอบว่าคีย์ API ที่แสดงอยู่ จับคู่กับแอป