Custom integration

Install tracking scripts on your website

This documentation will guide you to implement Affilae Tracking.

➜ Go to step 2 if you use redirect tracking links.

Only two steps are required to set-up Affilae Tracking.

Implement Affilae Tag on every pages of your website. The Affilae Tag will allow you to track events such like clicks and conversions from your partners.
Trigger the Conversion Tag when you want to track an event such like a sale or lead.

① Affilae Tag – Track clicks from your partners

Affilae Tag, which should be embedded on all pages of your website (or landing pages), detects clicks from affiliate websites and protect you from click fraud.

Notes:

The Affilae Tag for your website is different for each program.
The Affilae Tag must be added on every page of your website including confirmation page.
The Affilae Tag must be added within the head section tag OR alternatively just after the opening body tag.

How does it work?

The Tag below starts asynchronously downloading the library from our domain static.affilae.staging1.kaizen-developments.com.
The Tag is initialized by the content of the variable _ae which is mandatory.
The Tag also creates AeTracker object to handle events like new click/conversion.
The Tag should look like the code below, please replace PROGRAM_ID with your own program ID.

<!-- Affilae Tag --> 
<script type="text/javascript">
    var _ae = {
      /* PROGRAM_ID must be changed */
      'pid': 'PROGRAM_ID'
    };
    (function () {
      var element = document.createElement('script'); element.type = 'text/javascript'; element.async = true;
      element.src = '//static.affilae.staging1.kaizen-developments.com/ae-v3.5.js';
      var scr = document.getElementsByTagName('script')[0]; scr.parentNode.insertBefore(element, scr);
    })();
</script>

➜ Affilae Tag extra settings

Variable	Required?	Description	Values
`pid`	Required	Unique id for your affiliate program.	This value is generated automatically and available on your program’s configuration page.
`advertiserFirst`	Optional	The number of minutes elapsed from the first visit to the advertiser’s site which will be counted as being a part of the conversion process if “Split commission” sharing mode is active.	Integer value. Default: `26600` (15 Days).
`cookieExpiration`	Optional	Expiration of the cookie to track clicks.	Integer value. Default: `43200` (30 Days).
`skipMouse`	Optional	Disable mouse detection to trigger a click.	This value must be `true` or `false`. Default: `false`.
`timerLimit`	Optional	Timer in seconds to detect mouse activity.	Integer value Default: `10`
`allowIframing`	Optional	Allows or prevents the advertiser’s web site from being loaded through an HTML iframe embedded on another site.	This value must be `true` or `false`. Default: `true`.
`forceReferer`	Optional	Affiliate clicks must originate from a web site. Set this parameter to `true` in order to prevent affiliates from generating affiliate clicks through emailings.	This value must be `true` or `false`. Default: `false`.
`host`	Optional	Only available if you have custom SSL domain name options activated for your plan. Hostname address of the server which will receive the tracking of affiliate clicks.	URL Default: `https://lb.affilae.staging1.kaizen-developments.com`
`customVar`	Optional	Allows you to include a custom variable in the tracking code (used for cross-selling, cashbacks, etc…).	Character string “URL encoded”
`cookieNameForAdvertiserFirst`	Optional	Cookie name to allow the detection of whether a visitor has already been to the advertiser’s site before having clicked on an affiliate link.	String of characters without spaces or special characters [a-zA-Z0-9]. Default: `AeFirst`
`referrer`	Optional	Allows you to manually specify the URL of the referring web site to be associated with the tracking.	URL Default: `document.referrer`
`tagType`	Optional	Conversion Tag type `iframe` or `pixel`	String Default: `pixel`
`fp`	Optional	Enable FingerPrint	This value must be `true` or `false`. Default: `true`.
`firstParty`	Optional	Enable First Party Cookie	This value must be `true` or `false`. Default: `true`.

②Conversion Tag – Track leads and sales

The conversion Tag triggers an event to our sever in order to track a new conversion.

The server is then able to detect whether a user has been part of an affiliate tracking process or not and a conversion is created if at least one contributor is found.

Conversion Tag must be embedded on the conversion confirmation pages of your web site: order confirmation pages / thank you pages…

Different types of Tags are available to better match your needs. You must create one conversion Tag for each existing rules (i.e. KEY). If required you can add a fall-back Tag by using the JS Tag and iframe Tag together.

JS Tag

<-- Affilae Conversion Tag --> 
 <script type="text/javascript">
      var aeEvent = {};
      /* {{KEY}} must be updated for each rule */
      aeEvent.key = '{{KEY}}';
      aeEvent.Conversion = {};
      /* Values below must be updated */
      aeEvent.Conversion.id = '{{ID}}';
      aeEvent.Conversion.amount = '{{AMOUNT}}';
      aeEvent.Conversion.payment = '{{PAYMENT}}';
      aeEvent.Conversion.voucher = '{{VOUCHER_CODE}}';
	  aeEvent.Conversion.subid = '{{SUB_ID}}';
	  aeEvent.Conversion.customer = '{{CUSTOMER_ID}}';
      aeEvent.Conversion.currency = '{{CURRENCY_CODE}}';
      ('AeTracker' in window)
        ? AeTracker.sendConversion(aeEvent)
        : (window.AE = window.AE || []).push(aeEvent);
</script>

Note: This Tag requires Affilae Tag Implementation (Check Step 1).

Iframe Tag – Fall-back

<!-- Values in query string must be updated -->
<iframe src="https://lb.affilae.staging1.kaizen-developments.com/?key={{KEY}}&id={{UNIQUE_ID}}&amount={{AMOUNT}}&payment={{PAYMENT}}&customer={{CUSTOMER_ID}}&cv={{SUB_ID}}&voucher={{VOUCHER_CODE}}&currency={{CURRENCY_CODE}}" frameborder="0" width="1" height="1"></iframe>

Note: valid for redirect.

Image Tag – Fall-back

<!-- Values in query string must be updated -->
<img src="https://lb.affilae.staging1.kaizen-developments.com/?key={{KEY}}&id={{UNIQUE_ID}}&amount={{AMOUNT}}&payment={{PAYMENT}}&customer={{CUSTOMER_ID}}&cv={SUB_ID}&voucher={{VOUCHER_CODE}}&currency={{CURRENCY_CODE}}" style="display: none;" width="0" border="0" height="0">

Note: valid for redirect.

➜ Parameters to be set:

Variable	Required	Value Information
key	Yes	This key is supplied to you on the “conversion code” page available through your affiliate program Configuration dashboard. e.g.`5f04fe700000000000000000-5f04fe700000000000000000`
id	Yes	Populate this parameter with a unique identifier, for example, a unique order number. If you use this code to confirm a subscription to a newsletter yet you do not have an automatically generated unique identifier, you can, for example, use the user’s email Hash (e.g. MD5) to populate this parameter.
amount	Yes for sales	Total amount Excluding Tax of an order, which will serve as the basis for calculating the commission and Revenue generated. e.g.`123.45`
payment	Yes if conversion requires payment	If the conversions are subject to payment, specify the client’s mode of payment, if not simply leave this parameter blank: `online` for online payment `bankwire` for payment by bank transfer `other` for all other types of payments
customer	Yes if revenue share is activated	Your client identifier if the “Revenue Share” option is activated. Please use an identifier that will not change over time, the best being the ID number used in your database. Leave this parameter blank if you do not use the Revenue Share option.
cv	No	custom variable that will be available in the interface and API: products, new customer etc.
voucher	No	Should be replaced by the voucher code that was applied during the check-out process. Value is case sensitive. Use `;` as a separator to add multiples codes.

Do you need further information? Contact us .