Initialize Referd User Profile

Show your user's profile including all details and progress on your Flutter app.

Showing the Referd widget on your mobile application is slightly different than showing it on the website. You have two options; first, if you want to design your customer interface, you will use our set of REST APIs. The other option as this section elaborates, is through using our Flutter SDK.

Using the SDK, you can open the Referd user profile from a button in your app, programmatically when someone does something, or from a persistent button that sits over your app’s UI.

When you trigger the Referd user profile, your player is presented with a home screen. This is configurable inside Referd to change how it looks and what’s presented.

From there, your user can check his progress across different Referd programs as per your configurations.

Referd’s views are accessible through the code below. You just need to use it on any button action.

// If you want to create/Update User just create 
//Send with from string then convert it to json or create a json and sent it directly

let playerAttributesString =  '''
{
  "playerUniqueId": <PLAYER_ID>,
  "mobile": "+1234567",
  "email": "[e-mail]",
  "playerAttributes": {
    "displayName": "Jon Snow",
  },
  "levelOrder": null
}
''';

 final Map<String, dynamic> playerData = jsonDecode(playerDataString);

     apiKey: <YOUR_API_KEY>,
     playerUniqueId: <YOUR_PLAYER_UNIQUE_ID>,
     lang: 'en',
     playerAttributes: playerData
   );
 

// In your widget just path thr context for the sdk like 
 gameball.openGameballView(context);
   
   
   

Once the APIKey and playerUniqueId have been registered, Referd views can be made visible to the user.

The below is description of Initialization params

Parameter	Type	Required	Description
APIKey	string	Yes	Client API key
playerUniqueId	string	Yes	Unique identifier for the user in your database. Could be database ID, random string, email or anything that uniquely identifies the user.
lang	string	No	Your platform language preference to view Referd Widget with. Note: The language provided should be as per configured languages in your account. Example: "en", "fr".

Everytime the Referd View is initialized with a new PlayerUniqueId , the user profile is created or updated at Referd side. You may consider enriching your Referd's user profile with attributes that are not available to the UI by using server side Create\Update User API

Choose an Unchangeable Player Unique ID

Referd user profile gets created using the playerUniqueId. It is highly recommended to have the unique ID as an identifier that would NEVER be changed. If this unique ID changes for a given user, you risk losing all original data for that user on Referd. Accordingly, it is NOT recommended to use email address or mobile number as the unique ID as both can be changed by the user at anytime.