Getting started with push notifications in Yandex Cloud Notification Service

1. In the management console, select the folder you want to create a notification channel in.

2. From the list of services, select Cloud Notification Service.

3. Click Create notifications channel.

4. Select a sending platform in the Mobile Push notifications tab:

   • Apple iOS: For iOS devices.
   • Google Android: For Android devices with Google Play services installed.
   • Huawei Android: For Android devices with Huawei services installed.
   • RuStore Android: For Android devices with the RuStore app marketplace installed.

5. Depending on the platform you select, set the authentication parameters:

   Apple iOS

   • Select the Authentication method: Token or Certificate.

     • To authenticate with a token, you will need:

       • Signature key: File with the signature key that you will use to certify the authentication token.

         Create and download a signature key in your Apple developer account: Certificates, Identifiers & Profiles → Keys → . You can download the key file only once.

       • Key ID (Key ID): Get the ID in your Apple developer account: Certificates, Identifiers & Profiles → Keys. Make sure the ID matches the signature key you downloaded in the previous step. It must be 10 characters long.

       • Developer ID (Team ID): You can find it in the top-right corner of your Apple developer account. It must be 10 characters long and contain only numbers and Latin letters.

       • Bundle ID: Get the bundle ID in your Apple developer account: Certificates, Identifiers & Profiles → Identifiers or in the Xcode app: Target → General → Identity. It may contain only numbers, Latin letters, hyphens, and periods.

       Learn more about the token in the relevant Apple documentation.

     • To authenticate with a certificate, you will need:

       • Certificate: SSL certificate file in .pem format.
       • Private certificate key: Key file in .pem format.

       For more information about the certificate, see the Apple documentation.

       To save the certificate and the private key in individual .pem files, use the openssl Linux utility:

       openssl pkcs12 -in Certificates.p12 -nokeys -nodes -out certificate.pem
       openssl pkcs12 -in Certificates.p12 -nocerts -nodes -out privatekey.pem
       

     Token-based authentication is preferred as a faster, more modern and secure option.

   • Select the Environment: Development or Production. Use Development to test the application.

   Google Android

   Specify which FCM API version will be used: HTTP v1 or Legacy.

   You can authenticate with FCM using the API:

   • HTTP v1 API: You will need a Google Cloud service account key in JSON format. The key is used to generate OAuth 2.0 temporary tokens for authenticating requests in the FCM HTTP v1 API. You can get it in the Google Cloud management console.
   • Legacy API: You will need an API key (server key). You can get it in the Firebase management console.

   Note

   FCM no longer supports the legacy API starting June 2024.

   See more in the Firebase documentation.

   Huawei Android

   Explore the HMS documentation and get the authentication parameters:

   • Key ID.
   • API key.

   RuStore Android

   See the relevant RuStore article and get the authentication parameters:

   • Project ID.
   • Service token.

   You can get your authentication parameters in the RuStore developer console: Push notifications → Projects.

6. Enter the notification channel Name. Channel names are unique within the entire CNS. It may contain lowercase and uppercase Latin letters, numbers, underscores, hyphens, and periods. It may be from 1 to 256 characters long. For APNs channels, we recommend specifying the bundle ID in the name; for FCM and HMS, the full package name; for RuStore, packageName.

7. Optionally, click Add description and enter a description for your notification channel.

8. Click Create.

1. Select the notification channel you previously created.
2. Navigate to the Endpoints tab.
3. Click Create endpoint.
4. Enter Device token, a unique token residing on the user device, created by the notification service for the app.
5. Optionally, enter User data, a UTF-8 encoded text up to 2,048 characters long.
6. Click Create.

Creating an endpoint may take some time.

1. Select the endpoint you previously created.
2. Under Send messages, select a notification format, Text or JSON.
3. Enter notification text or a JSON object with notification data.
4. Click Send.

Each sent notification is assigned a unique ID. To save it, click Copy ID.

You can send a new notification immediately or resend the previous one.