Offerit - User contributions [en]

Offerit REST API Edit Offer

2020-11-18T20:05:30Z

OfferitDave:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''PATCH /offer/edit_offer''' ==
'''Description'''
*edit_offer edits an existing offer

'''Resource URL'''
*<nowiki>http://domain/api/offer/edit_offer</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
=== '''Offer Parameters''' ===
*offerid
**'''''type: string'''''
**'''''required'''''
**Id of offer to edit
*name
**'''''type: string'''''
**Offer Name
*offer_description
**'''''type: string'''''
**Description to display to affiliates
*hidden
**'''''type: string'''''
**Offer does not show up in the affiliate offer list.
*date_live
**'''''type: string'''''
**Time when offer should become available to affiliates. String to time on the string provided. Default is empty.
*date_expire
**'''''type: string'''''
**Time when offer should stop being available to affiliates. String to time on the string provided. Default is empty.
*featured
**'''''type: bool'''''
*thumb_url
**'''''type: string'''''
**Url of offer thumbnail image.
*force_url
**'''''type: string'''''
**Url to screenshot for thumbnail.
**Flags this as a featured offer. Default FALSE.
*expire_url
**'''''type: string'''''
**External URL to redirect traffic to if the offer is expired.
*expire_landing_pageid
**'''''type: string'''''
**ID of landing page to redirect traffic to if the offer is expired.
*no_personal_member_info
**'''''type: string'''''
**Prevent name and address information from being stored in the customer record
*subject_lines
**'''''type: string'''''
**Comma separated list of recommended subject lines for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*from_addresses
**'''''type: string'''''
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*ip_lookup
**'''''type: Bool'''''
** Set cookieless tracking to match on only IP instead of IP+Browser Details. Default FALSE.
*ip_uniqueness_seconds
**'''''type: int'''''
**Set the number of seconds before a repeat visit by the same visitor will trigger the 'unique' offer redirect contition. This does not affect them showing as unique in stats. Default is unset on the offer level and inheriting from the "Unique Visitor Time" configuration setting.
*offer_groups
**'''''type: int,string,array'''''
**Accepts an existing offer group id, comma separated list of group ids, or array of group ids to associate with this offer.
*marketing_types
**'''''type: int,string,array'''''
**Accepts an existing marketing type id, comma separated list of marketing type ids, or array of marketing type ids to associate with this offer.
*categories
**'''''type: int,string,array'''''
**Accepts an existing category id or category name, comma separated list of ids/names, or array of ids/names to associate with this offer. Creates new categories if a category name is passed that does not exist.
*authorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is authorized to use this offer. Defaults to the 'Default Authorized Countries' configuration setting.
*unauthorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is not authorized to use this offer. Defaults to the 'Default Unauthorized Countries' configuration setting.
If no authorized or unauthorized countries are set even after checking the network configurations, the offer is authorized for all countries by default.
*device_types
**'''''type: array'''''
**'''''possible values : 0 (desktop) 1 (mobile) 2 (tablet)'''''
**Accepts an array of device types to accept. Send empty array to unset.
*suppress_conversion_pixels
**'''''type: bool'''''
**If true, conversions will not trigger affiliate pixels (but goals assigned to the conversion column still will).
*suppress_continuity_pixels
**'''''type: bool'''''
**If true, continuities will not trigger affiliate pixels (but goals assigned to the continuity column still will).

==='''Advertiser Parameters'''===
*advertiserid
**'''''type: int'''''
**Loginid of advertiser account associated with this offer. Default none.
*advertiser_cost_type
**'''''type: string'''''
**'''''options:'''''
***conversion:flat amount per conversion
***dynamic_conversion:uses the revenue passed with the conversion
***sale:calculate a percentage of the gross sale amount reported by the advertiser
***click:a flat amount per click
***unique:a flat amount per unique click
**If there is an advertiser associated with this offer, how is offer revenue calculated. Default none.
*advertiser_cost_flat
**'''''type: string'''''
**Flat cost to advertisers. used with 'conversion','click','unique'
*advertiser_cost_perc
**'''''type: string'''''
**Percentage cost to advertiser used with 'sale'

==='''Fraud Prevention Parameters'''===
*ip_conversion_limit_flag
**'''''type: int'''''
**'''''options'''''
***0: Inherit from Network Configuration
***1: No Limit on this offer
***2: Specify Limimt on this offer
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled. Default 0.
*ip_conversion_limit
**'''''type: int'''''
**Number of conversions allowed per IP to this offer in any 24 hour time period. Only checked if ip_conversion_limit_flag=2. Default 0.
*ip_conversion_group
**'''''type: int'''''
**'''''options'''''
***0: This offer only
***x: Group id of any offer group.
**Controls the scope of ip_conversion_limit. Default is 0, this offer only. Specifying a group id will count all conversion for offers in that group
*prevent_cookie_dupes
**'''''type: Bool'''''
**Checks a cookie to block surfers that have already converted on this offer during the cookie lifetime. Default FALSE.
*pending_approval_lockout
**'''''type: int'''''
**Minimum number of seconds that must pass between a click and a conversion for that conversion to be automatically approved. While this setting is in effect, all conversions on this offer are treated as pending. If the lockout period has been reached, the system will record both a pending conversion and an approved conversion automatically. Default 0 to disable.

==='''Revenue Parameters'''===
*conversion_default
**'''''type: string'''''
**Amount used if none is specified in the conversion. Default none.
*conversion_default_type
**'''''type: int'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in conversion_default is revenue or gross. Default 1 for revenue
*continuity_default
**'''''type: int'''''
**Amount used if none is specified in the continuity. Default none.
*continuity_default_type
**'''''type: string'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in continuity_default is revenue or gross. Default 1 for revenue

==='''Commission Parameters'''===
*percentage_commission_source
**'''''type: int''''
**'''''options'''''
***0:Revenue
***1:Gross
** Specify whether revenue or gross should be used as the base when affiliate are paid a percentage. Default 0 for revenue
*hide_payout_string
**'''''type: bool''''
**Hide the automatically generated commission description and use the description in 'commission_description' instead.
*commission_description
**'''''type: string''''
**Custom description displayed to affiliates to explain how commissions are calculated for this offer.
*commission_type
**'''''type: string''''
**'''''options'''''
***cpa:Flat per CPA. Works with flat_amount_per_conversion and flat_amount_per_continuity
***cps:Percentage of Sale. Works with percentage_of_customer_conversion and percentage_of_customer_continuity
***click:Flat per Click. Works with flat_amount_per_click and flat_amount_per_visitor
***hybrid:Hybrid. Works with all fields.
**Specify what type of commission this offer will pay.
*flat_amount_per_click
**'''''type: decimal''''
** Flat commission paid for every raw click. Works with click or hybrid
*flat_amount_per_visitor
**'''''type: decimal''''
** Flat commission paid for every unique click. Works with click or hybrid
*flat_amount_per_conversion
**'''''type: decimal''''
** Flat commission paid for every conversion. Works with cpa or hybrid
*flat_amount_per_continuity
**'''''type: decimal''''
** Flat commission paid for every continuity. Works with cpa or hybrid
*percentage_of_customer_conversion
**'''''type: decimal''''
** Percentage of conversion revenue to pay as commission. Works with cps or hybrid
*percentage_of_customer_continuity
**'''''type: decimal''''
** Percentage of continuity revenue to pay as commission. Works with cps or hybrid
*retro_payout
**'''''type: bool''''
*All transactions for a customer will use the commission settings in place at the time of the first transaction.
*hide_deductions
**'''''type: bool''''
*Only show voids / chargebacks in affiliate statistics if they affected affiliate commissions.
*hide_continuities
**'''''type: bool''''
*Only show continuities in affiliate statistics if they affected affiliate commissions.
*hide_conversions
**'''''type: bool''''
*Only show conversions in affiliate statistics if they affected affiliate commissions.
*deduct_voids
**'''''type: bool''''
**When enabled, voids will reverse the commission paid to the affiliate on the original transaction that is being voided
*deduct_chargebacks
**'''''type: bool''''
**When enabled, chargebacks will reverse the commission paid to the affiliate on the original transaction that is being charged back
*min_deduct_date
**'''''type: string''''
**Date for stringtotime. Transactions before this date will never have their commissions removed by a void or chargeback.
*deduct_window
**'''''type: int''''
**If a void or chargeback is reported more than this many days after the original transaction, the affiliate will not have their commission removed even if deduct_voids or deduct_chargebacks is enabled.

== '''Example Request''' ==

'''PATCH'''
<pre>
<nowiki>
http://domain/api/offer/edit_offer
name=edited API TEST OFFER
authorized=GB,IT
advertiserid=9
advertiser_cost_type=conversion
advertiser_cost_flat=25
commission_type=cps
percentage_of_customer_conversion=15
percentage_of_customer_continuity=5
</nowiki>
</pre>

*Response:
<pre>
{
"result":"Success",
"message": "offer_saved"
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/offer/edit_offer';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'offerid' => 251,
'name' => 'edited API TEST Offer',
'authorized' => 'GB,IT',
'advertiserid' => 9,
'advertiser_cost_type' => 'conversion',
'advertiser_cost_flat'=> 25,
'commission_type' => cps,
'percentage_of_customer_conversion' => 15,
'percentage_of_customer_continuity' => 5,
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Add Offer

2020-11-18T20:02:49Z

OfferitDave: /* Offer Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /offer/add_offer''' ==
'''Description'''
*add_offer adds a new offer

'''Resource URL'''
*<nowiki>http://domain/api/offer/add_offer</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
=== '''Offer Parameters''' ===
*name
**'''''type: string'''''
**'''''required'''
**Offer Name
*offer_description
**'''''type: string'''''
**Description to display to affiliates
*hidden
**'''''type: bool'''''
**0 or 1. If set to 1, offer does not show up in the affiliate offer list.
*date_live
**'''''type: string'''''
**Time when offer should become available to affiliates. String to time on the string provided. Default is empty.
*date_expire
**'''''type: string'''''
**Time when offer should stop being available to affiliates. String to time on the string provided. Default is empty.
*featured
**'''''type: bool'''''
**Flags this as a featured offer. Default FALSE.
*expire_url
**'''''type: string'''''
**External URL to redirect traffic to if the offer is expired.
*expire_landing_pageid
**'''''type: string'''''
**ID of landing page to redirect traffic to if the offer is expired.
*no_personal_member_info
**'''''type: string'''''
**Prevent name and address information from being stored in the customer record
*subject_lines
**'''''type: string'''''
**Comma separated list of recommended subject lines for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*from_addresses
**'''''type: string'''''
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*ip_lookup
**'''''type: Bool'''''
** Set cookieless tracking to match on only IP instead of IP+Browser Details. Default FALSE.
*ip_uniqueness_seconds
**'''''type: int'''''
**Set the number of seconds before a repeat visit by the same visitor will trigger the 'unique' offer redirect contition. This does not affect them showing as unique in stats. Default is unset on the offer level and inheriting from the "Unique Visitor Time" configuration setting.
*offer_groups
**'''''type: int,string,array'''''
**Accepts an existing offer group id, comma separated list of group ids, or array of group ids to associate with this offer.
*marketing_types
**'''''type: int,string,array'''''
**Accepts an existing marketing type id, comma separated list of marketing type ids, or array of marketing type ids to associate with this offer.
*categories
**'''''type: int,string,array'''''
**Accepts an existing category id or category name, comma separated list of ids/names, or array of ids/names to associate with this offer. Creates new categories if a category name is passed that does not exist.
*authorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is authorized to use this offer. Defaults to the 'Default Authorized Countries' configuration setting.
*unauthorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is not authorized to use this offer. Defaults to the 'Default Unauthorized Countries' configuration setting.
If no authorized or unauthorized countries are set even after checking the network configurations, the offer is authorized for all countries by default.
*device_types
**'''''type: array'''''
**'''''possible values : 0 (desktop) 1 (mobile) 2 (tablet)'''''
**Accepts an array of device types to accept. Default is null (no device restriction).
*remove_ocode
**'''''type: Bool'''''
** Remove ocode when sending surfer to landing page. Default FALSE to pass along.

==='''Advertiser Parameters'''===
*advertiserid
**'''''type: int'''''
**Loginid of advertiser account associated with this offer. Default none.
*advertiser_cost_type
**'''''type: string'''''
**'''''options:'''''
***conversion:flat amount per conversion
***dynamic_conversion:uses the revenue passed with the conversion
***sale:calculate a percentage of the gross sale amount reported by the advertiser
***click:a flat amount per click
***unique:a flat amount per unique click
**If there is an advertiser associated with this offer, how is offer revenue calculated. Default none.
*advertiser_cost_flat
**'''''type: string'''''
**Flat cost to advertisers. used with 'conversion','click','unique'
*advertiser_cost_perc
**'''''type: string'''''
**Percentage cost to advertiser used with 'sale'

==='''Fraud Prevention Parameters'''===
*ip_conversion_limit_flag
**'''''type: int'''''
**'''''options'''''
***0: Inherit from Network Configuration
***1: No Limit on this offer
***2: Specify Limimt on this offer
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled. Default 0.
*ip_conversion_limit
**'''''type: int'''''
**Number of conversions allowed per IP to this offer in any 24 hour time period. Only checked if ip_conversion_limit_flag=2. Default 0.
*ip_conversion_group
**'''''type: int'''''
**'''''options'''''
***0: This offer only
***x: Group id of any offer group.
**Controls the scope of ip_conversion_limit. Default is 0, this offer only. Specifying a group id will count all conversion for offers in that group
*prevent_cookie_dupes
**'''''type: Bool'''''
**Checks a cookie to block surfers that have already converted on this offer during the cookie lifetime. Default FALSE.
*pending_approval_lockout
**'''''type: int'''''
**Minimum number of seconds that must pass between a click and a conversion for that conversion to be automatically approved. While this setting is in effect, all conversions on this offer are treated as pending. If the lockout period has been reached, the system will record both a pending conversion and an approved conversion automatically. Default 0 to disable.

==='''Revenue Parameters'''===
*conversion_default
**'''''type: string'''''
**Amount used if none is specified in the conversion. Default none.
*conversion_default_type
**'''''type: int'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in conversion_default is revenue or gross. Default 1 for revenue
*continuity_default
**'''''type: int'''''
**Amount used if none is specified in the continuity. Default none.
*continuity_default_type
**'''''type: string'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in continuity_default is revenue or gross. Default 1 for revenue

==='''Commission Parameters'''===
*percentage_commission_source
**'''''type: int''''
**'''''options'''''
***0:Revenue
***1:Gross
** Specify whether revenue or gross should be used as the base when affiliate are paid a percentage. Default 0 for revenue
*hide_payout_string
**'''''type: bool''''
**Hide the automatically generated commission description and use the description in 'commission_description' instead.
*commission_description
**'''''type: string''''
**Custom description displayed to affiliates to explain how commissions are calculated for this offer.
*commission_type
**'''''type: string''''
**'''''options'''''
***cpa:Flat per CPA. Works with flat_amount_per_conversion and flat_amount_per_continuity
***cps:Percentage of Sale. Works with percentage_of_customer_conversion and percentage_of_customer_continuity
***click:Flat per Click. Works with flat_amount_per_click and flat_amount_per_visitor
***hybrid:Hybrid. Works with all fields.
**Specify what type of commission this offer will pay.
*flat_amount_per_click
**'''''type: decimal''''
** Flat commission paid for every raw click. Works with click or hybrid
*flat_amount_per_visitor
**'''''type: decimal''''
** Flat commission paid for every unique click. Works with click or hybrid
*flat_amount_per_conversion
**'''''type: decimal''''
** Flat commission paid for every conversion. Works with cpa or hybrid
*flat_amount_per_continuity
**'''''type: decimal''''
** Flat commission paid for every continuity. Works with cpa or hybrid
*percentage_of_customer_conversion
**'''''type: decimal''''
** Percentage of conversion revenue to pay as commission. Works with cps or hybrid
*percentage_of_customer_continuity
**'''''type: decimal''''
** Percentage of continuity revenue to pay as commission. Works with cps or hybrid
*retro_payout
**'''''type: bool''''
*All transactions for a customer will use the commission settings in place at the time of the first transaction.
*hide_deductions
**'''''type: bool''''
*Only show voids / chargebacks in affiliate statistics if they affected affiliate commissions.
*hide_continuities
**'''''type: bool''''
*Only show continuities in affiliate statistics if they affected affiliate commissions.
*hide_conversions
**'''''type: bool''''
*Only show conversions in affiliate statistics if they affected affiliate commissions.
*deduct_voids
**'''''type: bool''''
**When enabled, voids will reverse the commission paid to the affiliate on the original transaction that is being voided
*deduct_chargebacks
**'''''type: bool''''
**When enabled, chargebacks will reverse the commission paid to the affiliate on the original transaction that is being charged back
*min_deduct_date
**'''''type: string''''
**Date for stringtotime. Transactions before this date will never have their commissions removed by a void or chargeback.
*deduct_window
**'''''type: int''''
**If a void or chargeback is reported more than this many days after the original transaction, the affiliate will not have their commission removed even if deduct_voids or deduct_chargebacks is enabled.

=== '''Landing Page Parameters''' ===
*url
**'''''type: string'''''
**'''''required'''
**Landing Page url
*preview_url
**'''''type: string'''''
**Clean url to display to affiliates
*tracking_domain
**'''''type: string'''''
**One of your already defined tracking domains
*thumb_url
**'''''type: string'''''
**Url of offer thumbnail image.
*force_url
**'''''type: string'''''
**Url to screenshot for thumbnail.
*language
**'''''type: int''''
**id of one of your defined languages from the offers admin.
*conversion_type
**'''''type: string'''''
**'''''options: iframe,post,image'''''
**Type of conversion to use for this offer
*postback_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post conversions to this offer. Default is no restriction
*hostnpost_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post hostandpost conversions to this offer. Default is no restriction
*void_ips
**'''''type: string'''''
**Comma separated list of ips that are allowed to post voids to this offer. Default is deny all.
*private
**'''''type: bool'''''
**TRUE means the default landing page for the new offer will be private. Default is FALSE.
*requestable
**'''''type: bool'''''
**TRUE means the default landing page for the new offer will be requestable if it is also private. Default is FALSE.
*internal_desc
**'''''type: string'''''
**Landing page description for the new offer that is only in the admin interface. Default is empty.
*redirect_hash
**'''''type: string'''''
**Matching field for identifying what landing page to use when geo redirecting within an offer group. Default is empty.
*disable_url_sanitization
**'''''type: bool'''''
**Uses landing page url exactly as provided without encoding any invalid url characters. Default is false, encoding invalid url characters in the landing page.
*disable_deep_linking
**'''''type: bool'''''
**Discards any extra path and variables specified by the affilaite on the tracking link. Default is false, allowing the affiliate to affect the landing page url.

== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/offer/add_offer
name=API TEST OFFER
url=http://example.com/?id=%%click_hash%%
preview_url=http://example.com/
authorized=DE,ES
advertiserid=1
advertiser_cost_type=conversion
advertiser_cost_flat=20
commission_type=201
flat_amount_per_conversion=15
flat_amount_per_continuity=5
</nowiki>
</pre>

*Response:
<pre>
{
"result":"Success",
"message":{
"landing_pageid":"432",
"offerid":"400"
}
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/offer/add_offer';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'name' => 'API TEST Offer',
'url' => 'http://example.com/?id=%%click_hash%%',
'preview_url' => 'http://example.com/',
'authorized' => 'DE,ES',
'advertiserid' => 1,
'advertiser_cost_type' => 'conversion',
'advertiser_cost_flat'=> 20,
'commission_type' => 201,
'flat_amount_per_conversion' => 15,
'flat_amount_per_continuity' => 5,
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Dynamic Advertiser Revenue

2020-06-23T21:03:42Z

OfferitDave: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /advertiser/dynamic_advertiser_revenue''' ==
'''Description'''
*adds revenue from an advertiser. This revenue isn't attached to any specific transaction and doesn't generate affiliate commissions.
*the required passthrough fields for the landing page url are %%aff_id%%, %%identid%% and %%device_tracking_id%%. These must be sent to the advertiser and returned as part of the post.

'''Resource URL'''
*<nowiki>http://domain/api/advertiser/dynamic_advertiser_revenue</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*loginid
**'''''type: integer'''''
**'''''required'''''
**Loginid of affiliate (from %%aff_id%% landing page passthrough)
*identid
**'''''type: integer'''''
**'''''required'''''
**identid of surfer (from %%identid%% landing page passthrough)
*device_tracking_id
**'''''type: integer'''''
**'''''required'''''
**device_tracking_id of surfer (from %%device_tracking_id%% landing page passthrough)
*time
**'''''type: string'''''
**'''''required'''''
**time to insert this entry for (as yyyy-mm-dd hh:00:00)
*revenue
**'''''type: decimal'''''
**'''''required'''''
**Revenue for this entry (as xx.yy)

== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/affiliate/dynamic_advertiser_revenue
inserts[1][identid]=111
inserts[1][loginid]=1
inserts[1][device_tracking_id]=1111
inserts[1][time]=2020-01-01 05:00:00
inserts[1][revenue]=11.22
inserts[2][identid]=22
inserts[2][loginid]=1
inserts[2][device_tracking_id]=2222
inserts[2][time]=2020-01-01 05:00:00
inserts[2][revenue]=22.22
</nowiki>
</pre>
*Response:
<pre>
[
{
"result":"Mixed Success","
"successes":[
'Insert 2 Successful'
],
"errors":[
'Insert 1 Failed'
],

}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$url = 'http://domain/api/affiliate/dynamic_advertiser_revenue';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = array(
inserts = Array(
1 = Array(
'loginid' => 1,
'identid' => 111,
'device_tracking_id' => '11111',
'time' => '2020-01-01 13:00:00',
'revenue' => '22.13'
),
2 = Array(
'loginid' => 1,
'identid' => 222,
'device_tracking_id' => '11111',
'time' => '2020-01-01 14:00:00',
'revenue' => '11.22'
),
)
);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

Offerit REST API Dynamic Advertiser Revenue

2020-06-12T22:11:16Z

OfferitDave: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /advertiser/dynamic_advertiser_revenue''' == '''Description''' *adds revenue from an advertiser. This revenue..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /advertiser/dynamic_advertiser_revenue''' ==
'''Description'''
*adds revenue from an advertiser. This revenue isn't attached to any specific transaction and doesn't generate affiliate commissions.
*the required passthrough fields for the landing page url are %%aff_id%%, %%identid%% and %%device_tracking_id%%. These must be sent to the advertiser and returned as part of the post.

'''Resource URL'''
*<nowiki>http://domain/api/advertiser/dynamic_advertiser_revenue</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*loginid
**'''''type: integer'''''
**'''''required'''''
**Loginid of affiliate (from %%aff_id%% landing page passthrough)
*identid
**'''''type: integer'''''
**'''''required'''''
**identid of surfer (from %%identid%% landing page passthrough)
*device_tracking_id
**'''''type: integer'''''
**'''''required'''''
**device_tracking_id of surfer (from %%device_tracking_id%% landing page passthrough)
*device_tracking_id
**'''''type: string'''''
**'''''required'''''
**time to insert this entry for (as yyyy-mm-dd hh:00:00)
*revenue
**'''''type: decimal'''''
**'''''required'''''
**Revenue for this entry (as xx.yy)

== '''Example Request''' ==

'''POST'''
<pre>
<nowiki>
http://domain/api/affiliate/dynamic_advertiser_revenue
inserts[1][identid]=111
inserts[1][loginid]=1
inserts[1][device_tracking_id]=1111
inserts[1][time]=2020-01-01 05:00:00
inserts[1][revenue]=11.22
inserts[2][identid]=22
inserts[2][loginid]=1
inserts[2][device_tracking_id]=2222
inserts[2][time]=2020-01-01 05:00:00
inserts[2][revenue]=22.22
</nowiki>
</pre>
*Response:
<pre>
[
{
"result":"Mixed Success","
"successes":[
'Insert 2 Successful'
],
"errors":[
'Insert 1 Failed'
],

}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$url = 'http://domain/api/affiliate/dynamic_advertiser_revenue';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = array(
inserts = Array(
1 = Array(
'loginid' => 1,
'identid' => 111,
'device_tracking_id' => '11111',
'time' => '2020-01-01 13:00:00',
'revenue' => '22.13'
),
2 = Array(
'loginid' => 1,
'identid' => 222,
'device_tracking_id' => '11111',
'time' => '2020-01-01 14:00:00',
'revenue' => '11.22'
),
)
);

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

Multi Factor Authentication

2020-06-11T05:27:51Z

OfferitDave:

{{Offerit Manual}}
[[Category:Offerit Affiliate Information]]
Multi factor authentication (Two factor authentication) a feature in [[Offerit]] that gives users the option to protect access to their account with Google Authenticator.

== Configuration ==
There are two configuration options you can set for Multi Factor Authentication.
* Drift Window: accounts for desynchronized clocks, letting tokens that are slightly older or newer than expected work.
<br>[[File:MFA_Drift.png|600px]]<br>

* Affiliate Login Form MFA: adds the MFA field to our default affiliate login templates.
<br>[[File:MFA_Display.png|600px]]<br>

== Enabling ==

There is an 'Two Factor Authentication' action in the affiliates admin.
<br>[[File:MFA_Admin.png|600px]]<br>

Then you can generate a new qr code.
<br>[[File:MFA_Generate.png|600px]]<br>
== Validating ==

Use your app to scan the qr code or generate a new one and type in the token, then click 'Enable Two Factor'.
<br>[[File:MFA_Admin_validate.png|600px]]<br>
Enabled status will change to Active.

== Logging In ==
If you added MFA field to the default login process, you will see it in the template all the time.
<br>[[File:MFA_Login.png|600px]]<br>
If not, you will be prompted to verify your information a second time, or can directly load
(/external.php?page=access&code=12),

If you use a customized template or external login form, you will need to add a field with name='twofactor' to pass the token in.

File:MFA Display.png

2020-06-11T04:42:32Z

OfferitDave:

File:MFA Drift.png

2020-06-11T04:42:11Z

OfferitDave:

File:MFA Admin validate.png

2020-06-11T04:41:36Z

OfferitDave:

File:MFA Generate.png

2020-06-11T04:41:20Z

OfferitDave:

File:MFA Admin.png

2020-06-11T04:40:44Z

OfferitDave:

Affiliate Multi Factor Authentication

2020-06-10T22:06:53Z

OfferitDave: Created page with "{{Offerit Manual | show_for_affiliates_section = true }} Category:Offerit Affiliate Information Multi factor authentication a feature in Offerit that gives Ct#Affili..."

{{Offerit Manual
| show_for_affiliates_section = true
}}
[[Category:Offerit Affiliate Information]]
Multi factor authentication a feature in [[Offerit]] that gives [[Ct#Affiliate|Affiliates]] the option to protect access to their account with Google Authenticator.

== Enabling ==

The MFA section is at the bottom your account details page (internal.php?page=account) .
<br>[[File:MFA_Create.png|600px]]<br>

== Validating ==
Use your app to scan the qr code and type in the token, then click 'Enable'.
<br>[[File:MFA_Validate.png|600px]]<br>
MFA status will change to Active.

== Disabling ==
Click 'Remove' next to MFA Secret to disable
<br>[[File:MFA_Remove.png|600px]]<br>

== Logging In ==
If your network has added MFA field to the default login process, you will see it in the template all the time.
<br>[[File:MFA_Login.png|600px]]<br>
If they have not, you will be prompted to verify your information a second time, or can directly load
(/external.php?page=access&code=12)

Multi Factor Authentication

2020-06-10T21:21:07Z

OfferitDave:

Multi Factor Authentication

2020-06-10T19:57:32Z

OfferitDave:

{{Offerit Manual
| show_for_affiliates_section = true
}}
[[Category:Offerit Affiliate Information]]
Multi factor authentication a feature in [[Offerit]] that gives [[Ct#Affiliate|Affiliates]] the option to protect access to their account with Google Authenticator.

== Enabling ==

The MFA section is at the bottom your account details page (internal.php?page=account) .
[[File:MFA_Create.png]]

== Validating ==
Use your app to scan the qr code and type in the token, then click 'Enable'.
[[File:MFA_Validate.png]]
MFA status will change to Active.

== Disabling ==
Click 'Remove' next to MFA Secret to disable
[[File:MFA_Remove.png]]

== Logging In ==
If your network has added MFA field to the default login process, you will see it in the template all the time.
[[File:MFA_Login.png]]
If they have not, you will be prompted to verify your information a second time, or can directly load
(/external.php?page=access&code=12)

Multi Factor Authentication

2020-06-10T19:56:25Z

OfferitDave: Created page with "{{Offerit Manual | show_for_affiliates_section = true }} Multi factor authentication a feature in Offerit that gives Affiliates the option to protect acc..."

{{Offerit Manual
| show_for_affiliates_section = true
}}

Multi factor authentication a feature in [[Offerit]] that gives [[Ct#Affiliate|Affiliates]] the option to protect access to their account with Google Authenticator.

== Enabling ==

The MFA section is at the bottom your account details page (internal.php?page=account) .
[[File:MFA_Create.png]]

== Validating ==
Use your app to scan the qr code and type in the token, then click 'Enable'.
[[File:MFA_Validate.png]]
MFA status will change to Active.

== Disabling ==
Click 'Remove' next to MFA Secret to disable
[[File:MFA_Remove.png]]

== Logging In ==
If your network has added MFA field to the default login process, you will see it in the template all the time.
[[File:MFA_Login.png]]
If they have not, you will be prompted to verify your information a second time, or can directly load
(/external.php?page=access&code=12)

File:MFA Login.png

2020-06-10T19:56:19Z

OfferitDave:

File:MFA Access.png

2020-06-10T19:55:37Z

OfferitDave:

File:Login.png

2020-06-10T19:53:57Z

OfferitDave:

File:MFA Remove.png

2020-06-10T19:31:47Z

OfferitDave:

File:MFA Validate.png

2020-06-10T19:31:29Z

OfferitDave:

File:MFA Create.png

2020-06-10T19:31:12Z

OfferitDave:

Offerit REST API Edit Offer

2019-07-18T15:33:39Z

OfferitDave: /* Offer Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''PATCH /offer/edit_offer''' ==
'''Description'''
*edit_offer edits an existing offer

'''Resource URL'''
*<nowiki>http://domain/api/offer/edit_offer</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
=== '''Offer Parameters''' ===
*offerid
**'''''type: string'''''
**'''''required'''''
**Id of offer to edit
*name
**'''''type: string'''''
**Offer Name
*offer_description
**'''''type: string'''''
**Description to display to affiliates
*hidden
**'''''type: string'''''
**Offer does not show up in the affiliate offer list.
*date_live
**'''''type: string'''''
**Time when offer should become available to affiliates. String to time on the string provided. Default is empty.
*date_expire
**'''''type: string'''''
**Time when offer should stop being available to affiliates. String to time on the string provided. Default is empty.
*featured
**'''''type: bool'''''
*thumb_url
**'''''type: string'''''
**Url of offer thumbnail image.
*force_url
**'''''type: string'''''
**Url to screenshot for thumbnail.
**Flags this as a featured offer. Default FALSE.
*expire_url
**'''''type: string'''''
**External URL to redirect traffic to if the offer is expired.
*expire_landing_pageid
**'''''type: string'''''
**ID of landing page to redirect traffic to if the offer is expired.
*no_personal_member_info
**'''''type: string'''''
**Prevent name and address information from being stored in the customer record
*subject_lines
**'''''type: string'''''
**Comma separated list of recommended subject lines for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*from_addresses
**'''''type: string'''''
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled
*ip_lookup
**'''''type: Bool'''''
** Set cookieless tracking to match on only IP instead of IP+Browser Details. Default FALSE.
*ip_uniqueness_seconds
**'''''type: int'''''
**Set the number of seconds before a repeat visit by the same visitor will trigger the 'unique' offer redirect contition. This does not affect them showing as unique in stats. Default is unset on the offer level and inheriting from the "Unique Visitor Time" configuration setting.
*offer_groups
**'''''type: int,string,array'''''
**Accepts an existing offer group id, comma separated list of group ids, or array of group ids to associate with this offer.
*marketing_types
**'''''type: int,string,array'''''
**Accepts an existing marketing type id, comma separated list of marketing type ids, or array of marketing type ids to associate with this offer.
*categories
**'''''type: int,string,array'''''
**Accepts an existing category id or category name, comma separated list of ids/names, or array of ids/names to associate with this offer. Creates new categories if a category name is passed that does not exist.
*authorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is authorized to use this offer. Defaults to the 'Default Authorized Countries' configuration setting.
*unauthorized
**'''''type: string,array'''''
**Accepts a comma separated list or array of 2 letter country codes where traffic is not authorized to use this offer. Defaults to the 'Default Unauthorized Countries' configuration setting.
If no authorized or unauthorized countries are set even after checking the network configurations, the offer is authorized for all countries by default.
*suppress_conversion_pixels
**'''''type: bool'''''
**If true, conversions will not trigger affiliate pixels (but goals assigned to the conversion column still will).
*suppress_continuity_pixels
**'''''type: bool'''''
**If true, continuities will not trigger affiliate pixels (but goals assigned to the continuity column still will).

==='''Advertiser Parameters'''===
*advertiserid
**'''''type: int'''''
**Loginid of advertiser account associated with this offer. Default none.
*advertiser_cost_type
**'''''type: string'''''
**'''''options:'''''
***conversion:flat amount per conversion
***dynamic_conversion:uses the revenue passed with the conversion
***sale:calculate a percentage of the gross sale amount reported by the advertiser
***click:a flat amount per click
***unique:a flat amount per unique click
**If there is an advertiser associated with this offer, how is offer revenue calculated. Default none.
*advertiser_cost_flat
**'''''type: string'''''
**Flat cost to advertisers. used with 'conversion','click','unique'
*advertiser_cost_perc
**'''''type: string'''''
**Percentage cost to advertiser used with 'sale'

==='''Fraud Prevention Parameters'''===
*ip_conversion_limit_flag
**'''''type: int'''''
**'''''options'''''
***0: Inherit from Network Configuration
***1: No Limit on this offer
***2: Specify Limimt on this offer
**Comma separated list of recommended from addresses for affiliates promoting via email. Only displayed when "Display Offer Email Fields" is enabled. Default 0.
*ip_conversion_limit
**'''''type: int'''''
**Number of conversions allowed per IP to this offer in any 24 hour time period. Only checked if ip_conversion_limit_flag=2. Default 0.
*ip_conversion_group
**'''''type: int'''''
**'''''options'''''
***0: This offer only
***x: Group id of any offer group.
**Controls the scope of ip_conversion_limit. Default is 0, this offer only. Specifying a group id will count all conversion for offers in that group
*prevent_cookie_dupes
**'''''type: Bool'''''
**Checks a cookie to block surfers that have already converted on this offer during the cookie lifetime. Default FALSE.
*pending_approval_lockout
**'''''type: int'''''
**Minimum number of seconds that must pass between a click and a conversion for that conversion to be automatically approved. While this setting is in effect, all conversions on this offer are treated as pending. If the lockout period has been reached, the system will record both a pending conversion and an approved conversion automatically. Default 0 to disable.

==='''Revenue Parameters'''===
*conversion_default
**'''''type: string'''''
**Amount used if none is specified in the conversion. Default none.
*conversion_default_type
**'''''type: int'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in conversion_default is revenue or gross. Default 1 for revenue
*continuity_default
**'''''type: int'''''
**Amount used if none is specified in the continuity. Default none.
*continuity_default_type
**'''''type: string'''''
**'''''options'''''
***1:Revenue
***2:Gross
** Specify if the amount specified in continuity_default is revenue or gross. Default 1 for revenue

==='''Commission Parameters'''===
*percentage_commission_source
**'''''type: int''''
**'''''options'''''
***0:Revenue
***1:Gross
** Specify whether revenue or gross should be used as the base when affiliate are paid a percentage. Default 0 for revenue
*hide_payout_string
**'''''type: bool''''
**Hide the automatically generated commission description and use the description in 'commission_description' instead.
*commission_description
**'''''type: string''''
**Custom description displayed to affiliates to explain how commissions are calculated for this offer.
*commission_type
**'''''type: string''''
**'''''options'''''
***cpa:Flat per CPA. Works with flat_amount_per_conversion and flat_amount_per_continuity
***cps:Percentage of Sale. Works with percentage_of_customer_conversion and percentage_of_customer_continuity
***click:Flat per Click. Works with flat_amount_per_click and flat_amount_per_visitor
***hybrid:Hybrid. Works with all fields.
**Specify what type of commission this offer will pay.
*flat_amount_per_click
**'''''type: decimal''''
** Flat commission paid for every raw click. Works with click or hybrid
*flat_amount_per_visitor
**'''''type: decimal''''
** Flat commission paid for every unique click. Works with click or hybrid
*flat_amount_per_conversion
**'''''type: decimal''''
** Flat commission paid for every conversion. Works with cpa or hybrid
*flat_amount_per_continuity
**'''''type: decimal''''
** Flat commission paid for every continuity. Works with cpa or hybrid
*percentage_of_customer_conversion
**'''''type: decimal''''
** Percentage of conversion revenue to pay as commission. Works with cps or hybrid
*percentage_of_customer_continuity
**'''''type: decimal''''
** Percentage of continuity revenue to pay as commission. Works with cps or hybrid
*retro_payout
**'''''type: bool''''
*All transactions for a customer will use the commission settings in place at the time of the first transaction.
*hide_deductions
**'''''type: bool''''
*Only show voids / chargebacks in affiliate statistics if they affected affiliate commissions.
*hide_continuities
**'''''type: bool''''
*Only show continuities in affiliate statistics if they affected affiliate commissions.
*hide_conversions
**'''''type: bool''''
*Only show conversions in affiliate statistics if they affected affiliate commissions.
*deduct_voids
**'''''type: bool''''
**When enabled, voids will reverse the commission paid to the affiliate on the original transaction that is being voided
*deduct_chargebacks
**'''''type: bool''''
**When enabled, chargebacks will reverse the commission paid to the affiliate on the original transaction that is being charged back
*min_deduct_date
**'''''type: string''''
**Date for stringtotime. Transactions before this date will never have their commissions removed by a void or chargeback.
*deduct_window
**'''''type: int''''
**If a void or chargeback is reported more than this many days after the original transaction, the affiliate will not have their commission removed even if deduct_voids or deduct_chargebacks is enabled.

== '''Example Request''' ==

'''PATCH'''
<pre>
<nowiki>
http://domain/api/offer/edit_offer
name=edited API TEST OFFER
authorized=GB,IT
advertiserid=9
advertiser_cost_type=conversion
advertiser_cost_flat=25
commission_type=cps
percentage_of_customer_conversion=15
percentage_of_customer_continuity=5
</nowiki>
</pre>

*Response:
<pre>
{
"result":"Success",
"message": "offer_saved"
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/offer/edit_offer';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'offerid' => 251,
'name' => 'edited API TEST Offer',
'authorized' => 'GB,IT',
'advertiserid' => 9,
'advertiser_cost_type' => 'conversion',
'advertiser_cost_flat'=> 25,
'commission_type' => cps,
'percentage_of_customer_conversion' => 15,
'percentage_of_customer_continuity' => 5,
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Replacement Variables

2019-04-24T22:28:19Z

OfferitDave:

{{Offerit_Manual
| show_setup_section = true
}}

== Landing Page URL Replacement Tokens ==
When tracking with Offerit, surfers will go through our tracking links:
<pre>
http://example.offerit.com/track/<ocode>/
</pre>

After doing our tracking process, we will send the surfer to the landing page URL defined in the admin for the offer and landingpage we see in the "ocode":
<pre>
http://example.com/
</pre>

Offerit Allows you to add replacement tokens to your Offer/Landing Page URL to pass some data along to the landing page. The most common example is to pass our "click_hash" to your landing page so you can use it for reporting transactions and events via postback instead of using iframe/image pixels. Example landing page URL modification to pass this data:
<pre>
http://example.com/?click_hash=%%click_hash%%
</pre>

In the example above our "click_hash" data will be passed to the landing page in a paramter called "click_hash". Please note that you can name the URL parameter anything you'd like to meet your system's needs. For examplem if your system expects this information to be sent in "clickid", you can instead make your landing page URL:
<pre>
http://example.com/?clickid=%%click_hash%%
</pre>

Below is the full list of available Replacement Tokens that can be used with your Landing Page URLs:
* ''%%click_hash%%'' - The Click hash generated by Offerit when a surfer clicks our tracking links
* ''%%click_hash_nodot%%'' - The Click hash generated by Offerit when a surfer clicks our tracking links with all dots/periods (".") removed
* ''%%offer_id%%'' - The Offer ID
* ''%%aff_id%%'' - The Affiliate ID
* ''%%aff_username%%'' - The Affiliate Username
* ''%%aff_campaign%%'' - The Affiliate Campaign ID
* ''%%aff_subid%%'' - The Affiliate Campaign Name
* ''%%country_code%%'' - The 2-letter ISO Country code for the surfer
* ''%%ip%%'' - The surfer's IP address in IPv4 format
* ''%%ip_long%%'' - The surfer's IP address converted from IPv4 to a long integer using PHP's "ip2long" function
* ''%%aff_phone%% (phone offers only)'' - The Phone Number for the affiliate phone offer

== Affiliate Custom Pixel Replacement Variables ==
=== Standard Replacement Variables ===
Affiliates have the option to add custom pixels or postbacks to inform their systems of sales when they are reported to Offerit. To set these up, use the "My Account" tab in the top navigation while logged in or overridden as them, then click the "Custom Offer Pixels" sub section in the left side navigation:

[[File:CustomOfferPixels.png|800px]]

The following is a list of possible replacement variables that can be used to send information from Offerit to your Affiliate's custom pixel or postback URL.
* ''%%aff_id%%'' - Your affiliate ID.
* ''%%offer_id%%'' - The ID of the offer.
* ''%%aff_campaign%%'' - The ID of the campaign/subid used.
* ''%%aff_subid%%'' - The name of the campaign/subid used.
* ''%%ref_url%%'' - The Referring URL for the event being reported
* ''%%transaction_hash%%'' - The transaction ID of the conversion.
* ''%%commission%%'' - The commission related to the conversion.
* ''%%decimal_commission%%'' - The commission related to the conversion in decimal format.
* ''%%aff_approved%%'' - Your auto-pending status.
* ''%%orderid%%'' - The transaction identifier from the advertiser.
* ''%%country_code%%'' - The 2-letter ISO Country code for the surfer
* ''%%cust_custom1%%''- Customer Custom1 Field
* ''%%cust_custom2%%''- Customer Custom2 Field
* ''%%cust_custom3%%''- Customer Custom3 Field
* ''%%cust_custom4%%''- Customer Custom4 Field
* ''%%cust_custom5%%''- Customer Custom5 Field
* ''%%cust_username%%'' - Customer Username
* ''%%cust_email%%'' - Customer Email
* ''%%cust_name%%'' - Customer First and Last Name
* ''%%cust_ip%%'' - The customer record's IP address in IPv4 format
* ''%%cust_ip_long%%'' - The customer record's IP address converted from IPv4 to a long integer using PHP's "ip2long" function
* ''%%subaff%%'' - Subaff Field
* ''%%subaff2%%'' - Subaff2 Field
* ''%%subaff3%%'' - Subaff3 Field
* ''%%subaff4%%'' - Subaff4 Field
* ''%%subaff5%%'' - Subaff5 Field
* ''%%device_type_name%%'' - Device type name
* ''%%device_brand_name%%'' - Device brand name
* ''%%device_browser_name%%'' - Device browser name
* ''%%device_carrier_name%%'' - Device carrier name
* ''%%device_model_name%%'' - Device model name
* ''%%device_os_name%%'' - Device OS name
* ''%%device_os_version_name%%'' - Device OS version
* ''%%_ocid%%'' - The affiliate's external click ID. To use this on postbacks, they must add "&_ocid=<external_clickid>" to their tracking links where <external_clickid> gets replaced with their own click ID.

=== Network Revenue Replacements ===
If you need to send your affiliates the amount your network made on an event in addition to the amount they are being paid, we have a configuration that can be enabled to make this data available for their use. In the Configuration Admin, click the "Affiliates" section in the left side navigation. On this page, scroll down to the "Postbacks" sub section and find "Include Network Revenue on Affiliate Postbacks". This will allow your affiliates to use either of the following replacement variables in their custom pixels/postbacks:
* ''%%network_revenue%%'' - The transaction amount for the event.
* ''%%decimal_network_revenue%%'' - The transaction amount for the event in decimal format.

=== Custom Replacement Variables ===
Offerit allows affiliates to pass custom parameters through their tracking links to your landing pages. For convenience, we make the data passed through available to them for their Custom Pixels and Postbacks as described here:
http://wiki.offerit.com/index.php/Affiliate_Custom_Pixels#Custom_Conversion_Variables. These parameters are also available for replacement in your landing page urls.

=== Special Replacement Syntax ===
Offerit supports several special modifiers that you can include in your replacements.
* ''|default:'' - Allows you to specify the value to return if the requested replacment variable is empty. Without setting this, an empty variable will be replaced with the name of the replacement variable.
** ''email=%%cust_email%%'' will return ''email=cust_email'' if there isn't one.
** ''email=%%cust_email|default:none'' will return ''email=none'' if there isn't one

* ''if|replacement=match:output'' - Allows you to display customized output for matching conditions
** ''device=%%device_type_name%% will return ''device=Desktop''
** ''device=%%if|device_type_name=Desktop:1'' will return ''device=1''

* ''|transform:'' - Allows you to either md5 or base64 encode the data after replacing it.
** 'publisher=%%aff_username%%'' will return ''publisher=somepub123'' if somepub123 is the username of the affiliate.
** 'publisher=%%aff_username|transform:md5%%'' will return ''publisher=155E3C2B7D2E5950C7E5AA70FA71B577'' if somepub123 is the username of the affiliate.
** 'publisher=%%aff_username|transform:base64%%'' will return ''publisher=c29tZXB1YjEyMw=='' if somepub123 is the username of the affiliate.

Template:Offerit Manual

2018-08-31T18:58:05Z

OfferitDave:

{| class="offeritnavbox"
! <span class="productname">[[Offerit|Offerit]]</span>
{| class="collapsible {{{show_for_affiliates_section|collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="collapsible {{{show_affiliate_area_section|collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="collapsible {{{show_setup_section|collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|-
| [[Offerit Postback Examples]]
|-
| [[Replacement Variables]]
|}
<hr />
{| class="collapsible {{{show_admin_overview_section|collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="collapsible {{{show_reporting_admin_section|collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="collapsible {{{show_report_breakdowns_section|collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="collapsible {{{show_offers_admin_section|collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|-
| [[Offer Post URLs]]
|-
| [[Offer Goals]]
|}
{| class="collapsible {{{show_affiliates_admin_section|collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="collapsible {{{show_advertisers_admin_section|collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="collapsible {{{show_customers_admin_section|collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="collapsible {{{show_payments_admin_section|collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="collapsible {{{show_payment_methods_section|collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="collapsible {{{show_creatives_admin_section|collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="collapsible {{{show_creative_types_section|collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="collapsible {{{show_communications_admin_section|collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]

|}
{| class="collapsible {{{show_configuration_admin_section|collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="collapsible {{{show_rest_api_section|collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
! class="i1" | Advertiser
|-
| [[Offerit REST API Edit Advertiser |PATCH /advertiser/edit_advertiser]]
|-
| [[Offerit REST API Add Advertiser |POST /advertiser/add_advertiser]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Get Links |GET /affiliate/get_links]]
|-
| [[Offerit REST API Get Single Link |GET /affiliate/get_single_link]]
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Decode Trackingcode|GET /affiliate/decode_trackingcode]]
|-
| [[Offerit REST API Edit Affiliate |PATCH /affiliate/edit_affiliate]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/payvia]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/add_affiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|-
! class="i1" | Creative
|-
| [[Offerit REST API Get Creatives |GET /creative/get_creatives]]
|-
| [[Offerit REST API Get Creatives Fields|GET /creative/get_creative_fields]]
|-
| [[Offerit REST API Get Creatives Rules|GET /creative/get_creative_rules]]
|-
| [[Offerit REST API Delete Creative|PATCH /creative/delete_creative]]
|-
| [[Offerit REST API Edit Creative|PATCH /creative/edit_creative]]
|-
| [[Offerit REST API Edit Creative Rules|PATCH /creative/edit_creative_rules]]
|-
| [[Offerit REST API Undelete Creative|PATCH /creative/undelete_creative]]
|-
| [[Offerit REST API Add Creative|POST /creative/add_creative]]
|-
| [[Offerit REST API Add Creative Rule|POST /creative/add_creative_rule]]
|-
| [[Offerit REST API Delete Creative Rules|POST /creative/delete_creative_rules]]
|-
! class="i1" | Customer
|-
| [[Offerit REST API Set Customer Details|PATCH /customer/set_customer_details]]
|-
| [[Offerit REST API Lock Customer|PATCH /customer/lock]]
|-
| [[Offerit REST API Unlock Customer|PATCH /customer/unlock]]
|-
| [[Offerit REST API Forget Customer|PATCH /customer/forget]]
|-
| [[Offerit REST API Export Customer|GET /customer/export]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
| [[Offerit REST API Get Commission Changes|GET /offer/get_commission_changes]]
|-
| [[Offerit REST API Activate Offer|PATCH /offer/activate_offer]]
|-
| [[Offerit REST API Edit Landing Page |PATCH /offer/edit_landing_page]]
|-
| [[Offerit REST API Edit Offer |PATCH /offer/edit_offer]]
|-
| [[Offerit REST API Pause Offer|PATCH /offer/pause_offer]]
|-
| [[Offerit REST API Set Commission Change Payouts|PATCH /offer/set_commission_change_payouts]]
|-
| [[Offerit REST API Set Enabled Affiliates |PATCH /offer/set_enabled_affiliates]]
|-
| [[Offerit REST API Set Offer Categories|PATCH /offer/set_offer_categories]]
|-
| [[Offerit REST API Set Offer Countries|PATCH /offer/set_offer_countries]]
|-
| [[Offerit REST API Set Offer Goals |PATCH /offer/set_offer_goals]]
|-
| [[Offerit REST API Set Offer Groups |PATCH /offer/set_offer_groups]]
|-
| [[Offerit REST API Set Offer Marketing Types|PATCH /offer/set_offer_marketing_types]]
|-
| [[Offerit REST API Store Offer Ips|PATCH /offer/store_offer_ips]]
|-
| [[Offerit REST API Add Commission Change |POST /offer/add_commission_change]]
|-
| [[Offerit REST API Add Landing Page |POST /offer/add_landing_page]]
|-
| [[Offerit REST API Add Offer |POST /offer/add_offer]]
|-
| [[Offerit REST API Add Tracking Domain |POST /offer/add_tracking_domain]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Transaction Update Revenue By Orderid |PATCH /transaction/transaction_update_revenue_by_orderid]]
|-
| [[Offerit REST API Transaction Update Revenue By Transaction Hash |PATCH /transaction/transaction_update_revenue_by_transaction_hash]]
|-
| [[Offerit REST API Process Void |POST /transaction/process_void]]
|-
| [[Offerit REST API Process Chargeback |POST /transaction/process_chargeback]]
|-
| [[Offerit REST API Process Reversal |POST /transaction/process_reversal]]
|-
| [[Offerit REST API Approve Pending Transaction |POST /transaction/approve_pending_transaction]]
|-
| [[Offerit REST API Click Detail |GET /transaction/click_detail]]
|}
{| class="collapsible {{{show_api_admin_section|collapsed}}}" width="100%"
! class="i1" | SOAP API (*deprecated*)
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="collapsible {{{show_misc_section|collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-
| [[Rewards Admin|Rewards Admin]]
|-
| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Offerit REST API Click Detail

2018-08-31T18:46:45Z

OfferitDave: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /transaction/click_detail''' == '''Description''' *The api/transaction/click_detail action is a feature in Offer..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /transaction/click_detail''' ==
'''Description'''
*The api/transaction/click_detail action is a feature in Offerit that allows you to retrieve details able a recent click based on the click_hash

'''Resource URL'''
*<nowiki>http://domain/api/transaction/click_detail</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
'''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

'''You need to pass either transaction_hash or subscription_id or orderid for customer lookup otherwise the call will fail'''

*transaction_hash is used to pass in the click_hash of the click you are looking up, or the transaction_hash of an already converted transaction.
**'''''type: string'''''
**'''required'''

== '''Example Request''' ==

'''GET'''

<nowiki>http://domain/api/transaction/click_detail</nowiki>

*Response:
<pre>
true
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'transaction_hash' => '35b71a300115be9.16738986',
);

$url = 'http://domain/api/transaction/click_detail';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

'''Python'''
*This example requires pip and the request library which can be installed via pip by: 'pip install requests'
<pre>
import requests
import json

url = 'http://domain/api/transaction/click_detail'

payload = {
'transaction_hash': '35b71a300115be9.16738986',
}

headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}

res = requests.GET(url, data=payload, headers=headers)
print res.json()

</pre>

'''node.js'''
*This example requires npm and the request module which can be installed via npm by: 'npm install request'
<pre>
var request = require('request');

data = {
'transaction_hash': '35b71a300115be9.16738986',
}

var options = {
url: 'http://domain/api/transaction/click_detail',
method: 'GET',
form: data,
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}
};

function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}

}

request(options, callback);

</pre>

'''Curl'''
<pre>
curl -X GET 'http://domain/api/transaction/click_detail' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded" -d 'transaction_hash=35b71a300115be9.16738986'
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Forget Customer

2018-08-31T18:46:15Z

OfferitDave: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /customer/forget''' == '''Description''' *The api/customer/forget action is a feature in Offerit that allows y..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''PATCH /customer/forget''' ==
'''Description'''
*The api/customer/forget action is a feature in Offerit that allows you to forget identifying details of a customer

'''Resource URL'''
*<nowiki>http://domain/api/customer/forget</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
'''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

'''You need to pass either customer_id or subscription_id or orderid for customer lookup otherwise the call will fail'''

*customer_id is used to pass in the customer_id of the customer to modify
**'''''type: string'''''
**'''optional'''
*subscription_id is used to pass in the subscription of the customer to modify
**'''''type: string'''''
**'''optional'''
*orderid is used to pass in the event id of one of the transactions associated with the customer to modify
**'''''type: string'''''
**'''optional'''
*keep - Comma separated list of fields to preserve
**'''''type: string'''''
**'''optional'''
**'''''possible field names:'''''
***username
***email
***token_hash
***original_username
***password
***cryptpass
***session
***firstname
***lastname
***address1
***address2
***city
***state
***zip
***country
***shipping_firstname
***shipping_lastname
***shipping_address1
***shipping_address2
***shipping_zip
***shipping_city
***shipping_state
***shipping_country
***phone
**'''''possible table names:'''''
***member_auth
***member_note

== '''Example Request''' ==

'''PATCH'''

<nowiki>http://domain/api/customer/forget</nowiki>

*Response:
<pre>
true
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'customer_id' => 191,
);

$url = 'http://domain/api/customer/forget';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

'''Python'''
*This example requires pip and the request library which can be installed via pip by: 'pip install requests'
<pre>
import requests
import json

url = 'http://domain/api/customer/forget'

payload = {
'customer_id': 191,
}

headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}

res = requests.patch(url, data=payload, headers=headers)
print res.json()

</pre>

'''node.js'''
*This example requires npm and the request module which can be installed via npm by: 'npm install request'
<pre>
var request = require('request');

data = {
'customer_id': 191,
}

var options = {
url: 'http://domain/api/customer/forget',
method: 'PATCH',
form: data,
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}
};

function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}

}

request(options, callback);

</pre>

'''Curl'''
<pre>
curl -X PATCH 'http://domain/api/customer/forget' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded" -d 'customer_id=191'
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Export Customer

2018-08-31T18:45:53Z

OfferitDave: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /customer/export''' == '''Description''' *The api/customer/export action is a feature in Offerit that allows you..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /customer/export''' ==
'''Description'''
*The api/customer/export action is a feature in Offerit that allows you to export customer information

'''Resource URL'''
*<nowiki>http://domain/api/customer/export</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
'''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

'''You need to pass either customer_id or subscription_id or orderid for customer lookup otherwise the call will fail'''

*customer_id is used to pass in the customer_id of the customer to return
**'''''type: string'''''
**'''optional'''
*subscription_id is used to pass in the subscription of the customer to return
**'''''type: string'''''
**'''optional'''
*orderid is used to pass in the event id of one of the transactions associated with the customer to return
**'''''type: string'''''
**'''optional'''

== '''Example Request''' ==

'''GET'''

<nowiki>http://domain/api/customer/export</nowiki>

*Response:
<pre>
true
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'customer_id' => 191,
);

$url = 'http://domain/api/customer/export';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

'''Python'''
*This example requires pip and the request library which can be installed via pip by: 'pip install requests'
<pre>
import requests
import json

url = 'http://domain/api/customer/export'

payload = {
'customer_id': 191,
}

headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}

res = requests.GET(url, data=payload, headers=headers)
print res.json()

</pre>

'''node.js'''
*This example requires npm and the request module which can be installed via npm by: 'npm install request'
<pre>
var request = require('request');

data = {
'customer_id': 191,
}

var options = {
url: 'http://domain/api/customer/export',
method: 'GET',
form: data,
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}
};

function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}

}

request(options, callback);

</pre>

'''Curl'''
<pre>
curl -X GET 'http://domain/api/customer/export' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded" -d 'customer_id=191'
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Unlock Customer

2018-08-31T18:45:26Z

OfferitDave: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /customer/unlock''' == '''Description''' *The api/customer/unlock action is a feature in Offerit that allows y..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''PATCH /customer/unlock''' ==
'''Description'''
*The api/customer/unlock action is a feature in Offerit that allows you to unlock a locked customer so it can be edited by Offerit

'''Resource URL'''
*<nowiki>http://domain/api/customer/unlock</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
'''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

'''You need to pass either customer_id or subscription_id or orderid for customer lookup otherwise the call will fail'''

*customer_id is used to pass in the customer_id of the customer to modify
**'''''type: string'''''
**'''optional'''
*subscription_id is used to pass in the subscription of the customer to modify
**'''''type: string'''''
**'''optional'''
*orderid is used to pass in the event id of one of the transactions associated with the customer to modify
**'''''type: string'''''
**'''optional'''

== '''Example Request''' ==

'''PATCH'''

<nowiki>http://domain/api/customer/unlock</nowiki>

*Response:
<pre>
true
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'customer_id' => 191,
);

$url = 'http://domain/api/customer/unlock';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

'''Python'''
*This example requires pip and the request library which can be installed via pip by: 'pip install requests'
<pre>
import requests
import json

url = 'http://domain/api/customer/unlock'

payload = {
'customer_id': 191,
}

headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}

res = requests.patch(url, data=payload, headers=headers)
print res.json()

</pre>

'''node.js'''
*This example requires npm and the request module which can be installed via npm by: 'npm install request'
<pre>
var request = require('request');

data = {
'customer_id': 191,
}

var options = {
url: 'http://domain/api/customer/unlock',
method: 'PATCH',
form: data,
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}
};

function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}

}

request(options, callback);

</pre>

'''Curl'''
<pre>
curl -X PATCH 'http://domain/api/customer/unlock' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded" -d 'customer_id=191'
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Lock Customer

2018-08-31T18:44:57Z

OfferitDave: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''PATCH /customer/lock''' == '''Description''' *The api/customer/lock action is a feature in Offerit that allows you t..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''PATCH /customer/lock''' ==
'''Description'''
*The api/customer/lock action is a feature in Offerit that allows you to lock a customer so it can't be edited by Offerit. It can still be updated based on posts from the advertiser.

'''Resource URL'''
*<nowiki>http://domain/api/customer/lock</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
'''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

'''You need to pass either customer_id or subscription_id or orderid for customer lookup otherwise the call will fail'''

*customer_id is used to pass in the customer_id of the customer to modify
**'''''type: string'''''
**'''optional'''
*subscription_id is used to pass in the subscription of the customer to modify
**'''''type: string'''''
**'''optional'''
*orderid is used to pass in the event id of one of the transactions associated with the customer to modify
**'''''type: string'''''
**'''optional'''

== '''Example Request''' ==

'''PATCH'''

<nowiki>http://domain/api/customer/lock</nowiki>

*Response:
<pre>
true
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'customer_id' => 191,
);

$url = 'http://domain/api/customer/lock';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

'''Python'''
*This example requires pip and the request library which can be installed via pip by: 'pip install requests'
<pre>
import requests
import json

url = 'http://domain/api/customer/lock'

payload = {
'customer_id': 191,
}

headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}

res = requests.patch(url, data=payload, headers=headers)
print res.json()

</pre>

'''node.js'''
*This example requires npm and the request module which can be installed via npm by: 'npm install request'
<pre>
var request = require('request');

data = {
'customer_id': 191,
}

var options = {
url: 'http://domain/api/customer/lock',
method: 'PATCH',
form: data,
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}
};

function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}

}

request(options, callback);

</pre>

'''Curl'''
<pre>
curl -X PATCH 'http://domain/api/customer/lock' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded" -d 'customer_id=191'
</pre>

[[Category:Offerit API Articles]]

Affiliate Remote Login

2017-11-28T15:56:14Z

OfferitDave:

{{Offerit Manual
| show_affiliate_area_section = true
}}

You can create a custom form for affiliates to log in to your Offerit installation. All that is needed is to create a form that submits to the following url:

<pre>
http://<tracking domain>/internal.php
</pre>

You would replace <tracking domain> with the [[Ct#Tracking Domain|Tracking Domain]] of your Offerit install. The only variables that need to be sent for a successful login with the post are "user" and "pass". If the user is submitting fails to enter the correct login information they and they are posting from the tracking domain of your offerit install they will be redirected to the external login page of your offerit install. Otherwise they will receive an error response regarding why their login was unsuccessful.

Here is a basic example of what this form may look like.

<pre>

<form action="http://example.offerit.com/internal.php" method="post">
Username: <input type="text" name="user" /><br />
Password: <input type="password" name="pass" /><br />
<input type="submit" />
</form>
</pre>

<h3>Displaying your own error page</h3>
If you prefer to display your own errors, you can send a post to verify the username and password are correct before sending the user. For instance use javascript to handle the form submission and send an ajax post to a validation script like this one:
<pre>
$response = array(
'result' => 'fail'
);
if ( ! empty( $_POST['user'] ) && ! empty( $_POST['pass'] ) && check_length( $_POST['user'], 2, 255 ) && check_length( $_POST['pass'], 3, 255 ) ) {
$response_headers = get_headers( AFFILIATE_URL . '/internal.php?user=' . $_POST['user'] . '&pass=' . $_POST['pass'] . '', 1 );
if ( array_key_exists( 'Location', $response_headers ) && $response_headers[0] == 'HTTP/1.1 302 Found' ) {
$response = array(
'result' => 'success'
);
}
}
</pre>
If the post returns success, you can let the form submit like normal. If the post returns error, you can tell the surfer to try again.

<h3>Displaying Forgot Password</h3>
Similarly, you can trigger forgot password from your own page and check for your own errors by making it an ajax call instead of a direct form submission. The post script might look like this one:
<pre>
$response = array(
'result' => 'fail'
);
parse_str( $_POST['formdata'], $data );
$curl = curl_init();
curl_setopt( $curl, CURLOPT_URL, AFFILIATE_URL . '/submit.php' );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl, CURLOPT_POST, true );
curl_setopt( $curl, CURLOPT_POSTFIELDS, http_build_query( $data ) );
$response['response'] = curl_exec( $curl );
$header = curl_getinfo( $curl, CURLINFO_HTTP_CODE );
curl_close( $curl );
preg_match( '#<div class="action-details">(.+?)</div>#is', $response['response'], $found );
if ( $header === 302 ) {
$response = array(
'result' => 'success',
'message' => 'An email has been sent with your new password. ',
'header' => $header
);
}
if ( $header === 200 ) {
if ( $found ) {
$response = array(
'result' => 'error',
'message' => $found[1],
'header' => $header
);
}
}
</pre>

[[Category:Offerit Affiliate Information]]

Link Groups

2017-06-16T15:50:28Z

OfferitDave:

{{Offerit Manual
| show_for_affiliates_section = true
}}

A Link Group is a way for an affiliate to split traffic across multiple different destinations. This split can be targeted, optimized, or random. Link groups get their own tracking link and support pass through and dynamic values just the same as regular tracking links.

__TOC__

==Performance Metrics==
===Random===
Random is the simplest link group. You add links to the group and traffic is randomly distributed across all links in the group. This is not affected by percentage random or any other settings

===Optimized===
Optimized links choose the best performing link based on your specified performance criteria. You may base your optimization on epc, rate of conversion, or rate for custom event types if any exist.
*'''Stats Scope''' - Specifies if you want to consider all of your traffic, all of the traffic network wide, or just traffic to this specific group.
*'''Stats Date Range''' - Specifies the time range to include in the optimization.
*'''Hit Threshold''' - Specifies the minimum number of hits required for each of the possible landing pages before the best performing link will be used.
*'''Percent Random''' - Specifies what percentage of traffic will continue to to be distributed randomly while the rest of the traffic is optimized.

===Targeted===
Targeted links allow you to direct traffic based on date and time, country, and device type. Links get added to the individual targets just like you add them to any other link group.
*'''Hours''' - Restricts this target to only specific hours of the day
*'''Days''' - Restricts this target to only specific days of the week
*'''Authorized / Unauthorized Countries''' - Restricts this target to geoip location
*'''Device Type''' - Restricts

Targeted links can be either randomly distributed or optimized by epc.

==Adding Links==
There are three places to add links to an existing group:<br>
1) From the link groups page, paste a link, choose a group, confirm that it is correct and hit 'Add Link to Group'.<br>
2) From the edit link group page, click 'Add a New Link'. Paste in the link, confirm that it is correct and hit 'Add Link to Group'.<br>
3) From the linkcodes page for a specific offer, click 'Group'. This will bring you to th link groups page from method 1 with the link already in place.<br>

== Deep Linking ==
Individual links can have deep links hard coded into them. For example, using the following linkcode to link to <nowiki>http://example.offerit.com/landing_page1.html</nowiki>:

<pre>
http://example.offerit.com/track/MjozOjE/landing_page1.html
</pre>

Affiliates can also manipulate the query string. For example, the affiliate can pass the variable ''extra_var=1234'' to a landing page by appending a question mark and the variable assignment to their linkcode:
<pre>
http://example.offerit.com/track/MjozOjE/?extra_var=1234
</pre>

Similarly you can deep link the link group tracking link and have the details pushed through to the individual links
For Example <nowiki>http://example.offerit.com/lgtrack/Mi4z?ocid=xxx</nowiki> will go to
<pre>
http://example.offerit/com/track/yourlink?_ocid=xxx
</pre>

== Model Link Group ==
An admin can flag one link group as the 'model' to use for other affiliates without manually setting it up on each account.
Once a model has been chosen, you can continue to edit that model, and either push those changes to all affiliates using the model, or update specific affiliate accounts to check for changes. From the admin you can create the model link group on any affiliate that does not already have it. There is also a config option to create the model link group on all new affiliate accounts.
[[Category:Offerit Affiliate Information]]

Link Groups

2017-06-16T15:44:00Z

OfferitDave: /* Targeted */

Link Groups

2017-06-16T15:42:57Z

OfferitDave: /* Random */

{{Offerit Manual
| show_for_affiliates_section = true
}}

A Link Group is a way for an affiliate to split traffic across multiple different destinations. This split can be targeted, optimized, or random. Link groups get their own tracking link and support pass through and dynamic values just the same as regular tracking links.

__TOC__

==Performance Metrics==
===Random===
Random is the simplest link group. You add links to the group and traffic is randomly distributed across all links in the group. This is not affected by percentage random or any other settings

===Optimized===
Optimized links choose the best performing link based on your specified performance criteria. You may base your optimization on epc, rate of conversion, or rate for custom event types if any exist.
*'''Stats Scope''' - Specifies if you want to consider all of your traffic, all of the traffic network wide, or just traffic to this specific group.
*'''Stats Date Range''' - Specifies the time range to include in the optimization.
*'''Hit Threshold''' - Specifies the minimum number of hits required for each of the possible landing pages before the best performing link will be used.
*'''Percent Random''' - Specifies what percentage of traffic will continue to to be distributed randomly while the rest of the traffic is optimized.

===Targeted===
Targeted links allow you to direct traffic based on date and time, country, and device type. Links get added to the individual targets just like you add them to any other link group.
*'''Hours''' - Restricts this target to only specific hours of the day
*'''Days''' - Restricts this target to only specific days of the week
*'''Authorized / Unauthorized Countries''' - Restricts this target to geoip location
*'''Device Type''' - Restricts

==Adding Links==
There are three places to add links to an existing group:<br>
1) From the link groups page, paste a link, choose a group, confirm that it is correct and hit 'Add Link to Group'.<br>
2) From the edit link group page, click 'Add a New Link'. Paste in the link, confirm that it is correct and hit 'Add Link to Group'.<br>
3) From the linkcodes page for a specific offer, click 'Group'. This will bring you to th link groups page from method 1 with the link already in place.<br>

== Deep Linking ==
Individual links can have deep links hard coded into them. For example, using the following linkcode to link to <nowiki>http://example.offerit.com/landing_page1.html</nowiki>:

<pre>
http://example.offerit.com/track/MjozOjE/landing_page1.html
</pre>

Affiliates can also manipulate the query string. For example, the affiliate can pass the variable ''extra_var=1234'' to a landing page by appending a question mark and the variable assignment to their linkcode:
<pre>
http://example.offerit.com/track/MjozOjE/?extra_var=1234
</pre>

Similarly you can deep link the link group tracking link and have the details pushed through to the individual links
For Example <nowiki>http://example.offerit.com/lgtrack/Mi4z?ocid=xxx</nowiki> will go to
<pre>
http://example.offerit/com/track/yourlink?_ocid=xxx
</pre>
[[Category:Offerit Affiliate Information]]

Blocked Traffic Reasons

2017-04-13T13:43:52Z

OfferitDave: Created page with "==banned.php== The default destination for undeliverable traffic is banned.php on the same domain as the tracking link. This can be changed under the Fraud section of the conf..."

==banned.php==
The default destination for undeliverable traffic is banned.php on the same domain as the tracking link. This can be changed under the Fraud section of the configuration admin.

==Blocked Reasons==
*1: Blacklisted IP (manual) -- Check IP Blacklist Admin
*2: Blacklisted IP (automated) -- Check IP Blacklist Admin
*3: Fraud / Proxy Blocked -- Check proxy detection settings
*4: Geo IP restrition -- Check authorized countries for the offer
*5: Returning Surfer -- Check offer for either prevent cookie duplicates or prevent duplicate ip conversions
*6: Offer Unavailable -- Check start and end dates for offer and landing page
*7: Infinite Redirect -- Check for redirects that form loops
*8: Disallowed Affiliate -- Check that the affiliate is allowed in the landing page.
*9: Bad Link -- Check the affiliates link - usually means there is a & where there should be a ?
*10: Empty Link Group -- Make sure there are link items in this link group.
*11L Blacklisted Domain -- Fraud settings are blocking traffic based on the domain of the referring url.
*12: Banned subaffiliate -- The subaffiliate for this link has been blocked.

Offerit REST API Get Single Link

2017-03-23T22:14:01Z

OfferitDave: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /affiliate/get_single_link''' == '''Description''' *Gets the default affiliate tracking link for an offer. Opti..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_single_link''' ==
'''Description'''
*Gets the default affiliate tracking link for an offer. Optionally lets you specify an individual landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_single_link</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
**'''''required'''
** offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_single_link?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_single_link';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Links

2017-03-23T22:13:10Z

OfferitDave:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Links

2017-03-23T22:12:19Z

OfferitDave: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''GET /affiliate/get_links''' == '''Description''' *Gets all tracking links for an affiliate. Optionally lets you li..."

{{Offerit Manual
| show_api_admin_section = true
}}
== '''GET /affiliate/get_links''' ==
'''Description'''
*Gets all tracking links for an affiliate. Optionally lets you limit to a specific offer or landing page.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/get_links</nowiki>

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*loginid
**'''''type: int'''''
**'''''required'''
** affiliate to get link for
*offerid
**'''''type: int'''''
** Optional offer to get link for
*landing_pageid
**'''''type: int'''''
** Optional landing page to get link for. Defaults to default lander for the offer.
*style
**'''''type: string'''''
**'''''options: encoded,ids,shortnames,tiny'''''
** Optional link style. Defaults to encoded.
*subaff
**'''''type: string'''''
** Optional subaff value. Defaults to none.
*subaff2
**'''''type: string'''''
** Optional subaff2 value. Defaults to none.
*subaff3
**'''''type: string'''''
** Optional subaff3 value. Defaults to none.
*subaff4
**'''''type: string'''''
** Optional subaff4 value. Defaults to none.
*subaff5
**'''''type: string'''''
** Optional subaff5 value. Defaults to none.
*subids
**'''''type: string'''''
** Optional comma separated list of subids. Defaults to none.
*_ocid
**'''''type: string'''''
** Optional click id value. Defaults to none.
*code_only
**'''''type: Bool'''''
** Optional - returns only the code from the tracking link. Defaults to full url.

== '''Example Request''' ==

'''GET'''

<pre><nowiki>http://domain/api/affiliate/get_links?loginid=2&offerid=1&subaff=test&_ocid={token}
</nowiki></pre>

*Response:
<pre>
{
"result":"Success",
"message":[
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":425,
"Landing Page Name":"lp333",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjQyNS4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
},
{
"Offer Id":277,
"Offer Name":"01dave",
"Landing Page Id":304,
"Landing Page Name":"offerit offer",
"Code":"http:\/\/example.com\/track\/Mi4yNjguMjc3LjMwNC4wLjAuMC4wLjAuNjIuMC4w?subaff=test&_ocid={token}"
}
]
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/affiliate/get_links';
$curl = curl_init();

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);

$data = Array(
'loginid' => 2,
'offerid' => 1,
'subaff' => 'test',
'_ocid' => '{token}'
);

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Pause Offer

2017-03-22T21:50:47Z

OfferitDave: /* Example Code */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/pause_offer''' ==
'''Description'''
*Offerit supports an API resource to pause an offer and send the traffic to another offer/landing page or expiration url.

'''Resource URL'''
*<nowiki>http://domain/api/offer/pause_offer</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*offerid: the id of the offer to be paused
**'''''type: integer'''''
**required

*date_expire: date or unix timestamp to set as the expiration date. Leaving this blank will make the expiration immediate
**'''''type: string'''''

*expiration_landing_page_id: the id of the landing page you want the traffic redirected to
**'''''type: integer'''''

*expire_url: the expiration url you want traffic redirected to (expiration_landing_page_id takes precedence over this if both are sent)
**'''''type: string'''''

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'offerid' => 4,
'date_expire' => '2017/03/20',
'expiration_landing_page_id' => 17
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/pause_offer?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

Offerit REST API Activate Offer

2017-03-22T21:50:14Z

OfferitDave: /* Example Code */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/activate_offer''' ==
'''Description'''
*Offerit supports an API resource to activate a paused/expired offer and allow traffic to the landing page url.

'''Resource URL'''
*<nowiki>http://domain/api/offer/activate_offer</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
*offerid: the id of the offer to be activated
**'''''type: integer'''''
**required

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'offerid' => 4,
);

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/activate_offer?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

Template:Offerit Manual

2017-03-22T01:06:58Z

OfferitDave:

{| class="offeritnavbox"
! <span class="productname">[[Offerit|Offerit]]</span>
{| class="collapsible {{{show_for_affiliates_section|collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Link Groups|Link Groups]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="collapsible {{{show_affiliate_area_section|collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="collapsible {{{show_setup_section|collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|}
<hr />
{| class="collapsible {{{show_admin_overview_section|collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="collapsible {{{show_reporting_admin_section|collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="collapsible {{{show_report_breakdowns_section|collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="collapsible {{{show_offers_admin_section|collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|}
{| class="collapsible {{{show_affiliates_admin_section|collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="collapsible {{{show_advertisers_admin_section|collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="collapsible {{{show_customers_admin_section|collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="collapsible {{{show_payments_admin_section|collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="collapsible {{{show_payment_methods_section|collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="collapsible {{{show_creatives_admin_section|collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="collapsible {{{show_creative_types_section|collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="collapsible {{{show_communications_admin_section|collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]
|}
{| class="collapsible {{{show_configuration_admin_section|collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="collapsible {{{show_api_admin_section|collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
! class="i1" | Offer
|-
| [[Offerit REST API Check Orderid Exists|GET /offer/check_orderid_exists]]
|-
! class="i1" | Reporting
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
! class="i1" | Transaction
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
! class="i1" | Affiliate
|-
| [[Offerit REST API Search_Affiliate|GET /affiliate/search]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/setpayviainfo]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/addaffiliate]]
|-
| [[Offerit REST API Affiliate Login Ips|POST /affiliate/affiliate_login_ips]]
|}
{| class="collapsible {{{show_api_admin_section|collapsed}}}" width="100%"
! class="i1" | API
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="collapsible {{{show_misc_section|collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-
| [[Rewards Admin|Rewards Admin]]
|-
| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Link Groups

2017-03-22T01:05:07Z

OfferitDave: Created page with "{{Offerit Manual | show_for_affiliates_section = true }} A Link Group is a way for an affiliate to split traffic across multiple different destinations. This split can be ta..."

{{Offerit Manual
| show_for_affiliates_section = true
}}

A Link Group is a way for an affiliate to split traffic across multiple different destinations. This split can be targeted, optimized, or random. Link groups get their own tracking link and support pass through and dynamic values just the same as regular tracking links.

__TOC__

==Performance Metrics==
===Random===
Random is the simplest link group. You add links to the group and traffic is randomly distributed.

===Optimized===
Optimized links choose the best performing link based on your specified performance criteria. You may base your optimization on epc, rate of conversion, or rate for custom event types if any exist.
*'''Stats Scope''' - Specifies if you want to consider all of your traffic, all of the traffic network wide, or just traffic to this specific group.
*'''Stats Date Rang''' - Specifies the time range to include in the optimization.
*'''Hit Threshold''' - Specifies the minimum number of hits required for each of the possible landing pages before the best performing link will be used.
*'''Percent Random''' - Specifies what percentage of traffic will continue to to be distributed randomly while the rest of the traffic is optimized.

===Targeted===
Targeted links allow you to direct traffic based on date and time, country, and device type. Links get added to the individual targets just like you add them to any other link group.
*'''Hours''' - Restricts this target to only specific hours of the day
*'''Days''' - Restricts this target to only specific days of the week
*'''Authorized / Unauthorized Countries''' - Restricts this target to geoip location
*'''Device Type''' - Restricts

==Adding Links==
There are three places to add links to an existing group.
1) From the link groups page, paste a link, choose a group, confirm that it is correct and hit 'Add Link to Group'.
2) From the edit link group page, click 'Add a New Link'. Paste in the link, confirm that it is correct and hit 'Add Link to Group'.
3) From the linkcodes page for a specific offer, click 'Group'. This will bring you to th link groups page from method 1 with the link already in place.

== Deep Linking ==
Individual links can have deep links hard coded into them. For example, using the following linkcode to link to <nowiki>http://example.offerit.com/landing_page1.html</nowiki>:

<pre>
http://example.offerit.com/track/MjozOjE/landing_page1.html
</pre>

Affiliates can also manipulate the query string. For example, the affiliate can pass the variable ''extra_var=1234'' to a landing page by appending a question mark and the variable assignment to their linkcode:
<pre>
http://example.offerit.com/track/MjozOjE/?extra_var=1234
</pre>

Similarly you can deep link the link group tracking link and have the details pushed through to the individual links
For Example <nowiki>http://example.offerit.com/lgtrack/Mi4z?ocid=xxx</nowiki> will go to
<pre>
http://example.offerit/com/track/yourlink?_ocid=xxx
</pre>
[[Category:Offerit Affiliate Information]]

Offerit REST API Get Transaction Report

2016-11-21T15:41:04Z

OfferitDave: /* GET /report/transaction */

{{Offerit Manual
| show_api_admin_section = true
}}

== '''GET /report/transaction''' ==
'''Description'''
*Offerit supports an API resource to grab all the stats used within the NATS transactions report.

'''Resource URL'''
*<nowiki>http://domain/api//report/transaction</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

** '''period''' - Which period of time to select data for. See below for more information regarding the periods within NATS.
** '''start''' - start date for the stats. Used when period is not sent or set to 8
** '''end''' - end date for the stats. Used when period is not sent or set to 8
** '''filter_affiliate''' - Only see stats for specific affiliate
** '''filter_loginid''' - Only see stats for the specifc login ID passed in.
** '''filter_campaignid''' - Only see stats for the specific campaign ID for the affiliate. (Can only be used if filter_loginid is passed in)
** '''filter_offerid''' - Only see stats for the specific site ID passed in.
** '''filter_landingpageid''' - Only see stats for the specific tour ID passed in.
** '''filter_adtoolid''' - Only see stats for the specific adtool ID passed in.
** '''filter_programid''' - Only see stats for the specific program ID passed in.
** '''filter_countryid''' - Only see stats for the specific Country ID passed in.
** '''no_inhouse''' - 0 for all affiliates, 1 to exclude inhouse.
** '''trans_type''' - Type of transactions to return. Default is all.
** '''filter_external_clickid''' - search for a specific affiliate _ocid.
** '''filter_transaction_hash''' - search for an internal click_hash.
** '''trans_start''' - Number of transactions to offset default 0.
** '''trans_count''' - Number of transactions to return default 100.

== Periods ==
{| class="tmplfunc" border="1"
|-
! # || Name || Argument Description
|-
| 0 || current || Current Period
|-
| 1 || last || Last Period
|-
| 2 || today || Today
|-
| 3 || yesterday || Yesterday
|-
| 4 || week || This Week
|-
| 5 || month || This Month
|-
| 6 || year || This Year
|-
| 7 || all || All Time
|-
| 8 || free || Freeform (See also the ''start'' and ''end'' parameters above)
|}

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'period' => 2,
'
);

$data_string = http_build_query($data);
$url = 'http://domain/api/report/transaction?'.$data_string;

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

</pre>

[[Category:Offerit API Articles]]

Offerit REST API Set Affiliate Payvia Info

2016-11-09T19:06:09Z

OfferitDave:

{{Offerit Manual
| show_api_admin_section = true
}}
== '''PATCH /affiliate/payvia''' ==
'''Description'''
*The /affiliate/payvia action is a feature in [[Offerit]] that allows you to set the affiliate payvia info settings

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/payvia</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*loginid: is the affiliates loginid
**'''''type: string'''''
**required

*payvia_type_id: is the id of the payvia that the loginid should be switched to
**'''''type: string'''''
**required

*payvia_info: is an array containing arrays of info to update for the payvia type.
**'''''type: array'''''
**required

== '''Example Request''' ==

'''PATCH'''

<nowiki>http://domain/api/affiliate/payvia</nowiki>

*Response:
<pre>
[
{
"field":"Payvia Type",
"result":"Updated Payvia Type to 1 for loginid 1"
},
{
"field":"Pay To",
"result":"Updated Payvia Info: 'Pay To' is now 'TestPayTo'"
},
{
"field":"Address",
"result":"Updated Payvia Info: 'Address' is now 'Riga, Latvia'"
}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$payvia_info = array();
$payvia_info[] = array(
'field' => 'Pay To',
'value' => 'TestPayTo'
);
$payvia_info[] = array(
'field' => 'Address',
'value' => 'Riga, Latvia'
);

$data = array(
'loginid' => 1,
'payvia_type_id' => '1',
'payvia_info' => $payvia_info
);

$url = 'http://domain/api/affiliate/payvia';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

LinkGroups

2016-03-21T15:04:59Z

OfferitDave: Created page with "{{Offerit Manual | show_for_affiliates_section = true } Link groups allow affiliates to use the same tracking link to split traffic between several possible destinations. Gr..."

{{Offerit Manual
| show_for_affiliates_section = true
}

Link groups allow affiliates to use the same tracking link to split traffic between several possible destinations. Groups can be either random or self optimizing.

__TOC__

== Creating Link Groups ==
Link groups are managed on the /internal.php?page=link_groups page. To create a new link group, click the Create New Group link. You can also use the pencil icon to edit existing groups.
[[File:Link_group_1.PNG|frame|800px|center||||Figure 1.1 - Create or Edit Link Group]]

==Link Group Details==
When details of a link group, you can see the optimization settings and the link url, add new links to the group, or modify the group settings.
[[File:Link_group_2.PNG|frame|800px|center||||Figure 1.2 - Modify Link Group Details]]

*Link Group Name: is just for your reference purposes.
*Group Linkcode: determined automatically by the system. This link will always redirect to one of the linkcodes you added to the group.
*Performance Metric: Random, EPC, or Conversion Rate.
*Stats Scope: Should the group optimize according to the best performance across the entire network, your whole account, or just this specific group.
*Stats Date Range: How many days worth of stats are included for optimization.
*Hit Threshold: Defines the data collection period. The Group will always be treated as random until at least this many hits have been registered at each linkcode in the group.
*Percent Random: During the optimization period, this % of traffic will still be treated as random.

==Adding Links to Link Groups==
[[File:Link_group_3.PNG|frame|800px|center||||Figure 1.3 - Adding Links from Group Details Page]]
On the link group details page, there is a link to Add a New Link. You can paste in any valid link to add it to this group.

[[File:Link_group_4.PNG|frame|800px|center||||Figure 1.4 - Adding Links from Main Link Groups Page]]
You can also add links to any group from the main link groups page. Simply put in the linkcode you wish to add and choose from your list of available groups.
A preview will display to help ensure that you know exactly where the link you are adding will go.

==Using Link Groups==
Because you can use any valid tracking link into your groups, you can save subaff and other pass through fields into the links as you add them into your group.
Fiels passed into the Group Linkcode will also persist to the linkcode that is used for each click. This means that you can pass your _ocid and subaff into the Group Linkcode dynamically just as if you were using the direct links.

File:Link group 2.PNG

2016-03-21T14:49:38Z

OfferitDave: OfferitDave uploaded a new version of "File:Link group 2.PNG"

File:Link group 4.PNG

2016-03-21T14:42:05Z

OfferitDave:

File:Link group 3.PNG

2016-03-21T14:41:49Z

OfferitDave:

File:Link group 2.PNG

2016-03-21T14:41:36Z

OfferitDave:

File:Link group 1.PNG

2016-03-21T14:41:01Z

OfferitDave:

Template:Offerit Manual

2016-01-13T16:03:09Z

OfferitDave:

{| class="offeritnavbox"
! <span class="productname">[[Offerit|Offerit]]</span>
{| class="collapsible {{{show_for_affiliates_section|collapsed}}}" width="100%"
! class="i1" | For Affiliates
|-
| [[Automatic SubIDs]]
|-
| [[Affiliate Stats Dumps|Affiliate Stats Dumps]]
|-
| [[Linkcode|Linkcode]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Host and Post]]

|}
{| class="collapsible {{{show_affiliate_area_section|collapsed}}}" width="100%"
! class="i1" | Offerit Affiliate Area
|-

| [[Affiliate Account Details]]
|-
| [[Affiliate Account Change Log]]
|-
| [[Offerit Affiliate Creatives|Affiliate Creatives]]
|-
| [[Affiliate Creatives Search]]
|-
| [[Affiliate Settings]]
|-
| [[Affiliate Custom Pixels]]
|-
| [[Affiliate Linkcodes]]
|-
| [[Affiliate Linkcode Settings]]
|-
| [[Affiliate Login History]]
|-
| [[Affiliate Messages]]
|-
| [[Affiliate Dashboard]]
|-
| [[Affiliate Dashboard Key Statistics|Dashboard Key Statistics]]
|-
| [[Affiliate Dashboard Statistics Summary|Dashboard Statistics Summary]]
|-
| [[Affiliate Payment History]]
|-
| [[Quick Links]]
|-
| [[Affiliate Referrals Report]]
|-
| [[Affiliate Referring URL Report]]
|-
| [[Affiliate Remote Login]]
|-
| [[Affiliate Signup]]
|-
| [[Affiliate Statistic Filters]]
|-
| [[Affiliate Statistic Views]]
|-
| [[Affiliate SubIDs]]



|}
{| class="collapsible {{{show_setup_section|collapsed}}}" width="100%"
! class="i1" | Offerit Setup

|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[Tracking Domain]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]
|-
| [[Getting Started Admin]]
|-
| [[Offerit Quick-Start Guide]]
|-
| [[Tracking in Offerit]]
|-
| [[Pixel Builder]]
|}
<hr />
{| class="collapsible {{{show_admin_overview_section|collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="collapsible {{{show_reporting_admin_section|collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="collapsible {{{show_report_breakdowns_section|collapsed}}}" width="100%"
! class="i1" |   Report Breakdowns
|-
| [[Profit and Loss Report|Profit and Loss Report]]
|-
| [[Subscription Report|Subscription Report]]
|-
| [[Transactions Report|Transactions Reports]]

|-
| [[Affiliate Ratios Report|Affiliate Ratios Report]]
|-
| [[Affiliate Managers Report]]
|-
| [[Surfer Actions Report|Visitor Actions Report]]
|-
| [[Affiliate Referral Tier Commissions Report|Referral Tier Payouts Report]]
|-
| [[Affiliate Referral Signup Commissions Report|Referral Signup Payouts Report]]
|-
| [[Additional Commissions Report|Additional Commissions Report]]
|-
| [[Graphical Affiliate Comparison Report|Graphical Affiliate Comparison Report]]
|-
| [[Single Day Comparison Report|The Single Day Comparison Report]]
|-
| [[Actual Affiliate Payments|Actual Affiliate Payments Report]]

|}
{| class="collapsible {{{show_offers_admin_section|collapsed}}}" width="100%"
! class="i1" | Offers Admin
|-
| [[Offers Admin|The Offers Admin]]
|-
| [[Offers|Offers]]
|-
| [[Offer Setup]]
|-
| [[Affiliate Referrals]]
|-
| [[Tracking Domain]]
|-
| [[Offerit Commission|Commissions]]
|-
| [[Commission Changes]]
|-
| [[Suppression Lists]]
|-
| [[Pixel Builder]]

|-
| [[ID Numbers]]
|-
| [[Offer Partner]]

|-
| [[Offer/Landing Page Redirection]]
|-
| [[Offerit Rules|Setting Rules]]
|-
| [[Admin Host and Post]]
|}
{| class="collapsible {{{show_affiliates_admin_section|collapsed}}}" width="100%"
! class="i1" | Affiliates Admin
|-
| [[Affiliates Admin|The Affiliates Admin]]
|-
| [[ID Numbers]]
|-
| [[Affiliate Managers]]
|-
| [[Affiliate Referrals]]
|-
| [[Offerit Affiliate Activation|Affiliate Activation]]
|-
| [[Admin-Only Settings]]
|-
| [[Offerit Affiliate Override|Affiliate Overrides]]
|-
| [[Offerit Creating Admin Accounts|Creating Admin Accounts]]
|-
| [[In House Accounts|In-House Accounts]]
|-
| [[Add Manual Sale]]
|-
| [[Offerit Manual Invoice|Manual Invoice]]
|-
| [[Offerit Affiliate Documents|Affiliate Documents]]
|-
| [[Affiliate Enabled Offers]]
|-
| [[Change Affiliate Status]]
|-
| [[Account Changes]]
|-
|}
{| class="collapsible {{{show_advertisers_admin_section|collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="collapsible {{{show_customers_admin_section|collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="collapsible {{{show_payments_admin_section|collapsed}}}" width="100%"
! class="i1" |Payments Admin
|-
| [[Payments Admin|The Payments Admin]]
|-
| [[Payvia Types]]
|-
| [[Payout Periods]]
|-
| [[Payvia Dump Formats]]
|-
| [[Payment Dump Entry Numbers |Payment Dump Entry Numbers]]
|-
| [[Offerit Payment Dump Variables|Payment Dump Variables]]
|-
| [[Offerit Check Functions|Check Functions]]
|-
| [[Offerit Rules|Setting Rules]]
|}
{| class="collapsible {{{show_payment_methods_section|collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="collapsible {{{show_creatives_admin_section|collapsed}}}" width="100%"
! class="i1" | Creatives Admin
|-
| [[Creatives Admin|The Creatives Admin]]

|-
| [[Offerit Add New Creatives|Add New Creatives]]
|-
| [[Offerit Add New Creative Type|Add New Creative Type]]
|-
| [[Offeritcode]]

|-
| [[Code Builder]]
|-
| [[Track and Strack]]
|-
| [[Offerit Rules|Setting Rules]]
|-
|}
{| class="collapsible {{{show_creative_types_section|collapsed}}}" width="100%"
! class="i1" |   Default Creative Types
|-
| [[Creative Types]]
|-
| [[Offerit Image Banners|Image Banners]]
|-
| [[Offerit Flash Banners|Flash Banners]]
|-
| [[Offerit Dynamic Text Banners|Dynamic Text Banners]]
|-
| [[Offerit Feeds|Feeds]]
|-
| [[Offerit Mailers|Mailers]]
|-
| [[Offerit Downloadable Videos|Video Download]]
|-
| [[Offerit Embedded Videos|Video Embed]]
|-
| [[Offerit Page Peels|Page Peels]]
|-
| [[Offerit IM Popups|IM Popups]]
|-
| [[Offerit Footer Ads|Footer Ads]]
|-
| [[Offerit Page Ads|Page Ads]]
|-
| [[Offerit Overlays|Overlays]]
|-
|}

{| class="collapsible {{{show_communications_admin_section|collapsed}}}" width="100%"
! class="i1" | Communications Admin
|-
| [[Communications Admin|The Communications Admin]]
|-
| [[Offerit Add News|Add News Item]]
|-
| [[Offerit Send Message|Sending Messages]]
|-
| [[Signup Questions]]
|}
{| class="collapsible {{{show_configuration_admin_section|collapsed}}}" width="100%"
! class="i1" | Configuration Admin
|-
| [[Configuration Admin|The Configuration Admin]]

|-
| [[Offerit Affiliate Signup Postback URL|Affiliate Signup Postback URL]]
|-
| [[Edit Affiliate Text]]
|-
| [[Edit CSS Colors]]

|}

{| class="collapsible {{{show_api_admin_section|collapsed}}}" width="100%"
! class="i1" | REST API
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
| [[Offerit REST API Get Profit Loss Report|GET /report/profitloss]]
|-
| [[Offerit REST API Get Transaction Report|GET /report/transaction]]
|-
| [[Offerit REST API Get Transaction Payout Preview|GET /transaction/transaction_payout_preview]]
|-
| [[Offerit REST API Set Affiliate Payvia Info|PATCH /affiliate/setpayviainfo]]
|-
| [[Offerit REST API Add Affiliate|POST /affiliate/addaffiliate]]

|}
{| class="collapsible {{{show_api_admin_section|collapsed}}}" width="100%"
! class="i1" | API
|-
| [[Offerit API|API]]
|-
| [[Offerit API Add Affiliate|Add Affiliate]]
|-
| [[Offerit API Add Affiliate Sale|Add Affiliate Sale]]
|-
| [[Offerit API Add Offer|Add Offer]]
|-
| [[Offerit API Approve Transaction|Approve Transaction]]

|-
| [[Offerit API Creative Types|Creative Types]]
|-
| [[Offerit API Decode Offeritcode|Decode Offeritcode]]
|-
| [[Offerit API Deny Transaction|Deny Transaction]]
|-
| [[Offerit API Disable Affiliate Landing Page|Disable Affiliate Landing Page]]
|-
| [[Offerit API Edit Affiliate Sale|Edit Affiliate Sale]]
|-
| [[Offerit API Enable Affiliate Landing Page|Enable Affiliate Landing Page]]

|-
| [[Offerit API Get Affiliate Stats|Get Affiliate Stats]]
|-
| [[Offerit API Get Allowed Affiliates|Get Allowed Affiliates]]
|-
| [[Offerit API Get Landing Page Details|Get Landing Page Details]]
|-
| [[Offerit API Get Offer Details|Get Offer Details]]
|-
| [[Offerit API Get Offer List|Get Offer List]]
|-
| [[Offerit API Get Profit Loss Report|Get Profit Loss Report]]

|-
| [[Offerit API List Affiliate Details|List Affiliate Details]]
|-
| [[Offerit API List Affiliate Subaffiliates|List Affiliate Subaffiliates]]
|-
| [[Offerit API Ping|Ping]]
|-

|-
| [[Offerit API Set Affiliate Status|Set Affiliate Status]]

|-
| [[Offerit API Set Subaffiliate Status|Set SubAffiliate Status]]

|-
| [[Offerit API Set Member Details|Set Member Details]]
|-
| [[Offerit API Record Affiliate Click|Record Affiliate Click]]
|}
{| class="collapsible {{{show_misc_section|collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-
| [[Rewards Admin|Rewards Admin]]
|-
| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


|}<includeonly>[[Category:Offerit]]</includeonly>

Offerit REST API Set Affiliate Payvia Info

2016-01-13T16:00:44Z

OfferitDave: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''PATCH /affiliate/setpayviainfo''' == '''Description''' *The /affiliate/setpayviainfo action is a feature in Offer..."

{{Offerit Manual
| show_api_admin_section = true
}}
== '''PATCH /affiliate/setpayviainfo''' ==
'''Description'''
*The /affiliate/setpayviainfo action is a feature in [[Offerit]] that allows you to set the affiliate payvia info settings

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/setpayviainfo</nowiki>
*Replace domain with the offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*loginid: is the affiliates loginid
**'''''type: string'''''
**required

*payvia_type_id: is the id of the payvia that the loginid should be switched to
**'''''type: string'''''
**required

*payvia_info: is an array containing arrays of info to update for the payvia type.
**'''''type: array'''''
**required

== '''Example Request''' ==

'''PATCH'''

<nowiki>http://domain/api/affiliate/setpayviainfo</nowiki>

*Response:
<pre>
[
{
"field":"Payvia Type",
"result":"Updated Payvia Type to 1 for loginid 1"
},
{
"field":"Pay To",
"result":"Updated Payvia Info: 'Pay To' is now 'TestPayTo'"
},
{
"field":"Address",
"result":"Updated Payvia Info: 'Address' is now 'Riga, Latvia'"
}
]
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$payvia_info = array();
$payvia_info[] = array(
'field' => 'Pay To',
'value' => 'TestPayTo'
);
$payvia_info[] = array(
'field' => 'Address',
'value' => 'Riga, Latvia'
);

$data = array(
'loginid' => 1,
'payvia_type_id' => '1',
'payvia_info' => $payvia_info
);

$url = 'http://domain/api/affiliate/setpayviainfo';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]