Pngme Android (Flutter) Integration Guide

This documentation covers how to use the Kotlin SDK v2.x with Flutter.

You can find similar documentation for Expo, Flutter-Kotlin, Kotlin and React Native.

Pngme does not currently provide a native Flutter (Dart) SDK but the Kotlin SDK is compatible with Flutter apps using the following steps.

Setup

1. The SDK supports Android API version 16+
2. The SDK enables your app to:
   1. Register a mobile phone user with Pngme
   2. Periodically send data to Pngme to analyze financial events
3. Using the SDK requires an SDK Token
   • Sign up for a free Pngme Dashboard account then access your SDK token from the Keys page
   • Use the test SDK token during development but replace with the production SDK token before deploying your app to the Google Play store
   • A custom consent dialog for requesting SMS permissions from the user. You can follow the design guide here to create a custom dialog.

After integrating the SDK, financial data will be accessible in the Pngme Dashboard and via the Pngme REST APIs.

Integrating the SDK

Step 1

Add the JitPack package manager to /android/build.gradle.

    allprojects {
        repositories {
            maven { url 'https://jitpack.io' }
        }
    }

Step 2

Check that ext.kotlin_version >= '1.4.32' in /android/build.gradle. You can skip this step if you are using a newer version.

buildscript {
    ext.kotlin_version = '1.4.32'  // update version here
    ...

Step 3

Add the following dependencies to /android/app/build.gradle.

dependencies {
    // add from here
    implementation 'com.github.pngme:android-sdk:v7.0.1'
    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'androidx.multidex:multidex:2.0.1'
    // to here
}

Step 4

Enable multidex support in /android/app/build.gradle.

android {
    defaultConfig {
        multiDexEnabled = true
    }
}

Step 5

Add the compatibility activity from /android/app/src/main/java/com/example/sampleflutter/PngmeSDKHelper.java by copying the entire file into your project.

⚠️ Modify the top line of the PngmeSDKHelper.java file to match your project path/naming.

package com.example.sampleflutter  // update project name here

Step 6

Add the PngmeSDKHelper as an activity in /android/app/src/main/AndroidManifest.xml.

⚠️ Modify com.example.sampleflutter to match your project name.

<activity android:name="com.example.sampleflutter.PngmeSDKHelper" android:theme="@style/Theme.AppCompat.NoActionBar" />
<!--                   ^ update project name here                                                                   -->

Step 7

Add the Flutter channel and ensure you override the configureFlutterEngine method in your main activity similar to /android/app/src/main/java/com/example/sampleflutter/MainActivity.java.

Step 8

Call the Pngme SDK via the Flutter channel from your main Flutter app, passing the goWithCustomDialog method in the channel. hasAcceptedTerms should be set to true if the user given consent via the custom consent dialog. The custom should be implemented and shown to the user before calling the SDK.

value = await sdkChannel.invokeMethod("goWithCustomDialog", <String, dynamic>{
        'sdkToken': 'XXXXXXX',
        'firstName': 'Nico',
        'lastName': 'Rico',
        'email': 'nicorico@pngme.com',
        'phoneNumber': '2348118445990',
        'externalId': '',
        'companyName': 'AcmeInc',
        'hasAcceptedTerms': true, // default is false
      });

⚠️ The SDK Token is sensitive and must be protected. It should be passed to the application at compile time and encrypted. Consider using an encrypted secrets manager (such as AWS Secrets Manager) to store the SDK token.

The SDK Token as an inline string is shown here for demonstration purposes only.

Field	Description
sdkToken	the SDK Token from the Pngme Dashboard Keys page
firstName	the mobile phone user's first name
lastName	the mobile phone user's last name
email	the mobile phone user's email address
phoneNumber	the mobile phone user's phone number, example "23411234567"
externalId	a unique identifier for the user provided by your app; if none available, pass an empty string ""
companyName	your company's name, used in the display header of the SMS Permission Flow
hasAcceptedTerms	Set the value to 'true' if the user has accepted the terms and conditions when invoking the 'goWithCustomDialog' method. Defaults to false

PngmeSDK API

isPermissionGranted()

fun isPermissionGranted(context: Context): Boolean

Field	Description
context	the current app Context

This indicates if the user has accepted the SMS permissions request:

• Returns true if the user has accepted the SMS permission request.
• Returns false if the user has denied the SMS permission request.

Sending test data

This can be tested in a sample app running in the local emulator, assuming the emulated app is running with a valid SDK Token.

Android Emulator can simulate incoming SMS messages, and we can use this to test the Pngme SDK locally.

If a valid SDK token is used in the 'sdkToken': 'XXXXXXX' parameter, then the below SMS will be successfully sent to the Pngme system.

The following text message is of a recognized format for the Stanbic bank sender: Stanbic.

Acc:XXXXXX1111
CR:NGN4,000.00
Desc:HELLO WORLD! SAMPLE MESSAGE
Bal:NGN50,000.00

You can inject this fake SMS into the emulated phone by following these steps. It is advisable that you pre-populate the emulated phone with the SMS before running the sample app.

Once the app gets the permissions form the user it will instantly start sending existing SMS messages to the Pngme system. This results in messages being seen way sooner than SMS received after the app was installed.

The daemon is processing new messages every 30 minutes, so the new feed messages will take at least 30 minutes to appear in the webconsole.

1. Open the more window in the emulator settings
2. Navigate to the phone section
3. Set the sender to the string Stanbic or one of the senders from our supported institutions
4. Copy/Paste the above same message into the message box
5. Hit Send Message

After following the above steps to send a fake SMS, run the sample app. The fake SMS will be sent to the Pngme system using the SDK token from your Pngme account. If the sample app runs successfully, the financial data in the text message will be accessible via the Pngme REST APIs or in the Pngme webconsole.

Next steps

See Going Live with the SDK to learn more about the whitelisting process with the Google Play store.