लेगसी FCM एपीआई से एचटीटीपी v1 पर माइग्रेट करें

एचटीटीपी और XMPP के लिए, बंद किए गए FCM लेगसी एपीआई का इस्तेमाल करने वाले ऐप्लिकेशन को माइग्रेट करना चाहिए एचटीटीपी v1 API को जल्द से जल्द लॉन्च करेंगे. उन एपीआई की मदद से मैसेज भेजने की सुविधा 20 जून, 2023 से बंद कर दी गई थी. इसमें अपस्ट्रीम मैसेज भी शामिल हैं. 22 जुलाई, 2024 से यह सुविधा पूरी तरह बंद हो जाएगी.

उन खास सुविधाओं के बारे में ज़्यादा जानें जिन पर असर पड़ा है.

लगातार मिल रही सहायता और नई सुविधाओं के अलावा, एचटीटीपी v1 API में लेगसी एपीआई पर ये फ़ायदे हैं:

• ऐक्सेस टोकन की मदद से बेहतर सुरक्षा एचटीटीपी v1 एपीआई, OAuth2 सुरक्षा मॉडल के मुताबिक कुछ समय के लिए बने रहने वाले ऐक्सेस टोकन का इस्तेमाल करता है. ऐसी स्थिति में जब ऐक्सेस टोकन सार्वजनिक हो जाता है, तो उसका इस्तेमाल नुकसान पहुंचाने के मकसद से किया जा सकता है एक घंटे या इससे पहले समय-सीमा खत्म. रिफ़्रेश टोकन, लेगसी एपीआई में इस्तेमाल की जाने वाली सुरक्षा कुंजियों के मुकाबले उतनी बार ट्रांसमिट नहीं किए जाते. इसलिए, उन्हें कैप्चर किए जाने की संभावना बहुत कम होती है.

• अलग-अलग प्लैटफ़ॉर्म के लिए मैसेज को ज़्यादा बेहतर तरीके से पसंद के मुताबिक बनाना मैसेज के मुख्य हिस्से के लिए, एचटीटीपी v1 एपीआई में ऐसी सामान्य कुंजियां होती हैं जो टारगेट किए गए सभी इंस्टेंस पर भेजी जाती हैं. साथ ही, प्लैटफ़ॉर्म के हिसाब से ऐसी कुंजियां भी होती हैं जिनकी मदद से, अलग-अलग प्लैटफ़ॉर्म के लिए मैसेज को पसंद के मुताबिक बनाया जा सकता है. इसकी मदद से, "ओवरराइड" बनाएं जो अलग-अलग उपयोगकर्ताओं के लिए, अलग-अलग पेलोड भेजते हैं में क्लाइंट प्लैटफ़ॉर्म की संख्या शामिल होती है.

• क्लाइंट प्लैटफ़ॉर्म के नए वर्शन के लिए, ज़्यादा समय तक काम करने वाली और आने वाले समय में लागू होने वाली सुरक्षा एचटीटीपी v1 एपीआई, Apple प्लैटफ़ॉर्म, Android, और वेब. JSON पेलोड में हर प्लैटफ़ॉर्म का अपना ब्लॉक होता है. इसलिए, FCM ज़रूरत के हिसाब से एपीआई को नए वर्शन और नए प्लैटफ़ॉर्म पर उपलब्ध करा सकता है.

सर्वर एंडपॉइंट अपडेट करना

एचटीटीपी v1 एपीआई के एंडपॉइंट का यूआरएल, लेगसी एंडपॉइंट से इन तरीकों से अलग होता है:

• यह वर्शन वाला है और पाथ में /v1 है.
• पाथ में, इसके लिए Firebase प्रोजेक्ट का प्रोजेक्ट आईडी शामिल होता है /projects/myproject-ID/ फ़ॉर्मैट में अपना ऐप्लिकेशन. यह आईडी, Firebase कंसोल के प्रोजेक्ट की सामान्य सेटिंग टैब में उपलब्ध होता है.
• यह send तरीके को :send के तौर पर साफ़ तौर पर बताता है.

एचटीटीपी v1 के लिए सर्वर एंडपॉइंट को अपडेट करने के लिए, अपने भेजे गए अनुरोधों के हेडर में एंडपॉइंट में ये एलिमेंट जोड़ें.

पहले किए गए एचटीटीपी अनुरोध

POST https://fcm.googleapis.com/fcm/send

पहले किए गए XMPP अनुरोध

लेगसी XMPP मैसेज, नीचे दिए गए एंडपॉइंट के कनेक्शन पर भेजे जाते हैं:

fcm-xmpp.googleapis.com:5235

इसके बाद

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

ईमेल भेजने के अनुरोधों की अनुमति अपडेट करना

लेगसी अनुरोधों में इस्तेमाल की गई सर्वर कुंजी स्ट्रिंग की जगह पर, एचटीटीपी v1 अनुरोध भेजें OAuth 2.0 ऐक्सेस टोकन ज़रूरी है. अगर मैसेज भेजने के लिए एडमिन SDK टूल का इस्तेमाल किया जा रहा है, तो लाइब्रेरी आपके लिए टोकन मैनेज करती है. अगर eef के रॉ प्रोटोकॉल का इस्तेमाल किया जा रहा है, तो इस सेक्शन में बताए गए तरीके से टोकन पाएं और इसे हेडर में Authorization: Bearer <valid Oauth 2.0 token> के तौर पर जोड़ें.

इससे पहले

Authorization: key=AIzaSyZ-1u...0GBYzPu7Udno5aA

इसके बाद

Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

आपके की पुष्टि करने के लिए, सर्वर को चालू करने के लिए इन रणनीतियों के संयोजन का उपयोग करें Firebase सेवाओं के लिए अनुरोध:

• Google ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (ADC)
• सेवा खाते की JSON फ़ाइल
• सेवा खाते से मिला, कुछ समय के लिए उपलब्ध OAuth 2.0 ऐक्सेस टोकन

अगर आपका ऐप्लिकेशन Compute Engine पर चल रहा है, Google Kubernetes Engine, App Engine या Cloud Functions (इसमें Cloud Functions for Firebase भी शामिल है), ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी) का इस्तेमाल करें. अनुरोधों को अनुमति देने के लिए क्रेडेंशियल पाने के लिए, एडीसी आपके मौजूदा डिफ़ॉल्ट सेवा खाते का इस्तेमाल करता है. साथ ही, एडीसी, एनवायरमेंट वैरिएबल GOOGLE_APPLICATION_CREDENTIALS की मदद से, लोकल टेस्टिंग की सुविधा देता है. पूरी तरह से ऑटोमेशन के लिए अनुमति देने का फ़्लो, 'एडमिन SDK' सर्वर लाइब्रेरी के साथ ADC का इस्तेमाल करें.

अगर आपका ऐप्लिकेशन, Google के सर्वर एनवायरमेंट के बजाय किसी दूसरे सर्वर एनवायरमेंट पर चल रहा है, तो आपको अपने Firebase प्रोजेक्ट से सेवा खाते की JSON फ़ाइल डाउनलोड करनी होगी. जब तक आपके पास निजी पासकोड वाली फ़ाइल वाले फ़ाइल सिस्टम का ऐक्सेस है, तब तक मैन्युअल तरीके से हासिल किए गए इन क्रेडेंशियल का इस्तेमाल करके अनुरोधों को अनुमति देने के लिए, एनवायरमेंट वैरिएबल GOOGLE_APPLICATION_CREDENTIALS का इस्तेमाल किया जा सकता है. अगर आपके पास ऐसी फ़ाइल का ऐक्सेस नहीं है, तो आपको अपने कोड में सेवा खाते की फ़ाइल का रेफ़रंस देना होगा. ऐसा करते समय, आपको सावधानी बरतनी होगी, क्योंकि इससे आपके क्रेडेंशियल का खुलासा हो सकता है.

एडीसी का इस्तेमाल करके क्रेडेंशियल देना

Google ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (ADC), आपके क्रेडेंशियल की जांच इस क्रम में करते हैं:

1. एडीसी यह जांच करता है कि एनवायरमेंट वैरिएबल GOOGLE_APPLICATION_CREDENTIALS सेट है या नहीं. अगर वैरिएबल सेट है, तो ADC, सेवा खाते की उस फ़ाइल का इस्तेमाल करता है जिस पर वैरिएबल पॉइंट करता है.

2. अगर एनवायरमेंट वैरिएबल सेट नहीं है, तो ADC उस डिफ़ॉल्ट सेवा खाते का इस्तेमाल करता है जो Compute Engine, Google Kubernetes Engine, App Engine, और Cloud Functions, उन सेवाओं पर चलने वाले ऐप्लिकेशन के लिए उपलब्ध कराते हैं.

3. अगर ADC ऊपर दिए गए किसी भी क्रेडेंशियल का इस्तेमाल नहीं कर पाता है, तो सिस्टम गड़बड़ी की सूचना देता है.

एडमिन SDK टूल के कोड का यह उदाहरण, इस रणनीति को दिखाता है. उदाहरण में, ऐप्लिकेशन के क्रेडेंशियल के बारे में साफ़ तौर पर नहीं बताया गया है. हालांकि, जब तक एनवायरमेंट वैरिएबल सेट है या ऐप्लिकेशन 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 पर काम करते हैं सेवा खाते, जिसे आप 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"

ऊपर दिए गए चरणों को पूरा करने के बाद, ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल (एडीसी), आपके क्रेडेंशियल का पता लगा सकते हैं. इससे, Google से बाहर के एनवायरमेंट में टेस्ट करने या चलाने के दौरान, सेवा खाते के क्रेडेंशियल का इस्तेमाल किया जा सकता है.

ऐक्सेस टोकन को मिंट करने के लिए, क्रेडेंशियल का इस्तेमाल करें

अपने Firebase क्रेडेंशियल का एक साथ इस्तेमाल करें Google ऑथ लाइब्रेरी कृपया कुछ समय तक चलने वाले 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.

ऐक्सेस टोकन को किसी एचटीटीपी अनुरोध के हेडर में जोड़ने के लिए:

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

ईमेल भेजने के अनुरोधों का पेलोड अपडेट करें

FCM HTTP v1 में, JSON मैसेज के पेलोड के स्ट्रक्चर में एक अहम बदलाव किया गया है. मुख्य रूप से, इन बदलावों से यह पक्का होता है कि अलग-अलग क्लाइंट प्लैटफ़ॉर्म पर मैसेज मिलने पर, उन्हें सही तरीके से मैनेज किया जाए. साथ ही, इन बदलावों से आपको हर प्लैटफ़ॉर्म के मैसेज फ़ील्ड को पसंद के मुताबिक बनाने या "ओवरराइड" करने की ज़्यादा सुविधा मिलती है.

इस सेक्शन में दिए गए उदाहरणों के अलावा, सभी प्लैटफ़ॉर्म पर मैसेज को पसंद के मुताबिक बनाना लेख पढ़ें. साथ ही, एचटीटीपी v1 के बारे में जानने के लिए, एपीआई रेफ़रंस लेख पढ़ें.

उदाहरण: सूचना का आसान मैसेज

यहां एक बहुत ही आसान सूचना पेलोड की तुलना की गई है—जिसमें शामिल है सिर्फ़ title, body, और data फ़ील्ड— जो बुनियादी जानकारी दिखाता है लेगसी और एचटीटीपी v1 पेलोड में अंतर है.

इससे पहले

{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "New news story available."
  },
  "data": {
    "story_id": "story_12345"
  }
}

इसके बाद

{
  "message": {
    "topic": "news",
    "notification": {
      "title": "Breaking News",
      "body": "New news story available."
    },
    "data": {
      "story_id": "story_12345"
    }
  }
}

उदाहरण: नेस्ट किया गया JSON डेटा

लेगसी मैसेजिंग एपीआई के विपरीत, एचटीटीपी v1 एपीआई में data फ़ील्ड में नेस्ट की गई JSON वैल्यू काम नहीं करती हैं. JSON को स्ट्रिंग में बदलना ज़रूरी है.

इससे पहले

{
  ...
  "data": {
    "keysandvalues": {"key1": "value1", "key2": 123}
  }
}

इसके बाद

{
  "message": {
   ...
    "data": {
      "keysandvalues": "{\"key1\": \"value1\", \"key2\": 123}"
    }
  }
}

उदाहरण: एक से ज़्यादा प्लैटफ़ॉर्म को टारगेट करना

एक से ज़्यादा प्लैटफ़ॉर्म को टारगेट करने की सुविधा चालू करने के लिए, लेगसी एपीआई ने बैकएंड में बदलाव किए. वहीं दूसरी ओर, एचटीटीपी v1 प्लैटफ़ॉर्म के लिए खास तौर पर बने पासकोड, जो अलग-अलग प्लैटफ़ॉर्म के बीच अंतर करते हैं साफ़ तौर पर बताया गया हो और डेवलपर को साफ़ तौर पर दिखता हो. इसकी मदद से, एक ही अनुरोध से कई प्लैटफ़ॉर्म को टारगेट किया जा सकता है. इसका उदाहरण यहां दिया गया है.

इससे पहले

// Android
{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "New news story available.",
    "click_action": "TOP_STORY_ACTIVITY"
  },
  "data": {
    "story_id": "story_12345"
  }
}
// Apple
{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "New news story available.",
    "click_action": "HANDLE_BREAKING_NEWS"
  },
  "data": {
    "story_id": "story_12345"
  }
}

इसके बाद

{
  "message": {
    "topic": "news",
    "notification": {
      "title": "Breaking News",
      "body": "New news story available."
    },
    "data": {
      "story_id": "story_12345"
    },
    "android": {
      "notification": {
        "click_action": "TOP_STORY_ACTIVITY"
      }
    },
    "apns": {
      "payload": {
        "aps": {
          "category" : "NEW_MESSAGE_CATEGORY"
        }
      }
    }
  }
}

उदाहरण: प्लैटफ़ॉर्म में बदलाव करने के बाद, अपने हिसाब से बदलाव करना

एचटीटीपी v1 एपीआई, मैसेज की क्रॉस-प्लैटफ़ॉर्म टारगेटिंग को आसान बनाने के साथ-साथ, हर प्लैटफ़ॉर्म के हिसाब से मैसेज को पसंद के मुताबिक बनाने की सुविधा भी देता है.

इससे पहले

// Android
{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "Check out the Top Story.",
    "click_action": "TOP_STORY_ACTIVITY"
  },
  "data": {
    "story_id": "story_12345"
  }
}
// Apple
{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "New news story available.",
    "click_action": "HANDLE_BREAKING_NEWS"
  },
  "data": {
    "story_id": "story_12345"
  }
}

इसके बाद

{
  "message": {
    "topic": "news",
    "notification": {
      "title": "Breaking News",
      "body": "New news story available."
    },
    "data": {
      "story_id": "story_12345"
    },
    "android": {
      "notification": {
        "click_action": "TOP_STORY_ACTIVITY",
        "body": "Check out the Top Story"
      }
    },
    "apns": {
      "payload": {
        "aps": {
          "category" : "NEW_MESSAGE_CATEGORY"
        }
      }
    }
  }
}

उदाहरण: चुनिंदा डिवाइसों को टारगेट करना

HTTP v1 API की मदद से खास डिवाइसों को टारगेट करने के लिए, to पासकोड के बजाय token पासकोड में डिवाइस का मौजूदा रजिस्ट्रेशन टोकन दें.

इससे पहले

  { "notification": {
      "body": "This is an FCM notification message!",
      "title": "FCM Message"
    },
    "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }

इसके बाद

{
   "message":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}

FCM एचटीटीपी v1 एपीआई के ज़्यादा सैंपल और जानकारी के लिए, यहां देखें:

• एचटीटीपी v1 एपीआई की मदद से, ऐप्लिकेशन सर्वर से अनुरोध भेजने का तरीका. जब तक खास तौर पर न कहा जाए, तब तक सभी "REST" स्निपेट, v1 API का इस्तेमाल करते हैं.

• Firebase ब्लॉग.