คำขอที่ส่งไปยัง 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) ให้ใช้ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชัน (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)
}
C#
FirebaseApp.Create(new AppOptions()
{
Credential = GoogleCredential.GetApplicationDefault(),
});
ระบุข้อมูลเข้าสู่ระบบด้วยตนเอง
โปรเจ็กต์ Firebase รองรับบัญชีบริการของ Google ซึ่งคุณใช้เรียก API ของเซิร์ฟเวอร์ Firebase จากเซิร์ฟเวอร์แอปหรือสภาพแวดล้อมที่เชื่อถือได้ หากคุณกำลังพัฒนาโค้ดในเครื่องหรือติดตั้งใช้งานแอปพลิเคชันภายในองค์กร คุณสามารถใช้ข้อมูลเข้าสู่ระบบที่ได้รับผ่านบัญชีบริการนี้เพื่อให้สิทธิ์คําขอของเซิร์ฟเวอร์ได้
หากต้องการตรวจสอบสิทธิ์บัญชีบริการและให้สิทธิ์เข้าถึงบริการ Firebase คุณต้องสร้างไฟล์คีย์ส่วนตัวในรูปแบบ JSON
วิธีสร้างไฟล์คีย์ส่วนตัวสำหรับบัญชีบริการ
ในคอนโซล Firebase ให้เปิดการตั้งค่า > บัญชีบริการ
คลิกสร้างคีย์ส่วนตัวใหม่ แล้วยืนยันโดยคลิกสร้างคีย์
จัดเก็บไฟล์ JSON ที่มีคีย์อย่างปลอดภัย
เมื่อให้สิทธิ์ผ่านบัญชีบริการ คุณจะมี 2 ตัวเลือกในการระบุข้อมูลเข้าสู่ระบบให้กับแอปพลิเคชัน คุณสามารถตั้งค่าตัวแปรสภาพแวดล้อม 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"
หลังจากทำตามขั้นตอนข้างต้นแล้ว ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชัน (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);
});
});
}
ในตัวอย่างนี้ ไลบรารีไคลเอ็นต์ 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.token
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();
}
หลังจากโทเค็นการเข้าถึงหมดอายุ ระบบจะเรียกใช้เมธอดรีเฟรชโทเค็นโดยอัตโนมัติเพื่อดึงข้อมูลโทเค็นการเข้าถึงที่อัปเดตแล้ว
หากต้องการให้สิทธิ์เข้าถึง 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 " + getServiceAccountAccessToken());
httpURLConnection.setRequestProperty("Content-Type", "application/json; UTF-8");
return httpURLConnection;
ให้สิทธิ์คำขอส่งโปรโตคอลเดิม
เมื่อใช้โปรโตคอล HTTP เดิม คําขอแต่ละรายการต้องมีคีย์เซิร์ฟเวอร์จากแท็บ Cloud Messaging ของแผงการตั้งค่าFirebaseคอนโซล สำหรับ XMPP คุณต้องใช้คีย์เซิร์ฟเวอร์เดียวกันเพื่อสร้างการเชื่อมต่อ
ย้ายข้อมูลคีย์เซิร์ฟเวอร์เดิม
ตั้งแต่เดือนมีนาคม 2020 FCM ได้หยุดสร้างคีย์เซิร์ฟเวอร์เดิมแล้ว คีย์เซิร์ฟเวอร์เดิมที่มีอยู่จะยังคงใช้งานได้ แต่เราขอแนะนำให้คุณใช้คีย์เวอร์ชันใหม่ที่มีป้ายกำกับว่าคีย์เซิร์ฟเวอร์ใน consoleFirebase แทน
หากต้องการลบคีย์เซิร์ฟเวอร์เดิมที่มีอยู่ ให้ไปที่คอนโซล Google Cloud
ให้สิทธิ์คำขอ HTTP
คำขอข้อความประกอบด้วย 2 ส่วน ได้แก่ ส่วนหัว HTTP และเนื้อหา HTTP ส่วนหัว HTTP ต้องมีส่วนหัวต่อไปนี้
Authorization
: key=YOUR_SERVER_KEY
ตรวจสอบว่านี่คือคีย์เซิร์ฟเวอร์ซึ่งมีค่าอยู่ในแท็บ การรับส่งข้อความผ่านระบบคลาวด์ของแผงการตั้งค่าคอนโซล Firebase FCM ปฏิเสธคีย์ Android, แพลตฟอร์ม Apple และคีย์เบราว์เซอร์Content-Type
:application/json
สำหรับ JSONapplication/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 ช่วยให้คุณรักษาการเชื่อมต่อแบบ 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 รุ่นเดิมมีรายการพารามิเตอร์ทั้งหมดที่ข้อความของคุณมีได้