Follow

Offers Integration

Integration rules described in this section are intended to achieve the following goals: 

  • set up the affiliate network to keep track of all actions performed by advertiser;
  • ensure campaign is set up to work correctly in Post-Click period defined by addendum to the contract;
  • maximize the tracked number of actions lost due to technical constraints;
  • provide advertiser with full data which helps to avoid bad quality traffic.

 

Basic Principles

Basic workflow consists of three parts and can be used for most campaigns. 

Typical example of such workflow is the online store campaign. However, individual peculiarities and technical constraints may affect the workflow. In case standard workflow cannot be used, technical specialist from both sides must work in close cooperation to provide conditions for achieving the goals described above.  

Integration consists of the following parts:

  • processing of click-through from affiliate network to advertiser's site;
  • notifying affiliate network on action; 
  • notifying affiliate network on action status change.

 

s2s Integration (Postbacks)

You can also use postback queries to notify on an action.

 http://postBack.url/postback?clickid={clickid}

 where: 

Additional parameters:

  • &action_id= - unique request ID in the advertiser's system
  • &goal= - goal number or goal value
  • &sum= - payout for conversion
  • &ip= - IP address of visitor that made a request
  • &status= - request status (the default value is 2 - "processing")
  • &device_id= - device ID 
  • &referrer= - referrer (additional information on traffic and deeplinks)
  • &ios_idfa= - ID for advertisers (iOS only)
  • &android_id= - Android ID of device (Android only)
  • &comment= - comment
  • &custom_field1= - custom field 1
  • &custom_field2= - custom field 2
  • &custom_field3= - custom field 3
  • &custom_field4= - custom field 4
  • &custom_field5= - custom field 5
  • &custom_field6= - custom field 6
  • &custom_field7= - custom field 7

 

JS and Image pixel Integration

The system uses tracking pixel (later referred as "pixel") to notify affiliate network on an action performed on advertiser's website. 

In lay terms, when an action is performed, the code of the page that visitor is loading includes the code that loads a transparent 1x1 pixel size image from the Affise server which is invisible for visitor. This image is used to execute a request to the affiliate network server and transfer the required parameters.

<script language="javaScript" type="text/javascript" src="http://click.domain.go2affise.com/track.js"></script>

where

http://click.domain.go2affise.com/ - is a tracking domain specified when creating the application.

If the advertiser assigns unique ID for every action to make it possible to easily find additional information for each action, such ID must be transferred to pixel by the "afid" parameter. Below are ID examples:

  • request number;
  • visitor ID;
  • payment number;
  • the ID of an object created in advertiser's system;
  • and so on.

Any sequence of numbers, letters, and characters without spaces can serve as an ID. The afid parameter is transferred to pixel in the following way: 

<script language="JavaScript" type="text/javascript">
var afid='11111';
var afprice=202.75;
</script>
<script language="javaScript" type="text/javascript" src="http://click.domain.go2affise.com/track.js"></script>

 

Another way to establish js integration is to send a postback through the image.

 
Additional parameters you may add to GET request, for example:
?afid={afid}&afprice={afprice}

 

where:

afid - unique request ID on advertiser's side

afprice - payout for conversion

afgoal - goal ID

afua - user-agent

afcomment - comment

afstatus - status of the conversion

custom_field1 = - custom field 1

custom_field2 = - custom field 2

custom_field3 = - custom field 3

custom_field4 = - custom field 4

custom_field5 = - custom field 5

custom_field6 = - custom field 6

custom_field7 = - custom field 7

The script is intended for transferring visitor's action and must be installed on the page that confirms this action. 

 

Action Status Notification

The system uses automatic data exchange between the affiliate network and the advertiser to notify affiliate network on the status of actions performed on advertiser's website and for tracking actions. JSON format is used for data exchange.


 - Each click at Affise platform has the unique ID  - {clickid}
 - Each conversion has 2 IDs: internal and external (which is received from the advertiser). Internal one is the unique inside the whole Affise system. External one is used for unique connection of the goal value (inside the payment settings) and offer id. 
If your advertiser doesn't send you the unique external id - so the conversion id will be equal to {clickid} value.

Affiliate network sends a query with the IDs. Query frequency and timing is defined by internal settings. To perform data exchange, advertiser must provide address of the website page (script) that will send data transfer query. Data is transferred by the GET method using the UTF-8 character set. The query includes three parameters: 

pass – md5 hash of password (this is an optional parameter that should be confirmed by manager)
ids - IDs array

You can skip using password if data exchange security is not crucial.

Query with IDs:

?ids[]=1&ids[]=2&ids[]=123

 

After receiving such query, the script on advertiser's website generates a result with data on requested actions. Query result includes the following items: 

  • status - query status (1 - success, 0 - fail);
  • result - array of IDs and their statuses, where "id" stands for ID and "status" stands for ID status. 
{
   "status":1,
   "result":[
      {
         "id":"1",
         "status":1
      },
      {
         "id":"2",
         "status":1
      }
   ]
}

 

 

Lead Statuses:

  • 1 – action is «approved» (paid by advertiser);
  • 2 – action is «pending» (decision in process, request status later);
  • 3 – action is «declined» (not paid by advertiser);
  • 4 – requested action «does not exist» (requested ID is not registered on advertiser's site);
  • 5 - action is «approved» and put on Hold (will be paid by advertiser at a certain amount of time - the period of hold is taken from the offer settings).
Was this article helpful?
0 out of 3 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.