ReferralHero Flutter SDK #

The ReferralHero Flutter SDK provides a simple way to integrate referral and contest functionality into your Flutter application. This SDK enables you to refer friends, track referrals, and incentivize user engagement.

Features #

• Add and manage subscribers
• Track referrals and conversion events
• Capture share events
• Retrieve referral and leaderboard data
• Create and manage pending referrals
• Confirm referrals
• Track organic referrals
• Retrieve rewards and referrer details

Installation #

Add the following dependency to your pubspec.yaml file:

dependencies:
  referral_hero_flutter: ^0.0.2 # Use the appropriate version from pub.dev

Then run:

flutter pub get

Usage #

Initialization #

To use the SDK, you need to initialize it with your API key and UUID:

import 'package:referral_hero_flutter/referral_hero_flutter.dart';

final referralHeroService = ReferralHeroFlutter('your-api-key', 'your-uuid');

Tracking Referrals #

Now that you have implemented the SDK, you can start identifying and tracking referrals!

For that, you will need 2 things:

• Universal Link
• Your Integrated App The RH SDK pulls information from your device, like this:

final referralParams = {
  'email': '[email protected]', // Capture this from user
  'domain': 'https://a.domain.co/', // Optional value, and set as default by admin
  'name': 'User Name', // Capture this from user
  'referrer': 'referrerCode', // Optional value, only necessary if you want to capture the referrer code from user
  'uuid': 'MFcd4113d4bf', // Get this from RH Dashboard
  'device': referralHeroService.deviceInfo.getDeviceType(), // Get device type
  'ip_address': referralHeroService.deviceInfo.getIpAddress(), // Get IP address
  'os_type': referralHeroService.deviceInfo.getOperatingSystem(), // Get operating system type
  'screen_size': referralHeroService.deviceInfo.getDeviceScreenSize() // Get screen size
};

The format for screen sizes is not native to RH, and the format should be parsed to RH accepted, such as:

String transformResolution(String input) {
  final dimensions = input.split('*').map((e) => e.trim()).toList();
  return '${dimensions[0]} x ${dimensions[1]}';
}

With this information, you should be able to add the subscriber data, with the Get Referrer, Add Subscriber, Create Pending Referral, or Track Referral methods to automatically identify or track a referral:

void formSubmit() {
  referralHeroService.addSubscriber(referralParams);
}

To further understand the implementation of these methods, please check the Public Methods section and our GitHub Sample Project.

Methods #

Add Subscriber #

Adds a new subscriber.

final subscriber = {
  'email': '[email protected]',
  'name': 'Test User 24',
  'phone_number': '9898989896',
  // Add other fields as necessary
};
await referralHeroService.addSubscriber(subscriber);

Request Body

Get Subscriber Details #

Fetches the details of a specific subscriber.

final details = await referralHeroService.getSubscriberDetails('subscriberId');

Update Subscriber #

Updates the details of a specific subscriber. You can reference the parameters from the "Add Subscriber" section for available fields.

final updates = {
'name': 'Updated Name',
// Add other fields as necessary
};
await referralHeroService.updateSubscriber('subscriberId', updates);

Delete Subscriber #

Deletes a specific subscriber.

await referralHeroService.deleteSubscriber('subscriberId');

Track Referral #

Tracks a referral conversion event.

final referral = {
'email': '[email protected]',
'name': 'Test name updated',
// Add other fields as necessary
};
await referralHeroService.trackReferral(referral);

Capture Share #

Captures a share event for a subscriber.

await referralHeroService.captureShare('subscriberId', 'facebook');

Get My Referrals #

Retrieves all referrals for a specific subscriber.

final referrals = await referralHeroService.getMyReferrals('subscriberId');

Get Leaderboard #

Fetches the campaign leaderboard.

final leaderboard = await referralHeroService.getLeaderboard();

Create Pending Referral #

Creates a pending referral.

final referral = {
'email': '[email protected]',
'name': 'Pending User',
// Add other fields as necessary
};
await referralHeroService.createPendingReferral(referral);

Organic Track Referral #

Tracks an organic referral event.

final referral = {
'email': '[email protected]',
'name': 'Organic User',
// Add other fields as necessary
};
await referralHeroService.organicTrackReferral(referral);

Confirm Referral #

Confirms a referral.

await referralHeroService.confirmReferral('subscriberId');

Get Referrer #

Retrieves the referrer details based on a query.

final query = {
'os_type': 'ios',
'device': 'iPhone',
'ip_address': '192.168.0.1',
'screen_size': '1200x1800'
};
final referrer = await referralHeroService.getReferrer(query);

Get Rewards #

Fetches the rewards for a specific subscriber.

final rewards = await referralHeroService.getRewards('subscriberId');

Example #

See the full example in example/lib/main.dart for a complete usage demonstration.

License #

This project is licensed under the MIT License. See the LICENSE file for details.

Support #

For any issues or feature requests, please open an issue on the GitHub repository. For documentation and additional support, visit the ReferralHero Support.