PhunToken Loyalty SDK

PhunToken Loyalty SDK is an Android SDK that allows you to reward reward your users for in-app customer behavior that helps promote increased brand awareness, engagement and loyalty.

_note
PhunToken Loyalty SDK currently only supports Android for SDK 23+.

Using PhunToken Loyalty SDK

Gradle

If using Gradle, add the following to your build.gradle:

maven {
    url "https://nexus.phunware.com/content/groups/public"
}

and the following to your app/build.gradle

implementation "com.phunware.crypto:loyalty:0.1.0"

---

Usage Overview

Initialization

The PhunToken Loyalty SDK is initialized along with your current MaaS SDK integration. That being said, the important integration steps are setting up MaaS Core with relevant appId, accessKey, and secret.

---

Opt In

PhunToken Loyalty SDK is opt in by default and based around your own system of registered users. To opt your user into PhunToken Loyalty SDK you will need to provide the SDK with a unique identifier for the user that maps cleanly to the representation of the user in your own system (such as the email they used to register with your app). It is expected that you will track the opt in state in your own app.

Loyalty.linkManager().linkUser("joe@phunware.com", object : LinkManager.LinkResultListener {
                override fun onSuccess() {
                    Log("Success!")
                }

                override fun onFailure(message: String) {
                    Log("Failure")
                }
            })

---

Checking the users balance

Phunware will maintain a pending balance for your previously opted in users on our servers. You can request this balance at any time (after opt in).

The actual user balance will be returned along with the provided image and metadata you have previously setup in the portal for your loyalty token.

Loyalty.assetManager().balance(object : AssetManager.BalanceListener {
                override fun onSuccess(asset: Asset) {
                    Log("Balance is ${asset.balance}")
                }

                override fun onFailure(message: String) {
                    Log("Failed to get balance")
                }
            })

---

Events

Instrumented Events can be used to reward your user with new Loyalty Tokens or to deduct from their balance to unlock digital content.

Your instrumented events must be setup a head of time on the portal, along with any additional thresholds and limits.

// Share a recipe.  This earns the user two Dessert Coins.
Loyalty.assetManager().fireEvent(
    eventName = "share_recipe",
    parameters = listOf("donut", "eclair"),
    callback = object : AssetManager.FireEventListener {
        override fun onSuccess(sideEffects: List<SideEffect>) {
            // List of SideEffects will have displayable values
            // setup on the portal.
            Log("Success!")
        }

        override fun onFailure(message: String) {
           Log("Failure")
        }
    }
)

---

Linking to PhunToken

You have the option of letting your users link their Loyalty token balance to the PhunWallet app. If you have enabled conversion of your loyalty token into PhunToken, your users will be able to convert at the threshold you specify.

Loyalty.linkManager().linkWallet(
    object : LinkManager.LinkResultListener {
        override fun onSuccess() {
            Log("PhunWallet app installed and linking is in progress.")
        }

        override fun onFailure(message: String) {
            Log("PhunWallet app not installed or other failure.")
        }
    })

---

Class Reference Documentation

The Reference Documentation has all of the detailed usage information including all the public methods, parameters, and convenience initializers.

---

Attribution

PhunToken Loyalty SDK uses the following 3rd party components.

Component	Version	Description	License
OkHttp	3.12.1	An HTTP & SPDY client for Android and Java applications.	[Apache 2.0]
Gson 2.8.5	Gson is a Java library that can be used to convert Java Objects into their JSON representation.	[Apache 2.0]
Picasso	2.71828	A powerful image downloading and caching library for Android.	[Apache 2.0]
Timber	4.7.1	A logger with a small, extensible API which provides utility on top of Android's normal Log class.	[Apache 2.0]

---

Privacy

You understand and consent to Phunware’s Privacy Policy located at www.phunware.com/privacy. If your use of Phunware’s software requires a Privacy Policy of your own, you also agree to include the terms of Phunware’s Privacy Policy in your Privacy Policy to your end users.

---

Terms

Use of this software requires review and acceptance of our terms and conditions for developer use located at http://www.phunware.com/terms/