Integrating the Larky nudge® library into your mobile banking app is a straightforward process and includes these elements:

• Basic setup
• Initialize the library and handle messaging events
• Prompt for required permissions (optional)
• Return app user identity after authentication
• Handle enabling/disabling nudge® messaging (optional)

Note: Previous versions of the nudge® library combined many of these activities into a single initialization call. Starting with the v4 library, we have separated these into distinct calls to give you complete control over your app flow and user experience. If you have an existing integration, we have this guide that provides an overview of the steps involved in refactoring it for the new library.

Current library versions

iOS

4.2.1

Android

releases.com.larky:nudge:4.2.2

Obtain your Larky nudge® API key and login details

If you don't already have one, you'll need to get a Larky nudge® API key and admin login from the nudge team. The API key, which is case-sensitive, will allow your nudge-connected apps to talk to our servers and let them know how to handle your data.

Basic setup

Follow the steps linked here to prepare your environment and app for integrating the nudge® library.

• Basic setup for an iOS app
• Basic setup for an Android app

Initializing the library and handling messaging events

The library should be initialized early in your application startup flow. This establishes communication between the app and the Larky back-end functionality. It also enables the library to handle events around the receipt properly and tapping of push notifications. 

• Initializing the library in an iOS app
• Initializing the library in an Android app

Prompting for required permissions

Notification permission

Larky uses push notifications, also known as nudges, to communicate with account holders. As such, the app must prompt the user for permission to receive push notifications. If your app already does this, then there's nothing else you'll need to do. If your app does not prompt for push notifications, here are guides to make that happen:

• Prompting for notification permission in an iOS app
• Prompting for notification permission in an Android app

Location permission

For integrations that include location-based messaging, the app will need to request permission from the user to access this information. Nudge requires access to the device's precise location, even when the app is not being used. If your app already prompts for location permission while the app is open, for an ATM or branch locator function, for example, you will still need to add this additional permission request.

• Prompting for location permission in an iOS app
• Prompting for location permission in an Android app

Returning app user identity after authentication

For clients to create segmented messaging, you must pass back a unique identifier for the app user. We refer to this as the Federation ID. This article provides more details on this subject.

The code found in these guides should be placed in your flow shortly after the app user authenticates into the mobile banking application:

• Returning the Federation ID in an iOS app
• Returning the Federation ID in an Android app

Handling enabling and disabling of nudge® messaging

Some mobile banking apps include a preferences or settings page that allows the app user to turn on or off nudge® messaging without having to disable all push notification messaging for the app. Often, this is referenced in the UI as "Enhanced Notifications " or a similar label. See these guides for how to handle this process:

• Enable/disable nudge® messaging in an iOS app
• Enable/disable nudge® messaging in an Android app

Perform integration testing

Refer to this article for our Integration Testing Guide to ensure all elements of your implementation are operating properly.

We strongly recommend that you include the Larky QA team in validating your integration before handing it to the first client for their user acceptance testing. We know the various edge cases inside and out that might not be handled in a preliminary release. We can provide a tight feedback loop with your engineering team to resolve those, ensuring faster delivery time and a better client experience.

If you have questions or need some help just reach out to us at support@larky.com.

Proceed with user acceptance testing!

Now that your apps are integrated and distributed, refer to this testing guide for tips and best-practices in testing your implementation. Note that all notifications sent will go to any users that have downloaded your nudge-powered apps. If you are testing an update to an existing app already in production for a client, ensure you are not executing tests in that production environment!

We're here to help!

Have questions? Just reach out to us through the Submit a request link above, or email us at support@larky.com.