Initial Setup

Initial Setup

In order to get started with NodiRef, you will need a minimal setup on your platform before having everything good to go!

In this setup, we'll create the main resources and understand a little bit how the platform works, in order to have the best results possible.

Create a Project

Before starting anything, it's best to create a new Project, so that we can set the base settings to apply later on on the rest of resources.

To create a new Project, you can go to the Projects section in the sidebar, and click on the Create Project button on the top right corner.

More information on how to create a Project can be found in the Projects section.

Create a Partner

After creating a Project, it's time to create a Partner, so that we can have some links to start tracking!

To create a new Partner, you can go to the Partners section in the sidebar, and click on the Create Partner button on the top right corner.

More information on how to create a Partner can be found in the Partners section.

When a Partner is created with a Project assigned, a new Link will be created automatically, so that we can send it to the referrals! However, if you did not assign a Project to the Partner, no Link will be created, so you will have to create it manually in the Partner's details page.

Web Integration

Once that's configured, it's time to integrate a JavaScript snippet to your website and start tracking the referrals!

To do so, we will have to add the following snippet to the landing page that we configured in the Create a Project step.

<script
  src="https://cdn.nodiref.com/nodiref-sdk.js"
  type="text/javascript"
  async
></script>
<script type="text/javascript">
!function(){"use strict";!function(){var n=window,i="nodiRef";if(!n[i]||!n[i].loaded){var o=n[i]&&n[i].q||[],d=function(n,...i){d.q.push([n,i])};d.q=o,d.loaded=!1,n[i]=d}}()}();
 
  nodiRef("identify", "partner-id-here"); // If there is a session active, call this with the Partner's ID to identify it
</script>

This snippet will detect automatically the clicks sent to the navigator, and send the proper events to the API, however, if you have an active session and you have access to the Partner's ID, you should identify the Partner in order to make a follow-up of their metadata for the fraud detection system.

If you want to add some configurations, you can call the following method before the SDK is initialized:

nodiRef("config", {
  host: "https://api.nodiref.com",
  // ... All the desired configuration here
});

Though this won't be really necessary as we take care of the configuration on the back-office directly, and we pull it on every action happening on the client's side.

With the SDK, you can perform the publicly accessible actions, such as:

Identify a Partner

API Reference

nodiRef("identify", "partner-id-here");

Track a Click

API Reference

nodiRef("track", "click", 'REFERRAL_CODE');

The SDK will handle the storage of the code, until the Referral Creation is called, then it will register a new referral with the referral code if available.

Create a Referral

In order to better track a referral once they've signed up, you should call the referral creation and send the tracking ID provided by the click event. This will create a new referral and link it to the partner that referred them.

API Reference

nodiRef("referral", "EXTERNAL_ID");

Track a Conversion

When a conversion occurs, you have to send us an event with the ID of the referral (Or External ID) and the conversion data, you can find more information about the fields tracked in each conversion type in the Conversions section.

API Reference

nodiRef("track", "conversion", {
  // Conversion data here, check the API to know what to send
});

Reward Settings

Once that the tracking is set up, it's time to configure the rewards for the referrals. This configuration will allow you to configure a set of triggers and conditions for your rewards, and will also let you tell us how you want to compute the rewards on the conversions.

To do so, you can go to the Settings > Reward Rule Sets section in the sidebar, and click on the New Reward Rule Set button on the top right corner.

This will open a new Wizard, to guide you through different steps to correctly setup your rule set, it's pretty self-explanatory, but here are some key points:

1. Rule Set -> This is the main step, here you will configure the Rule Set Name, to which project it affects (If no project specified, it'll be a global rule set) and its description
2. Triggers -> Here you will set up a generic trigger type, and you will configure some conditions also. A conversion must meet all those triggers to be eligible for a reward.
3. Rewards -> Here you will set up how we will compute the rewards for the conversions that meet the triggers. You can also set a Max Cap in case there's a limit on the individual rewards for that specific rule set.

With the Reward Rule Sets configured, you will be good to go, and start getting referrals and rewarding the partners accordingly. In order to better understand how the Reward Rule Sets work, you can check the Reward Rule Sets section, and feel free to reach out to us if you have any questions!