Flutter

This guide describes how to add and use Apphud SDK to your Flutter app

Installation

Please check the guide at pub.dev.

Initialize SDK

To initialize Apphud SDK you will need API Key. It is a unique identifier of your Apphud application. You can get it in your Apphud application settings under General tab

Basic initialization looks like this:

await AppHud.start(apiKey: "apiKey");

Initialization options:

property

type

platform

required

apiKey

String

iOS, Android

yes

userId

String

iOS, Android

no

deviceId

String

Android

no

observerMode

Bool

iOS

no

You can also initialize SDK with custom Device ID. This should be used if you plan to use logout / login features. If you purchase IAPs using Apphud SDK, you should pass observerMode as false. You can pass the same identifier to Device ID and User ID:

await AppHud.startManually(
apiKey: "apiKey",
userID: "userID",
deviceID: "userID",
observerMode: true,
);

Log out method will clear all saved data and reset SDK to uninitialised state:

await AppHud.logout();

Purchase using Apphud SDK

To make a purchase call:

await AppHud.purchase("productId");

Purchase in Observer Mode (Android)

If you use your own billing on Android then you should sync purchases each time user makes any purchase or restoration. Just call after purchase or restore:

await Apphud.syncPurchases();

Keep in mind, that you are responsible for acknowledging or consuming all purchases in observer mode!

Purchase in Observer Mode (iOS)

Apphud SDK automatically intercepts purchases on iOS and passes receipt data to Apphud servers. No additional code required.

Check Subscription Status

await AppHud.hasActiveSubscription();

Returns true if user has active subscription. Use this method to determine whether to unlock premium functionality to the user.

Get Products

Apphud automatically fetches SKProduct/SkuDetails objects upon launch. Make sure products identifiers are added in Apphud products. To get your products call:

await Apphud.products();

Get Subscription Details

To get subscription object (which contains expiration date, autorenewal status, etc.) use the following method:

await Apphud.subscription();

Check Non-renewing Purchase Status

Use this method to check whether the user has purchased in-app purchase and it's not refunded. Returns false if was never purchased or is refunded.

await Apphud.isNonRenewingPurchaseActive("productIdentifier")

Get Non-renewing Purchase Details

To get non-renewing purchases, which contain purchase date, product identifier and cancellation date, use the following method:

await Apphud.nonRenewingPurchases();

Get User ID

To get user id you can use this method:

await Apphud.userId();

Integrations

Submit attribution data to Apphud from your attribution network provider.

Map<String,dynamic> data = {"key":"value"};
ApphudAttributionProvider provider = ApphudAttributionProvider.appsFlyer;
‚Äč
await AppHud.addAttribution(data: data, provider: provider);

Restore Purchases (iOS)

If your app doesn't have a login system, which identifies a premium user by his credentials, then you need a "restore" mechanism.

await AppHud.restorePurchases();

Basically it just sends App Store Receipt to Apphud and returns subscriptions (or nil, if subscriptions are never purchased), non-renewing purchases (or nil, if there are no any) and an optional error.

Migrate existing purchases (Android)

If you need to migrate existing purchases in case you already have a live app or if you need to restore purchases when user hits Restore button, just call syncPurchases() method.

await Apphud.syncPurchases();

Do not migrate purchases on every app launch. One successful time is enough. Store flag in your app if purchases were successfully migrated.