Google is committed to advancing racial equity for Black communities. See how.
หน้านี้ได้รับการแปลโดย Cloud Translation API
Switch to English

อนุญาตส่งคำขอ

คำขอที่ส่งไปยัง FCM จากเซิร์ฟเวอร์แอปหรือสภาพแวดล้อมที่เชื่อถือได้ต้องได้รับอนุญาต สังเกตความแตกต่างที่สำคัญเหล่านี้ระหว่างการอนุญาต HTTP ดั้งเดิมและ HTTP v1 API:

  • FCM HTTP v1 API อนุญาตคำขอที่มีโทเค็นการเข้าถึง OAuth 2.0 ที่มีอายุสั้น ในการสร้างโทเค็นนี้คุณสามารถใช้ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน Google (ในสภาพแวดล้อมเซิร์ฟเวอร์ของ Google) และ / หรือรับข้อมูลรับรองที่จำเป็นด้วยตนเองจากไฟล์คีย์ส่วนตัว JSON ที่สร้างขึ้นสำหรับบัญชีบริการ หากคุณใช้ Firebase Admin SDK เพื่อส่งข้อความไลบรารีจะจัดการโทเค็นให้คุณ
  • โปรโตคอลเดิมใช้ได้เฉพาะคีย์ API ที่มีอายุการใช้งานยาวนานที่ได้รับจากคอนโซล Firebase

อนุญาต HTTP v1 ส่งคำขอ

ขึ้นอยู่กับรายละเอียดของสภาพแวดล้อมเซิร์ฟเวอร์ของคุณใช้กลยุทธ์เหล่านี้ร่วมกันเพื่ออนุญาตคำขอของเซิร์ฟเวอร์ไปยังบริการ Firebase:

  • ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน Google (ADC)
  • ไฟล์ JSON ของบัญชีบริการ
  • โทเค็นการเข้าถึง OAuth 2.0 อายุสั้นที่ได้มาจากบัญชีบริการ

หากแอปพลิเคชันของคุณทำงานบน Compute Engine, Kubernetes Engine, App Engine หรือ Cloud Functions (รวมถึง Cloud Functions for Firebase) ให้ใช้ Application Default Credentials (ADC) ADC ใช้บัญชีบริการเริ่มต้นที่คุณมีอยู่เพื่อรับข้อมูลรับรองเพื่ออนุญาตคำขอและ ADC เปิดใช้งานการทดสอบในพื้นที่ที่ยืดหยุ่นผ่านตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS สำหรับขั้นตอนการอนุญาตอัตโนมัติอย่างสมบูรณ์ให้ใช้ ADC ร่วมกับไลบรารีเซิร์ฟเวอร์ Admin SDK

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

ให้ข้อมูลรับรองโดยใช้ ADC

Google Application Default Credentials (ADC) ตรวจสอบข้อมูลรับรองของคุณตามลำดับต่อไปนี้:

  1. ADC ตรวจสอบว่ามีการตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS หรือไม่ หากตั้งค่าตัวแปร ADC จะใช้ไฟล์บัญชีบริการที่ตัวแปรชี้ไป

  2. หากไม่ได้ตั้งค่าตัวแปรสภาพแวดล้อม ADC จะใช้บัญชีบริการเริ่มต้นที่ Compute Engine, Kubernetes Engine, App Engine และ Cloud Functions มีให้สำหรับแอปพลิเคชันที่ทำงานบนบริการเหล่านั้น

  3. หาก ADC ไม่สามารถใช้ข้อมูลรับรองข้างต้นระบบจะแสดงข้อผิดพลาด

ตัวอย่างโค้ด Admin SDK ต่อไปนี้แสดงให้เห็นถึงกลยุทธ์นี้ ตัวอย่างไม่ได้ระบุข้อมูลรับรองของแอปพลิเคชันอย่างชัดเจน อย่างไรก็ตาม ADC สามารถค้นหาข้อมูลรับรองโดยปริยายได้ตราบเท่าที่มีการตั้งค่าตัวแปรสภาพแวดล้อมหรือตราบเท่าที่แอปพลิเคชันทำงานบน Compute Engine, Kubernetes Engine, App Engine หรือ Cloud Functions

โหนด js

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

Java

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    .setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
    .build();

FirebaseApp.initializeApp(options);

Python

default_app = firebase_admin.initialize_app()

ไป

app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

ค#

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
});

ให้ข้อมูลรับรองด้วยตนเอง

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

ในการตรวจสอบสิทธิ์บัญชีบริการและอนุญาตให้เข้าถึงบริการ Firebase คุณต้องสร้างไฟล์คีย์ส่วนตัวในรูปแบบ JSON

ในการสร้างไฟล์คีย์ส่วนตัวสำหรับบัญชีบริการของคุณ:

  1. ในคอนโซล Firebase เปิด การตั้งค่า> บัญชีบริการ

  2. คลิก สร้างคีย์ส่วนตัวใหม่ จากนั้นยืนยันโดยคลิก สร้างคีย์

  3. จัดเก็บไฟล์ JSON ที่มีคีย์อย่างปลอดภัย

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

ในการตั้งค่าตัวแปรสภาพแวดล้อม:

ตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS เป็นเส้นทางไฟล์ของไฟล์ JSON ที่มีคีย์บัญชีบริการของคุณ ตัวแปรนี้ใช้กับเซสชันเชลล์ปัจจุบันของคุณเท่านั้นดังนั้นหากคุณเปิดเซสชันใหม่ให้ตั้งค่าตัวแปรอีกครั้ง

Linux หรือ macOS

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

ด้วย PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

หลังจากที่คุณทำตามขั้นตอนข้างต้นเรียบร้อยแล้ว Application Default Credentials (ADC) จะสามารถระบุข้อมูลรับรองของคุณโดยปริยายทำให้คุณสามารถใช้ข้อมูลรับรองบัญชีบริการเมื่อทำการทดสอบหรือทำงานในสภาพแวดล้อมที่ไม่ใช่ของ Google

ใช้ข้อมูลประจำตัวเพื่อสร้างโทเค็นการเข้าถึง

เว้นแต่คุณจะใช้ Admin SDK ซึ่งจัดการการอนุญาตโดยอัตโนมัติคุณจะต้องสร้างโทเค็นการเข้าถึงและเพิ่มเพื่อส่งคำขอ

ใช้ข้อมูลรับรอง Firebase ร่วมกับ ไลบรารีไคลเอ็นต์ Google API สำหรับภาษาที่คุณต้องการเพื่อดึงข้อมูลโทเค็นการเข้าถึง OAuth 2.0 ที่มีอายุสั้น:

node.js

 function getAccessToken() {
  return new Promise(function(resolve, reject) {
    const key = require('../placeholders/service-account.json');
    const jwtClient = new google.auth.JWT(
      key.client_email,
      null,
      key.private_key,
      SCOPES,
      null
    );
    jwtClient.authorize(function(err, tokens) {
      if (err) {
        reject(err);
        return;
      }
      resolve(tokens.access_token);
    });
  });
}

ในตัวอย่างนี้ไลบรารีไคลเอ็นต์ Google API ตรวจสอบสิทธิ์คำขอด้วยโทเค็นเว็บ JSON หรือ JWT สำหรับข้อมูลเพิ่มเติมโปรดดูที่ โทเค็นเว็บ JSON

Python

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token

Java

private static String getAccessToken() throws IOException {
  GoogleCredential googleCredential = GoogleCredential
      .fromStream(new FileInputStream("service-account.json"))
      .createScoped(Arrays.asList(SCOPES));
  googleCredential.refreshToken();
  return googleCredential.getAccessToken();
}

หลังจากโทเค็นการเข้าถึงของคุณหมดอายุเมธอดการรีเฟรชโทเค็นจะถูกเรียกโดยอัตโนมัติเพื่อดึงโทเค็นการเข้าถึงที่อัปเดต

ในการอนุญาตการเข้าถึง FCM ให้ขอขอบเขต https://www.googleapis.com/auth/firebase.messaging

ในการเพิ่มโทเค็นการเข้าถึงในส่วนหัวคำขอ HTTP:

เพิ่มโทเค็นเป็นค่าของส่วนหัวการ Authorization ในรูปแบบ Authorization: Bearer <access_token> :

node.js

headers: {
  'Authorization': 'Bearer ' + accessToken
}

Python

headers = {
  'Authorization': 'Bearer ' + _get_access_token(),
  'Content-Type': 'application/json; UTF-8',
}

Java

URL url = new URL(BASE_URL + FCM_SEND_ENDPOINT);
HttpURLConnection httpURLConnection = (HttpURLConnection) url.openConnection();
httpURLConnection.setRequestProperty("Authorization", "Bearer " + getAccessToken());
httpURLConnection.setRequestProperty("Content-Type", "application/json; UTF-8");
return httpURLConnection;

อนุญาตโปรโตคอลเดิมในการส่งคำขอ

ด้วยโปรโตคอลดั้งเดิม HTTP คำขอแต่ละรายการต้องมีคีย์เซิร์ฟเวอร์จากแท็บ Cloud Messaging ของบานหน้าต่าง การตั้งค่า คอนโซล Firebase สำหรับ XMPP คุณต้องใช้เซิร์ฟเวอร์คีย์เดียวกันเพื่อสร้างการเชื่อมต่อ

ย้ายข้อมูลคีย์เซิร์ฟเวอร์เดิม

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

หากคุณต้องการลบคีย์เซิร์ฟเวอร์เดิมที่มีอยู่คุณสามารถทำได้ใน Google Cloud Console

อนุญาตคำขอ HTTP

คำขอข้อความประกอบด้วยสองส่วนคือส่วนหัว HTTP และเนื้อหา HTTP ส่วนหัว HTTP ต้องมีส่วนหัวต่อไปนี้:

  • Authorization : key = YOUR_SERVER_KEY
    ตรวจสอบว่านี่คือคีย์ เซิร์ฟเวอร์ ซึ่งมีค่านี้อยู่ในแท็บ Cloud Messaging ของบานหน้าต่าง การตั้งค่า คอนโซล Firebase คีย์ของ Android, iOS และเบราว์เซอร์ถูกปฏิเสธโดย FCM
  • Content-Type : application/json สำหรับ JSON; application/x-www-form-urlencoded;charset=UTF-8 สำหรับข้อความธรรมดา
    หากไม่ระบุ Content-Type รูปแบบจะถือว่าเป็นข้อความธรรมดา

ตัวอย่างเช่น:

Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
  "data" : {
    ...
  },
}

ดู สร้างคำขอส่ง สำหรับรายละเอียดทั้งหมดเกี่ยวกับการสร้างคำขอส่ง Legacy HTTP Protocol Reference แสดงรายการพารามิเตอร์ทั้งหมดที่ข้อความของคุณสามารถมีได้

ตรวจสอบความถูกต้องของคีย์เซิร์ฟเวอร์

หากคุณได้รับข้อผิดพลาดในการตรวจสอบสิทธิ์เมื่อส่งข้อความให้ตรวจสอบความถูกต้องของรหัสเซิร์ฟเวอร์ของคุณ ตัวอย่างเช่นบน Linux ให้รันคำสั่งต่อไปนี้:

api_key=YOUR_SERVER_KEY

curl --header "Authorization: key=$api_key" \
     --header Content-Type:"application/json" \
     https://fcm.googleapis.com/fcm/send \
     -d "{\"registration_ids\":[\"ABC\"]}"

หากคุณได้รับรหัสสถานะ HTTP 401 รหัสเซิร์ฟเวอร์ของคุณไม่ถูกต้อง

อนุญาตการเชื่อมต่อ XMPP

ด้วย XMPP คุณสามารถรักษาการเชื่อมต่อแบบสองทิศทางต่อเนื่องแบบอะซิงโครนัสไปยังเซิร์ฟเวอร์ FCM ได้ สามารถใช้การเชื่อมต่อเพื่อส่งและรับข้อความระหว่างเซิร์ฟเวอร์ของคุณและอุปกรณ์ที่เชื่อมต่อ FCM ของผู้ใช้ของคุณ

คุณสามารถใช้ไลบรารี XMPP ส่วนใหญ่เพื่อจัดการการเชื่อมต่อที่ใช้งานได้ยาวนานกับ FCM จุดสิ้นสุด XMPP ทำงานที่ fcm-xmpp.googleapis.com:5235 เมื่อทดสอบฟังก์ชันกับผู้ใช้ที่ไม่ได้ใช้งานจริงคุณควรเชื่อมต่อกับเซิร์ฟเวอร์ก่อนการผลิตที่ fcm-xmpp.googleapis.com:5236 (โปรดสังเกตพอร์ตอื่น)

การทดสอบก่อนการผลิตเป็นประจำ (สภาพแวดล้อมที่เล็กกว่าซึ่งการสร้าง FCM ล่าสุดทำงานอยู่) เป็นประโยชน์สำหรับการแยกผู้ใช้จริงออกจากโค้ดทดสอบ อุปกรณ์ทดสอบและรหัสทดสอบที่เชื่อมต่อกับ fcm-xmpp.googleapis.com:5236 ควรใช้รหัสผู้ส่ง FCM อื่นเพื่อหลีกเลี่ยงความเสี่ยงในการส่งข้อความทดสอบไปยังผู้ใช้ที่ใช้งานจริงหรือส่งข้อความต้นน้ำจากปริมาณการใช้งานจริงผ่านการเชื่อมต่อทดสอบ

การเชื่อมต่อมีข้อกำหนดที่สำคัญสองประการ:

  • คุณต้องเริ่มการเชื่อมต่อ Transport Layer Security (TLS) โปรดทราบว่าปัจจุบัน FCM ไม่สนับสนุน ส่วนขยาย STARTTLS
  • FCM ต้องการกลไกการตรวจสอบสิทธิ์ SASL PLAIN โดยใช้ <your_FCM_Sender_Id>@fcm.googleapis.com ( ID ผู้ส่ง FCM) และคีย์เซิร์ฟเวอร์เป็นรหัสผ่าน ค่าเหล่านี้มีอยู่ในแท็บ Cloud Messaging ของบานหน้าต่าง การตั้งค่า คอนโซล Firebase

หากการเชื่อมต่อล้มเหลว ณ จุดใดคุณควรเชื่อมต่อใหม่ทันที ไม่จำเป็นต้องสำรองหลังจากตัดการเชื่อมต่อที่เกิดขึ้นหลังจากการตรวจสอบสิทธิ์ สำหรับ ID ผู้ส่ง แต่ละ รหัส FCM อนุญาตให้มีการเชื่อมต่อ 2500 การเชื่อมต่อแบบขนาน

ตัวอย่างต่อไปนี้แสดงวิธีดำเนินการรับรองความถูกต้องและการอนุญาตสำหรับการเชื่อมต่อ XMPP กับ FCM

เซิร์ฟเวอร์ XMPP

เซิร์ฟเวอร์ XMPP ร้องขอการเชื่อมต่อกับ FCM

<stream:stream to="fcm.googleapis.com"
        version="1.0" xmlns="jabber:client"
        xmlns:stream="http://etherx.jabber.org/streams">

FCM

FCM เปิดการเชื่อมต่อและร้องขอกลไกการตรวจสอบสิทธิ์รวมถึงวิธี PLAIN

<stream:features>
  <mechanisms xmlns="urn:ietf:params:xml:ns:xmpp-sasl">
    <mechanism>X-OAUTH2</mechanism>
    <mechanism>X-GOOGLE-TOKEN</mechanism>
    <mechanism>PLAIN</mechanism>
  </mechanisms>
</stream:features>

เซิร์ฟเวอร์ XMPP

เซิร์ฟเวอร์ XMPP ต้องตอบสนองโดยใช้เมธอด PLAIN auth โดยให้คีย์เซิร์ฟเวอร์จากแท็บ Cloud Messaging ของบานหน้าต่าง การตั้งค่า คอนโซล Firebase

<auth mechanism="PLAIN"
xmlns="urn:ietf:params:xml:ns:xmpp-sasl">MTI2MjAwMzQ3OTMzQHByb2plY3RzLmdjbS5hb
mFTeUIzcmNaTmtmbnFLZEZiOW1oekNCaVlwT1JEQTJKV1d0dw==</auth>

FCM

<success xmlns="urn:ietf:params:xml:ns:xmpp-sasl"/>

เซิร์ฟเวอร์ XMPP

<stream:stream to="fcm.googleapis.com"
        version="1.0" xmlns="jabber:client"
        xmlns:stream="http://etherx.jabber.org/streams">

FCM

<stream:features>
  <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"/>
  <session xmlns="urn:ietf:params:xml:ns:xmpp-session"/>
</stream:features>

เซิร์ฟเวอร์ XMPP

<iq type="set">
  <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"></bind>
</iq>

FCM

<iq type="result">
  <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind">
    <jid>SENDER_ID@fcm.googleapis.com/RESOURCE</jid>
  </bind>
</iq>

หมายเหตุ: FCM ไม่ใช้ทรัพยากรที่ถูกผูกไว้ในขณะที่กำหนดเส้นทางข้อความ

ดู สร้างคำขอส่ง สำหรับรายละเอียดทั้งหมดเกี่ยวกับการสร้างคำขอส่ง Legacy XMPP Protocol Reference มีรายการพารามิเตอร์ทั้งหมดที่ข้อความของคุณสามารถมีได้