Appery.io

The Appery.io Developer Hub

Welcome to the Apperyio developer hub. You'll find comprehensive guides and documentation to help you start working with apperyio as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    

Configuration

Enabling and configuring Push Notifications.

You need to enable Push Notifications in the app and in the backend services (server)

Enabling in Backend Services

To turn on messages for this app in backend services:

  1. Click on the Push link in the App Builder toolbar. The settings page for this app will open in a new tab. You can also switch to the Push Notifications tab directly from the app details page.
  2. Check the Enable Push Notifications check box to enable Push Notifications for this app.

Linking with a Database

Push Notifications require using a database. The database stores all registered devices and allows sending targeted Push Notification messages.

For Database, click the Select database button. We recommend creating a new database but you can also use an existing one. Device information is stored in the built-in Devices collection.

Notification Settings

Under the Push settings section, check all the three options. Note that the Badge option is only available for iOS devices.

Android Settings

Push Notification Provider

Please be aware that GCM provider is not supported by Google anymore. Therefore, only FCM provider settings are available. Learn how to migrate your project from GCM to FCM here.

Setting up Firebase Cloud Messaging provider

Existing Firebase Project

This section shows how to create a new project. You can also use an existing project.

  1. Go to http://firebase.google.com and log in with your developer credentials. If you are already signed in, you will see the Go to console link in the upper right corner.
  2. Click the Create New Project button.
  3. Enter the project name, for example, ApperyioPush. Select your country/region and click Create Project.
  4. In the upper left corner, click on the gear icon next to the "Project Overview" and select "Project settings" option:
Project settings.

Project settings.

  1. Click on the Android icon in Your apps section.
  2. Enter the app package name, for example: io.appery.mybigapp. This name should match the name inside the App Builder, in Project > App settings > Android binary.
  3. Click Register App.
  4. Click Download google-services.json and save the google-services.json file to your drive.
  5. Click Next, skip the Add Firebase SDK section, click Next and then Continue to console.
  6. Select the Service Accounts tab.
  7. Click Generate new private key and then Generate key. Download your Firebase private key file to your drive.
  8. Return to Push Notification settings in Appery.io.
  9. Upload google-services.json in Google Services JSON File input.
  10. Upload Firebase private key in Firebase Admin SDK JSON File.

15-20 steps

The next steps were required before, but now Google enables Firebase Cloud Messaging API automatically. You can check the steps to be sure that Firebase Cloud Messaging API is enabled.

  1. Go to https://console.cloud.google.com/apis/dashboard and log in with your developer credentials.
  2. Select your Firebase project in the upper left corner. If you have only one project, it will be selected automatically.
  3. Click Enable APIs and services.
  4. Enter Firebase Cloud Messaging API in search input.
  5. Click Firebase Cloud Messaging API.
  6. Click Enable.

iOS Settings

To enable Push Notifications for an iOS app, you must have a Development Certificate if your app is registered in Development mode, and a Production Certificate if your app is registered in Distribution mode.

  1. If you are using a Production Certificate, check the Production option in the iOS settings section. If you are using a Development Certificate, leave it unchecked.
  2. Upload the Push Notification Client SSL certificate you downloaded from Apple Developer portal.
    • To generate a Push Notifications certificate, you need to open the App Ids page, find the desired App ID, click Configure, and check the Enable for Apple Push Notification service checkbox. Then click Configure (selecting either Development or Production stage).
  3. Fill in the Certificate password that was specified during .p12 certificate creation.

That’s it for iOS configuration.

iOS Bundle ID

The Bundle ID shouldn’t have a wild card character, otherwise, you will not be able to configure push notification properties.

Enabling in the App

Cordova Plugin requirements

The google-services.json file is required with PushPlugin Cordova Plugin for successful project builds. Please don't enable this plugin before configuring Android settings.

To enable Push Notifications in an app, the Push Notifications plug-in has to be activated. Go to Project > App settings > Cordova plugins and enable the PushPlugin Cordova Plugin and Device Cordova Plugin.

Migration from GCM to FCM

Before version 2.0, Cordova Push Plugin used Google Cloud Messaging provider to register devices. As GCM is not supported by Google, all projects with Cordova Push Plugin version lower than 2.0 do not receive push notifications anymore.

Best practices for migration from GCM to FCM

  1. Setup Firebase Cloud Messaging provider on the Push tab.
  2. Update PushPlugin Cordova Plugin in your project. It should be at least 2.0 version.
  3. Publish your project.

Project update

Users won't be able to receive push notifications until they update application. Auto-update feature won't help in this case.

Configuration


Enabling and configuring Push Notifications.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.