Setup Your App with Locally

Setup Your App with Locally

In order for your application to be able to interact with our platform, you’ll need to login to locally.io with your Developer Account so that you can:

  • Register your application on the Locally platform
  • Optionally, setup Push Notifications by providing a Firebase Cloud Messaging (FCM) Key (Android) and/or a .p12 Certificate (iOS)
  • Be sure to note the Username and Password generated by the system for your application to use; this setup is the only time they’re displayed!
This setup process is the only time you’re presented with login credentials for your app!
Be sure to note them!

Register Your App on the Locally Platform

The first time you login to Locally.io as a Developer, you’ll be presented with Developer Dashboard. Here, you’ll want to click on Create New Application.

Then, on the following screen, click Create Engage SDK Application.

Decide Whether to use the D2Go Demo App

On the Add App screen, after entering a description of the application you are registering, you will have the option of whether or not to use the D2GO demo app for testing.

This option is ideal for Developers or Organizations that don’t yet have a mobile app of their own to integrate Locally’s Engage SDK into, but who still want to test our services, especially our Push Notification functionality.

Decide Whether your Application Will Use Push Notifications

If you plan to use Push Notifications, proceed to the Push Notifications section of this article.

Otherwise, click Create App and then review the Username and Password section of this article.

Setup Push Notifications (Optional)

Because Locally uses AWS SNS (Simple Notification Service) for our Push Notifications, if you plan to use our Push Notifications in your application, you will need to provide:

  • a .p12 Certificate and it’s Password (iOS)
    and/or
  • a Firebase Cloud Messaging Key (Android)

Creating a .p12 Certificate

Apple requires a distribution certificate in order to publish an app to their App Store for distribution. This certificate is contained in a “.p12” file. To create a .p12 file, use your Apple iOS Developer account to:

  • Create a 2048 bit RSA “.certsigninrequest” (CSR) file from within the Certificate Assistant on your mac computer (found under Applications/Utilities/Keychain Access)
  • Generate an Ad Hoc certificate “.cer” file in your iOS developer account
  • Return to the Keychain Access program on your mac  and install the .cer file to add its certificates to your mac computer’s keychain
  • Export the profiles associated with your .cer file to a .p12 file, for which you set a password

You can find more detailed instructions about creating a .p12 file here and here.

 

Finding Your Firebase Cloud Messaging (FCM) Key

To send Push Notifications to your Android app, it must be authorized to use Google’s Firebase Cloud Messaging (FCM) service via the FCM Server API Key associated with your app. To find your FCM Key:

  • Login to the Firebase Developer Console 
  • If you haven’t already, create your project, and then go to the Projects Dashboard for your project
  • Click the Gear icon and select Project Settings

  • On the Cloud Messaging tab of Project Settings, you’ll  find your FCM key

Your App’s Username and Password

After you click the Create App button at the bottom of Locally’s Add App screen, you are taken to the screen displaying the automatically system-generated username and password for your application.

Make a note of your App’s password!  It will not be displayed again.