Public Methods
ReferralHero iOS Swift SDK
ReferralHero provides a very simple and efficient approach for an application to communicate with our SDK.
A whole set of public methods exists within the SDK using which you can easily access most of the data, execute various SDK tasks, invoke from a large set of APIs, etc.
RH is the main object through which you can access all the APIs and get its response in the delegate methods.assign delegate of Viewcontroller class like below.
Use the following code to instantiate the RH class:
Here are the delegate methods by which Response will be received:
1. Add Subscriber
This method is most commonly used to add an organic subscriber or create a referral (if identified) after a user successfully signs up or logs in to your app.
When using this method please take note of your Campaign Goal as our tracking logic will depend on if you are tracking a single or multi-step conversion event.
GOAL: One Conversion Event If you have your Campaign Goal set up to track one conversion event, the following tracking logic will take place:
If a referral, a referral will be automatically created and set to Confirmed in the correct campaign.
If not a referral, an organic subscriber will be created in the campaign UUID specified.
If the subscriber exists in our database, the subscriber will be 'identified'. Data is not overwritten. Additional data will be created.
GOAL: Two or Three Conversion Events If you have your Campaign Goal set up to track two or three conversion events, the following tracking logic will take place:
If a referral, a referral will be created and set to Pending in the correct campaign.
If not a referral, an organic subscriber will be created in the campaign UUID specified.
If the subscriber exists in our database, the subscriber will be 'identified'. Data is not overwritten.
Step 1. Input Parameters
Parameters
Here are more input parameters.
This class provides various methods to set several user referral details like name, email, device, etc. This class is used mainly to pass referral details data to the SDK while accessing its public method or while updating user information.
Step 2. ReferRHSubscriber Model
Step 3. Implementation
To add a subscriber (for example, post a successful signup or login) simply call ReferralHero's RH.formSubmit()
function and send the RHSubscriber
information such as email address and name.
The minimum values you should send for the endpoint to work are the following:
To identify and create a referral, you must also send either the Referrer value OR the required mobile params so that our matching algorithm can automatically identify a referral.
NOTE: The mobile parameters must be sent in the correct format for our system to automatically identify and create a referral. See the Getting Started section here.
The accepted Screen Size formats are:
2. Add Pending Referral
This method is most commonly used to create a referral entering the 1st step of your multi-step conversion event funnel (i.e. after a referred user successfully signs up for your app). If you want us to automatically add every user to your campaign and determine if the user is a referral or not, use the Add Subscriber method instead. This logic only checks for referrals:
Tracking Logic
GOAL: Two or Three Conversion Events
Your campaign Goal must be set up to track two or three conversion events, and then the following tracking logic will take place:
If a referral, a referral will be automatically created and set to Pending in the correct campaign.
If not a referral, no subscriber will be created.
Step 1. Input Parameters
Parameters
Step 2. Implementation
Create a ReferralParams class object and set the various user details to recognize the user matching your back-end system. To add a pending referral, simply call ReferralHero's RH.CreatePendingReferral()
function and send the ReferralParams information such as email address and name.
The minimum values you should send for the endpoint to work are the following:
OR
NOTE: The mobile parameters must be sent in the correct format for our system to automatically identify and create a referral. See the Getting Started section here.
3. Track Referral
This method is used for tracking a referral conversion event (i.e. a purchase, but can be any conversion event).
Tracking Logic:
If a referral and pre-existing in the campaign as Pending
OR
If a referral and setReferrer or mobile pramas are provided, a referral is automatically created in the correct campaign and
The Referral Is Set To:
Confirmed (if tracking two conversion events)
Unconfirmed (if tracking three conversion events)
Note:
Your campaign must be set up as a custom event or a multi-step event otherwise, an error will return.
If the referral is present in ReferralHero with pending status, a successful response
custom_event_completed
will return.If the referral unique identifier is not present in the ReferralHero, but the referrer unique identifier is present, a successful response
custom_event_completed
with the data of the new confirmed referral will return.If a referral exists but the referral status is not pending, the error
custom event is already completed
will return.If the referral unique identifier is not present in ReferralHero and the referrer is also not provided in the API, the error
referer is invalid or not present
will return.If the referral status is unconfirmed or confirmed, the error
custom event is already completed
will return.
When tracking referrals on your App you should ALWAYS send the ACTUAL unique identifier (email, phone number, crypto wallet address, or other ID) of the user in RHSubscriber class Object
Step 1. Input Parameters
Parameters
Step 2. Implementation
Call RH.trackReferral
(RHTrackReferral referralparams ). Use the following code to Track Referral:
If the referral is pre-existing in the campaign, the minimum value for this endpoint to work:
If the referral is NOT pre-existing in the campaign (and you want to identify and create a referral), you must send either the setReferrer OR the required mobile parameters in the correct format so that our matching algorithm can automatically identify a referral. See the Getting Started section here.
4. Confirm Referral
Use this method when your Campaign Goal is set to track three conversion events and you want to confirm a referral when your third conversion event occurs (complete profile, upgrade to a paid plan, end of the trial, etc).
Tracking Logic:
If a referral and pre-existing in the campaign as Unconfirmed
The Referral Is Set To:
Confirmed (if tracking three conversion events)
Only verified referrals can be confirmed. Trying to confirm a non-verified referral will return a subscriber_not_found
error.
Step 1. Input Parameter
Parameters
Step 2. Implementation
Call the RH.ConfrimReferral
method of the RH class.
5. Organic Track Referral
If you would like to add an organic subscriber or a track referral on the conversion page to your referral campaign, you can use the following method. This method would most commonly be used if the user has not been previously added to your campaign and instead directly passes through a post-checkout/subscribe event.
Tracking Logic:
If a referral and pre-existing in the campaign as Pending
OR
If a referral and setReferrer or mobile params are provided, a referral is automatically created in the correct campaign and
The Referral Is Set To:
Confirmed (if tracking two conversion events)
Unconfirmed (if tracking three conversion events)
OR
If not a referral, an organic subscriber is created in the campaign UUID specified.
Step 1. Input Parameters
Parameters
Step 2. Implementation
Create a RHOrganicReferral model and set the various user details to recognize the user matching your back-end system.
If the referral is NOT pre-existing in the campaign (and you want to identify and create a referral), you must send either the setReferrer OR the required mobile parameters in the correct format so that our matching algorithm can automatically identify a referral. See the Getting Started section here.
6. Update Subscriber Details
This method is used to update various subscriber related data.
First, create a RHSubscriber model and set the user data you want to update.
Parameters
Step 1. Input Parameters
Step 2. ReferRHSubscriber Model
Step 3. Implementation
To update the subscriber simply call ReferralHero's RH.UpdateSubscriber()
function and send the RHSubscriber
information such as email address and name.
7. Get Subscriber Details
This method is used to retrieve Subscriber details. RH.getSubscriberDetail()
Step 1. Input Parameters
Parameters
Step 2. Implementation
To get the subscriber details simply call ReferralHero's RH.getSubscriberDetail()
function.
8. Delete Subscriber
This method is used to Delete a newly Created Subscriber.
Step 1. Input Parameters
Parameters
Step 2. Implementation
To delete the subscriber simply call ReferralHero's RH.DeleteSubscriber()
.
9. Capture Share
Step 1. Method Usage
This method is used to send the Share event to the RH. It means if a user called this method with any params like Facebook, messenger, etc. We capture this as a share in our system.
Step 2. Input Parameters
Parameters
Step 3. Implementation
Call the RH.clickCapture method of the RH class and pass “social” as an input parameter. Use the following code to Capture Share for a user:
10. Get My Referrals
This method is used for retrieving all referrals of the specific subscriber.
Step 1. Input Parameters
Parameters
Step 2. Implementation.
Call RH.getMyReferrals()
method of the RH class
Use the following code to Get My Referrals:
11. Get Leaderboard
This method is used for retrieving the campaign leaderboard. It will get the leaderboard from the Campaign specified in the Appdelegate.swift file.
Step 1. Input Parameters
Parameters
Step 2. Implementation
Call the RH.getLeaderboard()
method of the RH class to get the Subscriber Leaderboard.
12. Get Referrer
Step 1. Input Parameter
Parameters
NOTE:
The mobile parameters must be sent in the correct format for our system to automatically identify a referral. See the Getting Started section here.
Step 2. Implementation
Call the RH.GetReferrer() method of the RH class. Use the following code to get the referrer:
13. Get Rewards
Call the RH.RewardsList method of the RH class. Use the following code to get the rewards:
Last updated