referral_hero_flutter 0.0.1 copy "referral_hero_flutter: ^0.0.1" to clipboard
referral_hero_flutter: ^0.0.1 copied to clipboard

Published 18 months ago • Latest: 0.0.5
[unknown platforms]
→

Metadata

A Flutter plugin for integrating ReferralHero API to manage referrals, contests, and rewards in your mobile applications.

More...

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.1 # 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');

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

Name Type Description
email* String The email of the subscriber. Required if email is the unique identifier for the campaign.
name String The name of the subscriber
crypto_wallet_address* String The crypto wallet address. Required if it is the unique identifier for the campaign.
phone_number* String The phone number of the subscriber. Required if phone number is the unique identifier for the campaign.
extra_field String The extra field value of the subscriber
extra_field_2 String The extra field 2 value of the subscriber
referrer String The referral code or email of the referrer
lifetime_spend Number Lifetime spend of the subscriber
subscribe_page_url String Subscribe Page URL of the Subscriber
landing_page_url String Landing Page URL of the Subscriber
is_quick_add_referral Boolean Send True only if you want to add the referral as Quick Add Referral otherwise False
option_field_value String Option field value of the subscriber
other_identifier_value* String The other identifier value (Required if other identifier enabled as unique identifier)
double_optin Boolean Send True if you want to send verification method before adding otherwise False
points Integer Points of the subscriber
crypto_wallet_provider String The crypto wallet provider
screen_size String The screen size of device used by subscriber when the referral link was clicked
ip_address String The IP address used by subscriber when the referral link was clicked
device String The device used by subscriber when the referral link was clicked
os_type String The Type of Operating system used by subscriber when the referral link was clicked
source String The source of the subscriber.
hosting_url String URL used to generate the referral link.
transaction_id String The unique ID of the transaction. Useful when tracking purchases.
conversion_category String The type of subscriber. Useful for creating reports or segmenting subscribers.
conversion_value Number The monetary conversion value of the subscriber

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.

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.

← Metadata

2
likes
0
points
7
downloads

Publisher

unverified uploader

Weekly Downloads

Metadata

A Flutter plugin for integrating ReferralHero API to manage referrals, contests, and rewards in your mobile applications.

Repository (GitHub)
View/report issues

Documentation

Documentation

License

unknown (license)

Dependencies

flutter, http, plugin_platform_interface

More

Packages that depend on referral_hero_flutter

Packages that implement referral_hero_flutter

Back