Loading ...

Configure Firebase Cloud Messaging (FCM) APIs | Axero Documentation

Home » axero documentation » Wiki » Documentation » White-Label Mobile Apps » Configure Firebase Cloud Messaging (FCM) APIs
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 9

Configure Firebase Cloud Messaging (FCM) APIs

0 
 /5
0 (0votes)

This wiki offers a detailed guide for enabling and configuring Firebase Cloud Messaging (FCM) APIs to HTTP v1. It is designed to assist you in transitioning from the legacy FCM API to the new HTTP v1 API, ensuring that your Axero site can continue sending push notifications to Android devices.

This guide assumes you already have a Firebase project. If you are setting one up from scratch, follow Create a Firebase Project instead, which covers project creation, the Android app, and these same three steps in one pass.

Table of Contents

I. Enable Firebase Cloud Messaging API (V1)

Note: You can skip this step if it's enabled and proceed to II. Generate Private Key in Firebase

Step-by-Step Instructions:

  1. Access Firebase Console:
  2. Select Your Project:
    • Choose the project you wish to enable the API for.
  3. Open Project Settings:
    • Go to the Project Settings.
  4. Access Cloud Messaging:
    • Select the “Cloud Messaging” tab.Firebase Project settings on the Cloud Messaging tab, showing Firebase Cloud Messaging API (V1) marked Disabled
  5. Manage API:
    • Click on the ellipsis icon and select “Manage API in Google Cloud Console”.

      The same card with the Manage API in Google Cloud Console link highlighted
  6. Enable API:
    • Click the “Enable” button and wait for the process to complete (this may take a few minutes).

II. Generate Private Key in Firebase

      • Return to Firebase and select the “Service accounts” tab.Firebase Project settings on the Service accounts tab, showing the Firebase Admin SDK panel
      • Click “Generate new private key”. A notification pop-up will appear; click "Generate key".The Service accounts tab with the Generate new private key button highlightedThe Generate new private key dialog, warning to keep the key confidential, with the Generate key button
  2. Save JSON File:
    • Save the generated JSON file to your computer.

III. Fill in the Information in System Property Fields

  1. Navigate to your site System Properties: Control Panel > System > System Properties

  2. Open JSON File you just downloaded.
    The downloaded service account JSON file open in a text editor
  3. Retrieve the project ID from the project_id field in the JSON file.The same JSON file with the project_id field highlighted
  4. Update Property PushNotificationFCMApiUrl to the new URL following this format: https://fcm.googleapis.com/v1/projects/<your project id>/messages:send 
    • Example:
      The PushNotificationFCMApiUrl system property, with the position of the project id marked inside the URL
  5. Retrieve the email from the client_email field in the JSON file.The JSON file with the client_email field highlighted
  6. Update Property PushNotificationFCMEmail
    The PushNotificationFCMEmail system property holding the service account address
  7. Retrieve the private key from the private_key field in the JSON file.
      • Ensure to copy the entire key, including "-----BEGIN PRIVATE KEY----- " and "\n-----END PRIVATE KEY-----\n ".
        The JSON file with the private_key field highlighted and a note to copy the entire key
  8. Update Property PushNotificationFCMPrivateKey:
    The PushNotificationFCMPrivateKey system property, with the pasted key shown partly redacted

 

Once completed, your site will be able to continue sending notifications to Android devices after the old API is deprecated!

Wiki Index

Pages