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

คำขอที่ส่งไปยัง FCM จากเซิร์ฟเวอร์แอปของคุณหรือสภาพแวดล้อมที่เชื่อถือได้จะต้องได้รับอนุญาต โปรดสังเกตความแตกต่างที่สำคัญเหล่านี้ระหว่างการอนุญาต HTTP API เดิมที่เลิกใช้งานแล้วและการอนุญาต 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, Google Kubernetes Engine, App Engine หรือฟังก์ชันคลาวด์ (รวมถึงฟังก์ชันคลาวด์สำหรับ Firebase) ให้ใช้ Application Default Credentials (ADC) ADC ใช้บัญชีบริการเริ่มต้นที่มีอยู่ของคุณเพื่อรับข้อมูลรับรองเพื่ออนุญาตคำขอ และ ADC เปิดใช้งานการทดสอบภายในที่ยืดหยุ่นผ่านตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS เพื่อให้ขั้นตอนการให้สิทธิ์ทำงานอัตโนมัติเต็มรูปแบบ ให้ใช้ ADC ร่วมกับไลบรารีเซิร์ฟเวอร์ Admin SDK

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

ระบุข้อมูลประจำตัวโดยใช้ ADC

ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน Google (ADC) จะตรวจสอบข้อมูลรับรองของคุณตามลำดับต่อไปนี้:

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

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

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

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

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

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

FirebaseApp.initializeApp(options);

default_app = firebase_admin.initialize_app()

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

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 ที่มีคีย์บัญชีบริการของคุณ ตัวแปรนี้ใช้กับเซสชันเชลล์ปัจจุบันของคุณเท่านั้น ดังนั้นหากคุณเปิดเซสชันใหม่ ให้ตั้งค่าตัวแปรอีกครั้ง

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

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

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

ใช้ข้อมูลรับรองเพื่อสร้างโทเค็นการเข้าถึง

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

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

 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);
    });
  });
}
index.js

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

  :return: Access token.
  """
  credentials = service_account.Credentials.from_service_account_file(
    'service-account.json', scopes=SCOPES)
  request = google.auth.transport.requests.Request()
  credentials.refresh(request)
  return credentials.token
messaging.py

private static String getAccessToken() throws IOException {
  GoogleCredentials googleCredentials = GoogleCredentials
          .fromStream(new FileInputStream("service-account.json"))
          .createScoped(Arrays.asList(SCOPES));
  googleCredentials.refresh();
  return googleCredentials.getAccessToken().getTokenValue();
}
Messaging.java

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

หากต้องการให้สิทธิ์การเข้าถึง FCM โปรดขอขอบเขต https://www.googleapis.com/auth/firebase.messaging

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

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

headers: {
  'Authorization': 'Bearer ' + accessToken
}
index.js

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

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

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

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

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

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

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

อนุญาตคำขอ HTTP

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

• Authorization : key=YOUR_SERVER_KEY
  ตรวจสอบให้แน่ใจว่านี่คือรหัส เซิร์ฟเวอร์ ซึ่งมีค่าอยู่ในแท็บ Cloud Messaging ของแผง การตั้งค่า คอนโซล Firebase Android, แพลตฟอร์ม Apple และคีย์เบราว์เซอร์ถูกปฏิเสธโดย 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" : {
    ...
  },
}

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

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

หากคุณได้รับข้อผิดพลาดในการรับรองความถูกต้องเมื่อส่งข้อความ ให้ตรวจสอบความถูกต้องของรหัสเซิร์ฟเวอร์ของคุณ ตัวอย่างเช่น บน 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 ควรใช้ ID ผู้ส่ง FCM อื่น เพื่อหลีกเลี่ยงความเสี่ยงในการส่งข้อความทดสอบไปยังผู้ใช้ที่ใช้งานจริง หรือการส่งข้อความอัปสตรีมจากปริมาณการใช้งานจริงผ่านการเชื่อมต่อทดสอบ

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

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

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

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

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

เอฟซีเอ็ม

<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">

เอฟซีเอ็ม

<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>

เอฟซีเอ็ม

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

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

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