หน้านี้ได้รับการแปลโดย Cloud Translation API

ให้สิทธิ์คำขอส่งคำขอ

คำขอที่ส่งไปยัง 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 หรือ 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 (ADC) จะตรวจสอบข้อมูลเข้าสู่ระบบของคุณ ตามลำดับต่อไปนี้

ADC จะตรวจสอบว่ามีการตั้งค่าตัวแปรสภาพแวดล้อม GOOGLE_APPLICATION_CREDENTIALS หรือไม่ หากมีการตั้งค่าตัวแปรแล้ว ADC จะใช้ไฟล์บัญชีบริการที่ตัวแปรชี้ไป
หากไม่ได้ตั้งค่าตัวแปรสภาพแวดล้อม ADC จะใช้บัญชีบริการเริ่มต้นที่ Compute Engine, Google Kubernetes Engine, App Engine และ Cloud Functions มีไว้สําหรับแอปพลิเคชันที่ทํางานในบริการเหล่านั้น
หาก ADC ใช้ข้อมูลเข้าสู่ระบบข้างต้นไม่ได้ ระบบจะแสดงข้อผิดพลาด

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

Node.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()

Go

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

C#

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

ระบุข้อมูลเข้าสู่ระบบด้วยตนเอง

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

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

วิธีสร้างไฟล์คีย์ส่วนตัวสำหรับบัญชีบริการ

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

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

วิธีตั้งค่าตัวแปรสภาพแวดล้อม

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

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"

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

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

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

ใช้ข้อมูลเข้าสู่ระบบ Firebase ร่วมกับไลบรารี Google Auth สำหรับภาษาที่ต้องการเพื่อเรียกข้อมูลโทเค็นการเข้าถึง 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);
    });
  });
}index.js

ในตัวอย่างนี้ ไลบรารีไคลเอ็นต์ 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 = service_account.Credentials.from_service_account_file(
    'service-account.json', scopes=SCOPES)
  request = google.auth.transport.requests.Request()
  credentials.refresh(request)
  return credentials.tokenmessaging.py

Java

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

Node.js

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

Python

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

Java

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

ให้สิทธิ์คำขอ HTTP

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

Authorization: key=YOUR_SERVER_KEY
ตรวจสอบว่านี่คือคีย์เซิร์ฟเวอร์ซึ่งมีค่าอยู่ในแท็บการรับส่งข้อความผ่านระบบคลาวด์ของแผงการตั้งค่าคอนโซล Firebase FCM ปฏิเสธคีย์ Android, แพลตฟอร์ม Apple และคีย์เบราว์เซอร์

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

ข้อควรระวัง: การส่งข้อความ (รวมถึงข้อความอัปสตรีม) ด้วย FCM เราเลิกใช้งาน XMPP และ HTTP API เดิมไปเมื่อวันที่ 20 มิถุนายน 2023 และ เราจะนำออกตั้งแต่เดือนมิถุนายน 2024 หากคุณกำลังใช้ FCM ส่ง API เดิม เราขอแนะนำให้คุณ ย้ายข้อมูลไปยัง HTTP v1 API หรือลองใช้ SDK ผู้ดูแลระบบ เพื่อส่งคำขอ

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

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

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

การเชื่อมต่อมีข้อกําหนดที่สําคัญ 2 ข้อดังนี้

คุณต้องเริ่มการเชื่อมต่อ Transport Layer Security (TLS) โปรดทราบว่าขณะนี้ FCM ไม่รองรับส่วนขยาย STARTTLS

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

หากการเชื่อมต่อไม่สำเร็จ คุณควรเชื่อมต่ออีกครั้งทันที ไม่จำเป็นต้องปิดการเชื่อมต่อหลังจากยกเลิกการเชื่อมต่อ การตรวจสอบสิทธิ์ สำหรับรหัสผู้ส่งแต่ละรายการ 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

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

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