SDK

Platform Configuration

Before you can start sending messages, you will need to set up the native platforms.

Android

Before you can start sending messages to Android, you will have to at least setup a FCM project and obtain a Google Maps key for Google Play Services based devices. If you also support Huawei Mobile Services based devices, you will also need to setup a PushKit enabled project (including the Receipts service) for Huawei Mobile Services based devices. This is all done via the Firebase Developer Console and Google Developer Console (for Google Play Services based devices) and Huawei Developer Portal (for HMS based devices). Keep reading this document to know how to configure your push provider platform.

Creating a FCM Project

In 2016, Firebase Cloud Messaging replaced the GCM (Google's Cloud Messaging) and became Android's official push provider. To be able to send notifications you currently need to create a project in Firebase.

Start by signing in Firebase. In their developer page you will find a button like this one:

fmc new project button

This will open a window like this one:

fcm create project window

In this window you will have to provide the name of your project:

fcm project name

Firebase will generate an ID for you project, you can also customize this:

fcm project id

You will also need to select a country:

fcm project country

And finally click in the Create Project button:

fcm create project button

After this, you will automatically be sent to the project area where you can find a button like this one:

fcm project settings

In the project settings page you will find a tab for Cloud Messaging:

fcm project cm tab

This is where you'll find the necessary keys for both Notificare and your app. For Notificare you will need the Server Key:

fcm project server key

Copy this key and open our dashboard. Navigate to the app you've previously created and expand the Settings menu and click in Services:

menu

Then you should click the Configure button in the GCM/FCM box:

service box

And paste the Server Key in the following field:

server key

Finally you should click in the Update button to make sure you store these changes:

save button

Google Maps Key

Optionally if you want our library to handle Google Maps correctly you will need to enable access to this API in the Google's Developer console. This is only necessary if you intend to send notifications that use the map capabilities and if you are not already using yourself a Google Maps key in your app. If you do not want to use this functionality or you already use Google Maps in your app you can skip this configuration.

To enable this API and generate a API key, sign in into the Google's Developer Console and select the app you which to enable this API:

google console app selector

Then click in the Library menu item like shown below:

google console library

This will take you to a page where you find all the Google APIs. Locate and click in the Google Maps Android API link:

google console maps api

In this page you'll a short explanation about this API and the Enable button:

google console enable maps

Clicking in Enable will allow your project access to this API and show you a page that looks like this:

google console maps api enabled

Then you are ready to create an API key that can actually be used in your app. In the menu on the left, click in Credentials:

google console credentials

In this page expand the Create Credentials menu and click in API key:

google console credentials api key menu

This will generate a key and display it in a window like the one below:

google console api key generated

In production you might want to restrict the access of this key to your app but we will not cover this setup in this document.

Once you have generated an API key for Google Maps, go ahead an add an entry in your app's AndroidManifest.xml as follows:

<meta-data
  android:name="com.google.android.geo.API_KEY"
  android:value="ADD_THE_KEY_HERE" />

Creating an HMS Project

HMS PushKit is Huawei's official push provider. To be able to send notifications you need to create a project in the HMS AppGallery.

Start by signing in to HMS AppGallery. In the AppGallery overview page you will find a button like this one:

hms my projects button

And add a new project

hms add project button

This will open a window where you will have to provide the name of your project:

hms new project window

After that, fill in the package name and language of the project you are creating:

hms create project window

Now, add an app to your project. You can add several apps per project.

hms add app button

In the app information window, you will find the necessary info to configure your app in Notificare.

hms app information window

For your app to run on both a production as well as a debug environment, it is important that you add SHA-256 fingerprints for any debug environment you will be running the app from.

Debug fingerprints can be found in your machine's local debug keystore

/> keytool -list -v -keystore ~/.android/debug.keystore

Enter keystore password:
Keystore type: jks
Keystore provider: SUN

Your keystore contains 1 entry

Alias name: androiddebugkey
Creation date: Oct 7, 2019
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: C=US, O=Android, CN=Android Debug
Issuer: C=US, O=Android, CN=Android Debug
Serial number: 1
Valid from: Mon Oct 07 18:35:57 CEST 2019 until: Wed Sep 29 18:35:57 CEST 2049
Certificate fingerprints:
MD5:  XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX
SHA1: XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX
SHA256: XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX
Signature algorithm name: SHA1withRSA
Subject Public Key Algorithm: 2048-bit RSA key
Version: 1

For production environments, you will need to use your own keystore that you use when signing your APKs.

Copy the App ID and App Secret and open our dashboard. Navigate to the app you've previously created and expand the Settings menu and click in Services:

menu

Then you should click the Configure button in the HMS box:

hms service box

And paste the App ID and App Secret in the following field:

hms key

Finally you should click in the Save button to make sure you store these changes:

save button

After successful saving, you should now see the necessary settings to be filled in for allowing receipts to be received from HMS:

receipt config

In the side menu of the AppGallery Develop view, you can select PushKit, which will show you the status of PushKit.

hms service status window png

Enabling the Receipt service will allow us to receive information about message delivery, so we can inform you of app uninstalls, invalid tokens, etc.

Fill in the info from the Notificare's Dashboard as shown below:

hms receipt window

Click Test Receipt. After successful testing, click Submit and your setup is done.

iOS

The first thing you will have to do is issue an APNS certificate. This is done via Apple's Developer Portal. Keep reading this document to learn how to create an APNS certificate.

Creating an App ID

In this document we will assume you did not create an App ID yet and we will guide through this process.

Start by signing in Apple's Developer Portal. Once you've sign in, you should click in the Certificates, IDs & Profiles menu item:

developer portal menu

This will take you to a new page where you should locate the Identifiers menu item:

developer portal identifiers

In this new page, click in the plus icon:

developer portal create app id

In this page, select the App IDs option:

developer portal app ids

Then go ahead and click in Continue:

developer portal continue button

You are now about to register a new app, start by providing a name for your app and the identifier for your app, this should take the form of a reverse DNS name (eg.: com.mydomain.myapp):

developer portal app id settings

Finally you should select which capabilities your app will use. Obviously you should check all the services you want to use:

developer portal capabilities

Once you are done selecting your app's capabilities, click in Continue:

developer portal continue button

You will then see the confirmation screen with all the services you've selected, if everything is OK go ahead and finish creating your App ID by clicking in Register:

developer portal app id confirm

After that, your app will be in the list of App IDs as shown below:

developer portal app id

Generate an APNS SSL Certificate

Once you've created an App ID or at least have one, you are now ready to create an APNS certificate. This certificate will allow your app to send messages to APNS.

In Apple's Developer Portal, locate the Certificates, IDs & Profiles menu item:

developer portal menu

In this new page, click in the Certificates menu item:

developer portal create certificate

Then go ahead and click in the plus icon:

developer portal create certificate icon

In this page, locate the select the following option:

developer portal ssl certificate select

For the sake of simplicity, let's create an Apple Push Notification Service certificate that works for both Sandbox and Production. You can then use the same certificate for both environments in Notificare.

Go ahead and click in Continue:

developer portal continue button

In this new page, locate and select the App ID you want to use:

developer portal select app id for apns

To proceed, click in Continue:

developer portal continue button

In this new tab, you will need to provide an existing Certificate Signing Request:

developer portal certificate signing request

We will explain how to generate one but if you already have one previously created, just go ahead and select one and click in Continue:

developer portal continue button

If you do not have one, you will have to generate it. For that you will need to open the Keychain Access app from your applications, in your MacOS powered computer and request a signing certificate from an certificate authority by selecting the following:

developer portal keychain access request

You will be prompt with the following window:

developer portal create signing certificate

Simply provide an email and check the Saved to Disk option and then click in Continue, it will prompt you to save a file in your computer:

developer portal save signing certificate

You have now generated a CSR file and you we are ready to resume our the APNS certificate creation in Apple's Developer Portal. In the screen you left off:

developer portal certificate signing request selected

Click in the Continue button:

developer portal continue button

We've now generated an APNS certificate, hit the Download button to download the file to your computer:

developer portal certificate download

Double-click in that file to install it in your Keychain Access app. Then locate it in the Keychain Access app:

developer portal keychain access entry

Then we will need to export this file in a .p12 format. To do that, right-click the file and select the Export option:

developer portal export certificate keychain

This will allow you to name your export file and select the location in your computer where you going to export it. Then click in Save:

developer portal export p12 save

Because these files are extremely important and will give any push provider access to send notifications to your app, you will want to protect it with a password. Once you've provided a password twice, click in the OK button. This will save the file in your computer.

developer portal export p12 password

You now have to upload the resulting .p12 file to Notificare. This will allow us to send notifications to your application. This step is covered in the guides located here.

Generate an APNS Auth Key

Apple introduced this new authentication mechanism with the new APNS service launched in 2016. With these auth keys, you are able to generate one single key for all the apps in your Apple's Developer account. These keys also never expire which makes it easier to manage although if you revoke and generate a new key used by multiple apps, you will need to upload it to all the providers where the revoked key is used.

In Apple's Developer Portal, locate the Certificates, IDs & Profiles menu item:

developer portal menu

In this new page, click in the Keys menu item:

developer portal keys

Then go ahead and click in the plus icon:

developer portal keys icon

In this new page, name the key you are about to register and select the services you want to use (in this case you should select Apple Push Notification service):

developer portal register key

Click in the Continue button:

developer portal continue button

In the next page, confirm the data and click in the Register button:

developer portal key register confirm

Once you've registered the new key you can either download it or postpone that download for a later time. Please note that once you've downloaded it, you cannot do it again:

developer portal key download

If you chose to download it, you will have now a .p8 file ready to be uploaded in Notificare. This will allow us to send notifications to your application. This step is covered in the guides located here.


Once you have completed all the steps above, you are ready to proceed to implement our library. Keep reading our Implementation guides located here.