Skip to content

Commit

Permalink
feat: deprecate legacy FCM API and server keys. (#328)
Browse files Browse the repository at this point in the history
* feat: deprecating FCM server key

* fix: typo and change image

* fix: better image label
  • Loading branch information
fbenevides authored May 1, 2024
1 parent fa11a28 commit 3df50ac
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/beams/getting-started/android/configure-fcm.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ eleventyNavigation:

# Configure FCM

Pusher relies on Firebase Cloud Messaging (FCM) to deliver push notifications to Android application users on your behalf. When we deliver push notifications, we use your FCM credentials. This page guides you through the process of getting an FCM Server Key and how to provide it to Pusher.
Pusher relies on Firebase Cloud Messaging (FCM) to deliver push notifications to Android application users on your behalf. When we deliver push notifications, we use your FCM credentials. This page guides you through the process of getting a FCM service account file and how to provide it to Pusher.

Head over to the [Pusher dashboard](https://dashboard.pusher.com/beams) and create a new instance of Beams. After that, you can either follow the interactive quick start over there, or return here to follow the documentation steps.

Expand All @@ -22,7 +22,7 @@ The first step is to go your [Firebase console](https://console.firebase.google.

## Create a new app

> If you are using a pre-existing Firebase app, you can jump ahead to [Get Your FCM Server Key](#get-your-fcm-server-key). Otherwise you will create one now.
> If you are using a pre-existing Firebase app, you can jump ahead to [Get Your Service Account JSON file](#get-your-fcm-service-account-json-file). Otherwise you will create one now.
Add a project if you haven’t already. Then create a new app, by clicking the <em>Add app</em> button.

Expand All @@ -44,19 +44,19 @@ Keep a note of the file‘s location, as eventually you will add it to your Andr

![Screenshot of downloading config](./img/fcm_download_config.jpg)

## Get your FCM Server Key
## Get your FCM service account JSON file

Go to your Firebase project‘s settings page, and then go to the Cloud Messaging tab.
Go to your Firebase project‘s settings page, and then go to the *Service Accounts* tab.

You will need to enable the <em>Legacy Cloud Messaging API</em>, not the <em>Firebase Cloud Messaging API</em>.
Then, you will need to generate a new private key by clicking *Generate new private key*.

![Screenshot of copying key](./img/fcm_key.jpg)
![Screenshot of generating new private key](./img/fcm_service_account_private_key.png)

Now you can copy the FCM Server Key.
This will download a service account JSON file.

> If you are following the quick start guide in the Pusher Beams dashboard, return to it now with your FCM Server Key.
> If you are following the quick start guide in the Pusher Beams dashboard, return to it now with your FCM service account file.
This FCM Server Key can be saved to your Pusher Beams instance in the [dashboard](https://dashboard.pusher.com/beams).
This FCM service account file can be saved to your Pusher Beams instance in the [dashboard](https://dashboard.pusher.com/beams).

## Where Next?

Expand Down
Binary file added img/fcm_service_account_private_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3df50ac

Please sign in to comment.