Initialize Referd User Profile

Show your user's profile including all details.

This guide is not framework specific. Below is a general high level guideline illustrating how to integrate Referd with applicable mobile frameworks

Referd user profile sync

The first touch point is the login/registration screen. This is where users create an account or sign in to an existing account in your app. Referd requires users' profiles to be synced to track their progress and reward them accordingly.

User profiles can be synced using the Create User API method. Where it creates or updates the user's profile with each call.

It's recommended that the Create User API is called with every login or account update.

Depending on your app design, profile sync API calls can be made from your backend system or from within the app.

Show Referd User Profile

The second touch point is to show the player's loyalty profile from Referd within your app. This is where users can view their progress and rewards.

There integrate Referd's loyalty profile into your mobile app use the out-of-the-box widget.

Referd offers pre-built widget that you can easily add to your mobile app if your framework supports Webviews.

let's illustrate the sequence to show Referd profile widget using Webview:

1. Add menu item to your app menu or user's profile page

2. Upon click, open Webview that points to a self-hosted webpage with Referd widget scripts embedded in it.

3. Pass user's data to Webview

The first step is to create a blank HTML page and host it at your desirable domain path as below

https://yourdomain.com/webview-address/index.html

This created empty page will be responsible to load Referd widget for your mobile app user.

On page header include Referd widget loading script.

<script>
    window.GbLoadInit = function(){
        GbSdk.init({
            playerUniqueId: '{{playerUniqueId}}',
            lang: 'en',
            playerAttributes:{},
            APIKey: '{{Your_API_Key}}'
        });
    };
</script>
<script defer src="https://assets.gameball.co/widget/js/gameball-init.min.js"></script>

For mobile app case, a new parameter must exist in the loading script

mobile:true

So the loading script would be as below

<script>
    window.GbLoadInit = function(){
        GbSdk.init({
            playerUniqueId: '{{playerUniqueId}}',
            lang: 'en',
            playerAttributes:{},
            APIKey: '{{Your_API_Key}}',
            mobile:true
        });
    };
</script>
<script defer src="https://assets.gameball.co/widget/js/gameball-init.min.js"></script>

Pass user data to your Webview

The widget will display user's profile depending on the passed parameters to the init script. In order to pass user's data from your mobile app to Webview\Referd's widget, there are two options depending on your framework capabilities.

If the used framework supports passing params\variables to Webview you can pass logged in user profile data directly to the Webview and inject them to Referd widget loading script.

The other option is to pass players data to Referd loading script via query strings while loading Webview as below example

https://yourdomain.com/webview-address?playerUniqueId={{playerUniqueId}}&displayName={{displayName}}

Once the data is added to the query string, you can use JavaScript to retrieve the data and pass it to the Referd widget script. Here's an example of how you can do this:

<script>
    // Get the query string parameters
    const queryString = window.location.search;
    const urlParams = new URLSearchParams(queryString);

    // Get the user's email and display name from the query string
    const playerUniqueId= urlParams.get('playerUniqueId');
    const userDisplayName = urlParams.get('displayname');

    window.GbLoadInit = function(){
        GbSdk.init({
            playerUniqueId: {{playerUniqueId}},
            mobile:true,
            playerAttributes: {
                displayName: {{displayName}}
            },
            lang: 'en',
            APIKey: '{{Your_API_Key}}'
        });
    };
</script>

By following the steps outlined above, you can easily pass user data to the widget script and provide your users with a seamless and personalized experience.

If you choose to go with using the pre-built widget in a Webview. You need to take care of the Webview interactions within your app. How the user can navigate from and to the Webview easily. We recommend showing the Webview as a modal with a back button on top.