Articles & Information.

Referral ID

Select a topic:

Choose from one of the topics below to browse other articles

Last updated by Ryan Miller on July 25, 2013 15:55

Below is the detailed explanation on What Referral IDs are, Code samples of how to use it and lastly how to get your own Referral ID for your app. 


 1. What are Referral IDs

Referral IDs are generated numbers which uniquely identify your app, enabling other users to quickly and easily add your app by clicking on links or allowing other developers to refer users to your app.  The ID generates all the necessary background code to enable the “adding of the app” when clicking on the link. 


2. How do I use  Referral IDs

Below is the code you will need to add to your app when making use of the Referral ID


2.1 For your Mobi Portal App:

Code example for referring your app to users’ friends: 

Generic: “mxit://[communityportal]/RecommendPage?ItemId=<YOUR Referral ID>”
Example: 
<a href="mxit://[communityportal]/RecommendPage?ItemId=5909525" type="mxit/service-navigation">8. Refer Idols to a friend</a></li></span>

Code example when other developers refer their users to your app:

Generic: “mxit://[communityportal:Refresh]/ReferralPage?ItemId=<YOUR Referral ID>”

Example:

<a href="mxit://[communityportal:Refresh]/ReferralPage?ItemId=5909525" type="mxit/service-navigation">8. Click here to add Idols</a></span>


2.2 For your .NET App:

Although we would recommend you use the REST/User API Social Graph calls for this interaction:

The MXit.Messaging.MessageReceived class has functions to build these redirect links:
e.g.
CreateRedirectRequest("communityportal", "RecommendPage?ItemId=000000")
or
CreateRedirectRequest("communityportal:Refresh", "ReferralPage?ItemId=000000")
Send to the user via the SDK call: client.RedirectUser(redirectRequest)

Example of how this is done in app (dstv_shows - Idols 8) 

Example of how this is done in an app (this example is dstv_shows)

Figure 1: Example of how this looks on the Mxit client.

Please note the following in terms of the wording for the Referral ID:
  • The message that the receiving user gets, “Hey, have a look at [appname]. It’s pretty darn cool if you ask me!”, cannot be customised.
  • The heading can be customized as well as the link in the receiver message, where heading in the text seen when selecting a friend/friends from your contact list.


Figure 2: Custom message created when you select friends to tell about the app.. 

cant customized this
Figure 3: Example of the message the receiving user gets, which cannot be modified. 


3. How do I get a referral ID for my app?


In order to obtain a Referral ID for your app, please visit Mxit Developer Support Center to request the Referral ID and supply your developer username and the app name in your query. The unique 6-digit or 7-digit referral ID will be sent to you within two business days of the request being received.

Or you can now make use of the new and improved Recommend Service for easier and quicker referrals and recommendations!