Offerit - User contributions [en]

Offerit REST API Remove Global Post Ip

2022-08-08T17:51:47Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/remove_global_post_ip''' == '''Description''' *The api/config/remove_global_post_ip action removes a pro..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/remove_global_post_ip''' ==
'''Description'''
*The api/config/remove_global_post_ip action removes a provided ip from the Config -> Security, Global Host and Post Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/remove_global_post_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/remove_global_post_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip removed / not in list / list not set"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/remove_global_post_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Remove Global Host and Post Ips

2022-08-08T17:18:34Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/remove_global_hostnpost_ip''' == '''Description''' *The api/config/remove_global_hostnpost_ip action rem..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/remove_global_hostnpost_ip''' ==
'''Description'''
*The api/config/remove_global_hostnpost_ip action removes a provided ip from the Config -> Security, Global Host and Post Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/remove_global_hostnpost_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/remove_global_hostnpost_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip removed / not in list / list not set"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/remove_global_hostnpost_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Remove Global Void Ip

2022-08-05T21:03:36Z

OfferitRob: /* POST /config/remove_global_void_ip */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/remove_global_void_ip''' ==
'''Description'''
*The api/config/remove_global_void_ip action removes a provided ip from the Config -> Security, Global Void Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/remove_global_void_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/remove_global_void_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip removed / not in list / list not set"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/remove_global_void_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Remove Global Void Ip

2022-08-05T21:02:21Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/remove_global_void_ip''' ==
'''Description'''
*The api/config/remove_global_void_ip action removes a provided ip from the Config -> Security, Global Host and Post Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/remove_global_void_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/remove_global_void_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip removed / not in list / list not set"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/remove_global_void_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Remove Global Void Ip

2022-08-05T18:43:28Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/remove_global_void_ip''' == '''Description''' *The api/config/remove_global_void_ip action adds a valid..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/remove_global_void_ip''' ==
'''Description'''
*The api/config/remove_global_void_ip action adds a valid ip to the Config->Security->Global Postback Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/remove_global_void_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/remove_global_void_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip removed / not in list / list not set"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/remove_global_void_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Add Global Host and Post Ips

2022-08-05T16:31:10Z

OfferitRob: /* POST /config/add_global_hostnpost_ip */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/add_global_hostnpost_ip''' ==
'''Description'''
*The api/config/add_global_hostnpost_ip action adds a valid ip to the Config->Security->Global Host and Post Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/add_global_hostnpost_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/add_global_hostnpost_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip added / exists"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/add_global_hostnpost_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Add Global Host and Post Ips

2022-08-03T22:33:59Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/add_global_hostnpost_ip''' == '''Description''' *The api/config/add_global_hostnpost_ip action adds a va..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/add_global_hostnpost_ip''' ==
'''Description'''
*The api/config/add_global_hostnpost_ip action adds a valid ip to the Config->Security->Global Postback Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/add_global_hostnpost_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/add_global_hostnpost_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip added / exists"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/add_global_hostnpost_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Add Global Post Ip

2022-08-01T23:11:07Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/add_global_post_ip''' == '''Description''' *The api/config/add_global_post_ip action adds a valid ip to..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/add_global_post_ip''' ==
'''Description'''
*The api/config/add_global_post_ip action adds a valid ip to the Config->Security->Global Postback Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/add_global_post_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/add_global_post_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip added / exists"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/add_global_post_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Add Global Void Ip

2022-08-01T21:57:23Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/add_global_void_ip''' == '''Description''' *The api/config/add_global_void_ip action adds a valid ip to..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/add_global_void_ip''' ==
'''Description'''
*The api/config/add_global_void_ip action adds a valid ip to the Config->Security->Global Void Ip list

'''Resource URL'''
*<nowiki>https://domain/api/config/add_global_void_ip</nowiki>
*Replace domain with the Offerit domain

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

'''Response Format'''
*JSON

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

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

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

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

'''POST'''

<nowiki>https://domain/api/config/add_global_void_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip added / Ip already in list"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/add_global_void_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
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]]

Offerit REST API Get Global Host and Post Ips

2022-07-28T21:54:30Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_hostnpost_ips''' ==
'''Description'''
*The api/config/get_global_hostnpost_ips action is allows retrieval of the Global Post Ip list (Config -> Security, Global Host and Post Allowed IPs)

'''Resource URL'''
*<nowiki>https://domain/api/config/get_global_hostnpost_ips</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''' ==
'''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

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

'''GET'''

<nowiki>https://domain/api/config/get_global_hostnpost_ips</nowiki>

*Response:
<pre>
{
"result": "success",
"data": [
"2001:1af8:4e00:a018:6::10",
"73.279.112.30"
]
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array();

$url = 'https://domain/api/config/get_global_hostnpost_ips';

$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>

[[Category:Offerit API Articles]]

Offerit REST API Get Global Host and Post Ips

2022-07-28T21:54:18Z

OfferitRob:

{{NATS for Networks Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_hostnpost_ips''' ==
'''Description'''
*The api/config/get_global_hostnpost_ips action is allows retrieval of the Global Post Ip list (Config -> Security, Global Host and Post Allowed IPs)

'''Resource URL'''
*<nowiki>https://domain/api/config/get_global_hostnpost_ips</nowiki>
*Replace domain with the NATS for Networks domain

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

'''Response Format'''
*JSON

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

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

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

'''GET'''

<nowiki>https://domain/api/config/get_global_hostnpost_ips</nowiki>

*Response:
<pre>
{
"result": "success",
"data": [
"2001:1af8:4e00:a018:6::10",
"73.279.112.30"
]
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array();

$url = 'https://domain/api/config/get_global_hostnpost_ips';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: 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>

[[Category:NATS For Networks API Articles]]

Offerit REST API Get Global Post Ips

2022-07-26T21:13:08Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /config/get_global_post_ips''' == '''Description''' *The api/config/get_global_post_ips action is allows retriev..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_post_ips''' ==
'''Description'''
*The api/config/get_global_post_ips action is allows retrieval of the Global Post Ip list (Config -> Security, Global Postback Allowed IPs)

'''Resource URL'''
*<nowiki>https://domain/api/config/get_global_post_ips</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''' ==
'''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

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

'''GET'''

<nowiki>https://domain/api/config/get_global_post_ips</nowiki>

*Response:
<pre>
{
"result": "success",
"data": [
"2001:1af8:4e00:a018:6::10",
"73.279.112.30"
]
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

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

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

$data = array();

$url = 'https://domain/api/config/get_global_post_ips';

$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>

[[Category:Offerit API Articles]]

Offerit REST API Get Global Host and Post Ips

2022-07-26T21:12:52Z

OfferitRob:

Offerit REST API Get Global Host and Post Ips

2022-07-26T21:11:43Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_post_ips''' ==
'''Description'''
*The api/config/get_global_post_ips action is allows retrieval of the Global Post Ip list (Config -> Security, Global Postback Allowed IPs)

'''Resource URL'''
*<nowiki>https://domain/api/config/get_global_post_ips</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''' ==
'''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

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

'''GET'''

<nowiki>https://domain/api/config/get_global_post_ips</nowiki>

*Response:
<pre>
true
</pre>

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

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

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

$url = 'https://domain/api/config/get_global_post_ips';

$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>

[[Category:Offerit API Articles]]

Offerit REST API Get Global Host and Post Ips

2022-07-26T21:11:10Z

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_post_ips''' ==
'''Description'''
*The api/config/get_global_post_ips action is allows retrieval of the Global Post Ip list (Config -> Security)

'''Resource URL'''
*<nowiki>https://domain/api/config/get_global_post_ips</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''' ==
'''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

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

'''GET'''

<nowiki>https://domain/api/config/get_global_post_ips</nowiki>

*Response:
<pre>
true
</pre>

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

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

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

$url = 'https://domain/api/config/get_global_post_ips';

$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>

[[Category:Offerit API Articles]]

Offerit REST API Get Global Void Ips

2022-07-22T20:37:59Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_void_ips''' ==
'''Description'''
*The api/config/get_global_void_ips action allows retrieval of the "Global Void Allowed IPs" list set in Config -> Security

'''Resource URL'''
*<nowiki>https://domain/api/config/get_global_void_ips</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''' ==
'''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

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

'''GET'''

<nowiki>https://domain/api/config/get_global_void_ips</nowiki>

*Response:
<pre>
true
</pre>

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

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

$data = array();

$url = 'https://domain/api/config/get_global_void_ips';

$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 = 'https://domain/api/config/get_global_void_ips'

payload = {}

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 = {}

var options = {
url: 'https://domain/api/config/get_global_void_ips',
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 'https://domain/api/config/get_global_void_ips' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded"
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Global Void Ips

2022-07-22T18:10:38Z

OfferitRob:

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

'''Resource URL'''
*<nowiki>https://domain/api/config/get_global_void_ips</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''' ==
'''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

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

'''GET'''

<nowiki>https://domain/api/config/get_global_void_ips</nowiki>

*Response:
<pre>
true
</pre>

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

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

$data = array();

$url = 'https://domain/api/config/get_global_void_ips';

$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 = 'https://domain/api/config/get_global_void_ips'

payload = {}

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 = {}

var options = {
url: 'https://domain/api/config/get_global_void_ips',
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 'https://domain/api/config/get_global_void_ips' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded"
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Global Void Ips

2022-07-22T18:09:45Z

OfferitRob:

Offerit REST API Get Global Void Ips

2022-07-22T18:08:39Z

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

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

'''Resource URL'''
*<nowiki>https://domain/api/config/get_global_void_ips</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''' ==
'''Parameters 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>https://domain/api/config/get_global_void_ips</nowiki>

*Response:
<pre>
true
</pre>

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

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

$data = array();

$url = 'https://domain/api/config/get_global_void_ips';

$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 = 'https://domain/api/config/get_global_void_ips'

payload = {}

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 = {}

var options = {
url: 'https://domain/api/config/get_global_void_ips',
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 'https://domain/api/config/get_global_void_ips' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded"
</pre>

[[Category:Offerit API Articles]]

Template:Offerit Manual

2022-07-18T17:33:50Z

OfferitRob:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-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="mw-collapsible {{{show_affiliate_area_section|mw-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="mw-collapsible {{{show_setup_section|mw-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]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-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="mw-collapsible {{{show_offers_admin_section|mw-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="mw-collapsible {{{show_affiliates_admin_section|mw-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="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-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="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-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="mw-collapsible {{{show_creative_types_section|mw-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="mw-collapsible {{{show_communications_admin_section|mw-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="mw-collapsible {{{show_configuration_admin_section|mw-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="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
| [[Offerit REST API Set Currency Exchange Rates|PATCH /service/set_currency_exchange_rates]]
|-
! 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 Get Conversion Caps|GET /offer/get_conversion_caps]]
|-
| [[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 Offer Get Details|GET /offer/get_details]]
|-
| [[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="mw-collapsible {{{show_api_admin_section|mw-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="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


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

Template:Offerit Manual

2022-07-18T17:33:22Z

OfferitRob:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| class="mw-collapsible {{{show_for_affiliates_section|mw-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="mw-collapsible {{{show_affiliate_area_section|mw-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="mw-collapsible {{{show_setup_section|mw-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]]
|-
| [[Offerit Currency Exchange Rates|Currency Exchange Rates]]
|}
<hr />
{| class="mw-collapsible {{{show_admin_overview_section|mw-collapsed}}}" width="100%"
! class="i1" | Admin Dashboard
|-
| [[Admin Dashboard|The Admin Dashboard]]
|}
{| class="mw-collapsible {{{show_reporting_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Reporting Admin
|-
| [[Reporting Admin|The Reporting Admin]]
|-
| [[Track and Strack|Track and Strack]]
|-

|}
{| class="mw-collapsible {{{show_report_breakdowns_section|mw-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="mw-collapsible {{{show_offers_admin_section|mw-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="mw-collapsible {{{show_affiliates_admin_section|mw-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="mw-collapsible {{{show_advertisers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Advertisers Admin
|-
| [[Advertisers Admin|The Advertisers Admin]]
|-
| [[Account Changes]]
|-
| [[Advertiser Invoices]]
|-
| [[Generate Invoice]]
|-
| [[Advertiser Approval]]
|-
| [[Change Advertiser Status]]
|}
{| class="mw-collapsible {{{show_customers_admin_section|mw-collapsed}}}" width="100%"
! class="i1" | Customers Admin
|-
| [[Customers Admin]]
|-
| [[Offerit Add Customer|Manually Adding a Customer]]
|-
| [[ID Numbers]]
|-
|}

{| class="mw-collapsible {{{show_payments_admin_section|mw-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="mw-collapsible {{{show_payment_methods_section|mw-collapsed}}}" width="100%"
! class="i1" |Payment Methods
|-
| [[Payza|Payza]]
|}
{| class="mw-collapsible {{{show_creatives_admin_section|mw-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="mw-collapsible {{{show_creative_types_section|mw-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="mw-collapsible {{{show_communications_admin_section|mw-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="mw-collapsible {{{show_configuration_admin_section|mw-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="mw-collapsible {{{show_rest_api_section|mw-collapsed}}}" width="100%"
! class="i1" | REST API
|-
! class="i1" | General
|-
| [[Offerit REST API Overview]]
|-
| [[Offerit REST API Ping|GET /service/ping]]
|-
| [[Offerit REST API Set Currency Exchange Rates|PATCH /service/set_currency_exchange_rates]]
|-
! 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" | Config
|-
| [[Offerit REST API Get Global Void Ips |GET /config/get_global_void_ips]]
|-
| [[Offerit REST API Get Global Post Ips |GET /config/get_global_post_ips]]
|-
| [[Offerit REST API Get Global Host and Post Ips |GET /config/get_global_hostnpost_ips]]
|-
| [[Offerit REST API Add Global Void Ip |POST /config/add_global_void_ip]]
|-
| [[Offerit REST API Remove Global Void Ip |POST /config/remove_global_void_ip]]
|-
| [[Offerit REST API Add Global Post Ip |POST /config/add_global_post_ip]]
|-
| [[Offerit REST API Remove Global Post Ip |POST /config/remove_global_post_ip]]
|-
| [[Offerit REST API Add Global Host and Post Ips |POST /config/add_global_hostnpost_ip]]
|-
| [[Offerit REST API Remove Global Host and Post Ips |POST /config/remove_global_hostnpost_ip]]
|-

|-
! 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 Get Conversion Caps|GET /offer/get_conversion_caps]]
|-
| [[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 Offer Get Details|GET /offer/get_details]]
|-
| [[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="mw-collapsible {{{show_api_admin_section|mw-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="mw-collapsible {{{show_misc_section|mw-collapsed}}}" width="100%"
! class="i1" | Misc.
|-
| [[Offerit Rules|Rules]]
|-
| [[Offerit Freeform Date|Freeform Date]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


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

Template:Offerit Manual

2022-07-18T17:30:32Z

OfferitRob:

Offerit REST API Get Transaction Report

2021-01-12T00:19:53Z

OfferitRob: /* Example Code */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /report/transaction''' ==
'''Description'''
*Offerit supports an API resource to grab all the stats used within the Offerit 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 Offerit.
** '''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.
** '''filter_orderid''' - search for a transaction with a specific orderid.
** '''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(
'filter_orderid' => 3890345,
'period' => 7
);

$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 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>

'''Response'''
<pre>
Array
(
[16102840320319934329] => Array
(
[time] => 1610284032
[loginid] => 2
[amount] => 0
[trans_type] => advertiser_initial
[transaction_hash] => ac35ffba0fc0007.24591976
[orderid] => 7861
[external_clickid] => CLICK_198758_17
[offerid] => 14
[landing_pageid] => 26
[total_payout] => 36
[payouts] => Array
(
[0] => Array
(
[id] => 16102840331022602480
[type] => referral
[username] => byers1998
[loginid] => 109
[amount] => 4
)

[1] => Array
(
[id] => 20840330721619639764
[type] => affiliate
[username] => Jeff
[loginid] => 37
[amount] => 32
)

)

)
)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Transaction Report

2021-01-12T00:18:19Z

OfferitRob: /* Example Code */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /report/transaction''' ==
'''Description'''
*Offerit supports an API resource to grab all the stats used within the Offerit 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 Offerit.
** '''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.
** '''filter_orderid''' - search for a transaction with a specific orderid.
** '''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(
'filter_orderid' => 3890345,
'period' => 7
);

$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 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>

*Response:
<pre>
Array
(
[16102840320319934329] => Array
(
[time] => 1610284032
[loginid] => 2
[amount] => 0
[trans_type] => advertiser_initial
[transaction_hash] => ac35ffba0fc0007.24591976
[orderid] => 7861
[external_clickid] => CLICK_198758_17
[offerid] => 14
[landing_pageid] => 26
[total_payout] => 36
[payouts] => Array
(
[0] => Array
(
[id] => 16102840331022602480
[type] => referral
[username] => byers1998
[loginid] => 109
[amount] => 4
)

[1] => Array
(
[id] => 20840330721619639764
[type] => affiliate
[username] => Jeff
[loginid] => 37
[amount] => 32
)

)

)
)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Transaction Report

2021-01-12T00:16:35Z

OfferitRob: /* Example Code */

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /report/transaction''' ==
'''Description'''
*Offerit supports an API resource to grab all the stats used within the Offerit 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 Offerit.
** '''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.
** '''filter_orderid''' - search for a transaction with a specific orderid.
** '''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 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>

*Response:
<pre>
Array
(
[16102840320319934329] => Array
(
[time] => 1610284032
[loginid] => 2
[amount] => 0
[trans_type] => advertiser_initial
[transaction_hash] => ac35ffba0fc0007.24591976
[orderid] => 7861
[external_clickid] => CLICK_198758_17
[offerid] => 14
[landing_pageid] => 26
[total_payout] => 36
[payouts] => Array
(
[0] => Array
(
[id] => 16102840331022602480
[type] => referral
[username] => byers1998
[loginid] => 109
[amount] => 4
)

[1] => Array
(
[id] => 20840330721619639764
[type] => affiliate
[username] => Jeff
[loginid] => 37
[amount] => 32
)

)

)
)
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Transaction Report

2021-01-12T00:15:50Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /report/transaction''' ==
'''Description'''
*Offerit supports an API resource to grab all the stats used within the Offerit 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 Offerit.
** '''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.
** '''filter_orderid''' - search for a transaction with a specific orderid.
** '''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 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>

*Response:
Array
(
[16102840320319934329] => Array
(
[time] => 1610284032
[loginid] => 2
[amount] => 0
[trans_type] => advertiser_initial
[transaction_hash] => ac35ffba0fc0007.24591976
[orderid] => 7861
[external_clickid] => CLICK_198758_17
[offerid] => 14
[landing_pageid] => 26
[total_payout] => 36
[payouts] => Array
(
[0] => Array
(
[id] => 16102840331022602480
[type] => referral
[username] => byers1998
[loginid] => 109
[amount] => 4
)

[1] => Array
(
[id] => 20840330721619639764
[type] => affiliate
[username] => Jeff
[loginid] => 37
[amount] => 32
)

)

)
)

[[Category:Offerit API Articles]]

Offerit REST API Get Transaction Report

2021-01-11T22:50:51Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /report/transaction''' ==
'''Description'''
*Offerit supports an API resource to grab all the stats used within the Offerit 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 Offerit.
** '''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.
** '''filter_orderid''' - search for a transaction with a specific orderid.
** '''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 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>

== '''Example Return''' ==
Array
(
[16102840320319934329] => Array
(
[time] => 1610284032
[loginid] => 2
[amount] => 0
[trans_type] => advertiser_initial
[transaction_hash] => ac35ffba0fc0007.24591976
[orderid] => 7861
[external_clickid] => CLICK_198758_17
[offerid] => 14
[landing_pageid] => 26
[total_payout] => 36
[payouts] => Array
(
[0] => Array
(
[id] => 16102840331022602480
[type] => referral
[username] => byers1998
[loginid] => 109
[amount] => 4
)

[1] => Array
(
[id] => 20840330721619639764
[type] => affiliate
[username] => Jeff
[loginid] => 37
[amount] => 32
)

)

)
)

[[Category:Offerit API Articles]]

Offerit REST API Search Affiliate

2020-11-20T00:35:39Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section= true
}}

== '''GET affiliate/search''' ==
'''Description'''
*Offerit supports an API resource to get affiliate info for an affiliate or multiple affiliates based on the parameters entered.

'''Resource URL'''
*<nowiki>http://domain/api/affiliate/search</nowiki>
*Replace domain with your 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''' ==

'''''Parameters can be sent as url encoded params. All parameters are optional so if none are entered, all affiliate information will be displayed.''.'''

*loginid
**'''''type: integer'''''
**'''''optional'''''
*username
**'''''type: string'''''
**'''''optional'''''
*email
**'''''type: string'''''
**'''''optional'''''
*firstname
**'''''type: string'''''
**'''''optional'''''
*lastname
**'''''type: string'''''
**'''''optional'''''
*address
**'''''type: string'''''
**'''''optional'''''
*city
**'''''type: string'''''
**'''''optional'''''
*zip_code
**'''''type: string'''''
**'''''optional'''''
*country
**'''''type: string'''''
**'''''optional'''''
*company
**'''''type: string'''''
**'''''optional'''''
*deleted
**'''''type: string'''''
**'''''optional'''''
*end
**'''''type: string'''''
**'''''optional'''''
*aim
**'''''type: string'''''
**'''''optional'''''
*icq
**'''''type: string'''''
**'''''optional'''''
*inhouse
**'''''type: string'''''
**'''''optional'''''
*join_count
**'''''type: integer'''''
**'''''note: affiliate join transaction lookup < join_count '''''
**'''''optional'''''

*join_date
**'''''type: string'''''
**'''''optional'''''
*join_range
**'''''type: string'''''
**'''''note: changes comparison with join_date (affiliate signup date > join_date) '''''
**'''''optional'''''
*join_ip
**'''''type: string'''''
**'''''optional'''''
*login_date
**'''''type: string'''''
**'''''optional'''''
*login_ip
**'''''type: string'''''
**'''''optional'''''
*login_range
**'''''type: string'''''
**'''''optional'''''
*min_pay
**'''''type: string'''''
**'''''optional'''''
*name
**'''''type: string'''''
**'''''optional'''''
*trackingcode
**'''''type: string'''''
**'''''optional'''''
*orderby
**'''''type: string'''''
**'''''optional'''''
*pay_range
**'''''type: string'''''
**'''''optional'''''
*payvia_details
**'''''type: string'''''
**'''''optional'''''
*payvia_type_id
**'''''type: integer'''''
**'''''optional'''''
*ratio
**'''''type: string'''''
**'''''note: affiliate hits/conversions < ratio'''''
**'''''optional'''''

*raw_clicks
**'''''type: integer'''''
**'''''note: affiliate hits lookup < raw_clicks '''''
**'''''optional'''''

*continuity_count
**'''''type: string'''''
**'''''note: affiliate continuity lookup < continuity_count '''''
**'''''optional'''''

*refid
**'''''type: string'''''
**'''''optional'''''
*ref
**'''''type: string'''''
**'''''optional'''''
*void_count
**'''''type: string'''''
**'''''note: affiliate void lookup < void_count '''''
**'''''optional'''''

*sales_rep
**'''''type: string'''''
**'''''optional'''''
*search_ref
**'''''type: string'''''
**'''''optional'''''
*start
**'''''type: string'''''
**'''''optional'''''
*state
**'''''type: string'''''
**'''''optional'''''
*stats_end
**'''''type: string'''''
**'''''optional'''''
*stats_period
**'''''type: string'''''
**'''''optional'''''
*stats_start
**'''''type: string'''''
**'''''optional'''''
*status
**'''''type: string'''''
**'''''optional'''''
*total_earned
**'''''type: string'''''
**'''''optional'''''

*total
**'''''type: string'''''
**'''''optional'''''
*type
**'''''type: string'''''
**'''''optional'''''
*unq_clicks
**'''''type: string'''''
**'''''note: affiliate unique click lookup < unq_clicks '''''
**'''''optional'''''

*url
**'''''type: string'''''
**'''''optional'''''
*return_payvia_info
**'''''note: If passed as any non empty value, the function will return affiliate payvia information within a sub array called "payvia_details" '''''
**'''''type: string'''''
**'''''optional'''''
*return_referred_info
**'''''note: If passed as any non empty value, the function will return the referring affiliate chain for this account (parent accounts) within a sub array called "referred_details" '''''
**'''''type: string'''''
**'''''optional'''''
*return_referring_info
**'''''note: If passed as any non empty value, the function will return all affiliate accounts referred by this affiliate (child accounts) within a sub array called "referring_details" '''''
**'''''type: string'''''
**'''''optional'''''

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

'''GET'''

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

*Response:
<pre>
{
"3": {
"loginid": "3",
"username": "affiliate1",
"password": "$6$4Arjzx0l$KexJXqDqIWBtasD54qQh5Tknnj2mm.m3D9ULyAef.GvYdxMO3w3ERStyTzy.VXXPRNsykYLfjQNt8APX0x4Wq.",
"deleted": "0",
"type": "100",
"skinid": "102",
"payvia_type_id": "1",
"status": "0",
"pass_hash": "55718788453dfec428c9fb3.27539735",
"join_date": "1402587397",
"inhouse": "0",
"api_key": "",
"tmmid": "0",
"origin": "0",
"language": "en",
"rss_pass_code": "145b3ce7614671d0a9ebe81f87ac275d",
"payout_period_id": "0",
"firstname": "Test",
"lastname": "Testakovsky",
"email": "hello@offerit.com",
"date_posted": "1402587397",
"join_ip": "168430159",
"last_login": "1407183950",
"last_login_ip": "168430236",
"reviewed": "1",
"minimum_payout": "50",
"bonus": "0",
"bonus_used": "0",
"verify": "",
"reason": "",
"unencoded": "0",
"startpage": "internal.php",
"rep_baseline": "0",
"company": "Test Company",
"url": "http:\/\/this.is\/test",
"tel": "",
"icq": "",
"aim": "",
"msn": "",
"address1": "666 Lemmy St",
"address2": null,
"city": "Heck",
"state": "NJ",
"country": "US",
"zip_code": "66666",
"tax_id_or_ssn": "",
"invoicer": "0",
"req_docs": "1",
"w9": "1",
"mailok": "1",
"trust_level": "0",
"new_notification": "0",
"latest_news": "1403790938",
"default_campaign": "0",
"default_program": "1",
"default_site": "0",
"pv_instant": "0",
"payout_approval": "0",
"access_preset": "0",
"custom1": "0",
"custom2": "0",
"custom3": "0",
"custom4": "0",
"custom5": "0",
"avatar_ext": "",
"remote_access": "0",
"remote_payment": "0",
"remote_adtool": "0",
"allow_subscription_passthrough": "0",
"allow_option_force": "0",
"status_nice": null,
"payvia_details": [ ]
}
}
</pre>

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

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

$data = array(
'username' => 'affiliate1',
);

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

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
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 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>

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

url = 'http://domain/api/affiliate/search'

params = {
'username': 'affiliate1'
}

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

res = requests.get(url, params=params, 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');

var options = {
url: 'http://domain/api/affiliate/search',
method: 'GET',
qs: {
'username': 'affiliate1'
},
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
};

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/affiliate/search?username=affiliate1' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Process Reversal

2020-06-24T18:32:41Z

OfferitRob: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST transaction/process_reversal''' ==
'''Description'''
This REST API resource to used to issue a reversal for a transaction that was previously voided/chargedback

'''Resource URL'''
*<nowiki>http://domain/api/transaction/process_reversal</nowiki>
*Replace domain with your Offerit network domain

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

'''Response Format'''
*JSON

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

== '''Parameters''' ==
*'''transaction_hash''': ''The click_hash/transaction_hash of the transaction you want to reverse.''
**'''''type: string'''''
**'''''optional'''''

*'''click_hash''': ''The click_hash/transaction_hash of the transaction you want to reverse.''
**'''''type: string'''''
**'''''optional'''''

*'''orderid''': ''The transaction identifier sent on conversion (orderid) you want to reverse.''
**'''''type: string'''''
**'''''optional'''''

*'''transactionid''': ''The Offerit generated transaction identifier you want to reverse''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom1 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom2 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom3 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom4 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom5 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

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

'''POST'''

<nowiki>http://domain.com/api/transaction/process_reversal</nowiki>

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

Failure
{
"result": "error",
"message": "Missing required flag (reverse)."
}
</pre>

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

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

$data = array(
'reverse' => TRUE,
'transaction_hash' => '156097c947ece92.38318951',
);
$url = 'http://domain/api/transaction/process_reversal';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
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 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 Process Void

2020-06-24T18:23:42Z

OfferitRob: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST transaction/process_void''' ==
'''Description'''
*This REST API resource is used to void a transaction that was previously converted

'''Resource URL'''
*<nowiki>http://domain/api/transaction/process_void</nowiki>
*Replace domain with your Offerit network domain

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

'''Response Format'''
*JSON

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

== '''Parameters''' ==
*'''transaction_hash''': ''The click_hash/transaction_hash of the transaction you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''click_hash''': ''The click_hash/transaction_hash of the transaction you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''orderid''': ''The transaction identifier sent on conversion (orderid) you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''transactionid''': ''The Offerit generated transaction identifier you want voided''
**'''''type: string'''''
**'''''optional'''''

*'''approved''': ''Used in setups with pending conversions so the initial transaction identifier can be sent to void the associated approval''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom1 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom2 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom3 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom4 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom5 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

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

'''POST'''

<nowiki>http://domain.com/api/transaction/process_void</nowiki>

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

Failure
{
"result": "error",
"message": "*error* - Void transaction exists."
}
</pre>

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

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

$data = array(
'type' => 'void',
'transaction_hash' => '156097c947ece92.38318951',
);
$url = 'http://domain/api/transaction/process_void';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
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 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 Process Chargeback

2020-06-24T18:20:58Z

OfferitRob: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST transaction/process_chargeback''' ==
'''Description'''
This REST API resource to used to issue a chargeback for a transaction that was previously converted

'''Resource URL'''
*<nowiki>http://domain/api/transaction/process_chargeback</nowiki>
*Replace domain with your Offerit network domain

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

'''Response Format'''
*JSON

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

== '''Parameters''' ==
*'''transaction_hash''': ''The click_hash/transaction_hash of the transaction you want to chargeback.''
**'''''type: string'''''
**'''''optional'''''

*'''click_hash''': ''The click_hash/transaction_hash of the transaction you want to chargeback.''
**'''''type: string'''''
**'''''optional'''''

*'''orderid''': ''The transaction identifier sent on conversion (orderid) you want to chargeback.''
**'''''type: string'''''
**'''''optional'''''

*'''transactionid''': ''The Offerit generated transaction identifier you want to chargeback''
**'''''type: string'''''
**'''''optional'''''

*'''cost''': ''The cost of the chargeback (decimal format) will be taken away from the affiliate payout''
**'''''type: double'''''
**'''''optional'''''

*'''trans_custom1 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom2 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom3 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom4 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom5 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

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

'''POST'''

<nowiki>http://domain.com/api/transaction/process_chargeback</nowiki>

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

Failure
{
"result": "error",
"message": "Missing required field for chargeback (type)."
}
</pre>

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

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

$data = array(
'type' => 'chargeback',
'transaction_hash' => '156097c947ece92.38318951',
);
$url = 'http://domain/api/transaction/process_chargeback';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
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 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 Process Chargeback

2020-06-23T22:44:36Z

OfferitRob: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST transaction/process_chargeback''' ==
'''Description'''
This REST API resource to used to issue a chargeback for a transaction that was previously converted

'''Resource URL'''
*<nowiki>http://domain/api/transaction/process_chargeback</nowiki>
*Replace domain with your Offerit network domain

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

'''Response Format'''
*JSON

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

== '''Parameters''' ==
*'''type''': ''This should always be set as chargeback''
**'''''type: string'''''
**'''''required'''''

*'''transaction_hash''': ''The click_hash/transaction_hash of the transaction you want to chargeback.''
**'''''type: string'''''
**'''''optional'''''

*'''click_hash''': ''The click_hash/transaction_hash of the transaction you want to chargeback.''
**'''''type: string'''''
**'''''optional'''''

*'''orderid''': ''The transaction identifier sent on conversion (orderid) you want to chargeback.''
**'''''type: string'''''
**'''''optional'''''

*'''transactionid''': ''The Offerit generated transaction identifier you want to chargeback''
**'''''type: string'''''
**'''''optional'''''

*'''cost''': ''The cost of the chargeback (decimal format) will be taken away from the affiliate payout''
**'''''type: double'''''
**'''''optional'''''

*'''trans_custom1 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom2 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom3 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom4 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom5 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

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

'''POST'''

<nowiki>http://domain.com/api/transaction/process_chargeback</nowiki>

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

Failure
{
"result": "error",
"message": "Missing required field for chargeback (type)."
}
</pre>

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

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

$data = array(
'type' => 'chargeback',
'transaction_hash' => '156097c947ece92.38318951',
);
$url = 'http://domain/api/transaction/process_chargeback';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
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 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]]

Void Conversions Remotely

2020-06-23T22:43:26Z

OfferitRob: /* Posting a Chargeback Transaction */

{{Offerit Manual
| show_misc_section = true
}}

You can void any conversion recorded remotely by sending a post to the process_void.php script. This will allow you to automate voiding transactions in your system so you don't have to manually void customer transactions in the Customers Admin. (

When a void is recorded for a transaction the amount of revenue recorded for that transaction will be deducted from your Profit and Loss reports. Also, your offers will (by default) remove any affiliate payout given to the affiliate for that conversion.

A transaction may only be voided if you can supply the orderid of the transaction. This means that your system must create a unique orderid when a conversion occurs and the pixel for this conversion must contain the orderid.

==Enabling Void Posts==
Before voids can be posted to your network, you must first enable this feature in the Misc section of the [[Configuration Admin]] by checking the setting named "Allow Remote Void Posts".

==Posting a Void Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to void.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being voided.
*'''type''' - (optional) This is an optional parameter for recording voids. (Can be sent as either "void" or you can omit this parameter.)
*'''approved''' - (optional) If you want to void a pending transaction that has been approved, pass in the "orderid" of the pending transaction and set this parameter to "1".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
===Example===
<pre>http://yourdomain.offerit.com/signup/process_void.php?orderid=12345</pre>

==Posting a Chargeback Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to chargeback.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being charged back.
*'''type''' - "chargeback" - This is a required parameter for recording chargebacks. (This must be set to "chargeback".)
*'''cost''' - (optional) This is an optional parameter that can be set to add a transaction fee for processing the chargeback. By default, this fee will be deducted from the referring affiliate's payout. For example, If you want the chargeback fee to be $25.00, you would set this parameter to "25.00".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.

===Examples===
<pre>http://demo.offerit.com/signup/process_void.php?orderid=12345&type=chargeback&cost=25.00</pre>
<pre>http://demo.offerit.com/signup/process_void.php?click_hash=45a552e2b7ea632.76210061</pre>

==Reversing a Void or Chargeback Transaction==

Parameters:
*'''reverse''' - This parameter is required to reverse a void/chargeback transaction and must be set to 1.

==Security==
To protect your system and prevent fraudulent transactions from being recorded, you can restrict which IP addresses can send posts to process_void.php. To do this, edit the landing page of the offer you are trying to restrict postbacks for, then enter the comma-separated list of IP addresses in the field named "Secure Landing Page Void IPs".

===Example===
11.22.33.44,55.66.77.88

Void Conversions Remotely

2020-06-23T22:43:11Z

OfferitRob: /* Posting a Chargeback Transaction */

{{Offerit Manual
| show_misc_section = true
}}

You can void any conversion recorded remotely by sending a post to the process_void.php script. This will allow you to automate voiding transactions in your system so you don't have to manually void customer transactions in the Customers Admin. (

When a void is recorded for a transaction the amount of revenue recorded for that transaction will be deducted from your Profit and Loss reports. Also, your offers will (by default) remove any affiliate payout given to the affiliate for that conversion.

A transaction may only be voided if you can supply the orderid of the transaction. This means that your system must create a unique orderid when a conversion occurs and the pixel for this conversion must contain the orderid.

==Enabling Void Posts==
Before voids can be posted to your network, you must first enable this feature in the Misc section of the [[Configuration Admin]] by checking the setting named "Allow Remote Void Posts".

==Posting a Void Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to void.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being voided.
*'''type''' - (optional) This is an optional parameter for recording voids. (Can be sent as either "void" or you can omit this parameter.)
*'''approved''' - (optional) If you want to void a pending transaction that has been approved, pass in the "orderid" of the pending transaction and set this parameter to "1".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
===Example===
<pre>http://yourdomain.offerit.com/signup/process_void.php?orderid=12345</pre>

==Posting a Chargeback Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to chargeback.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being charged back.
*'''type''' - "chargeback" This is a required parameter for recording chargebacks. (This must be set to "chargeback".)
*'''cost''' - (optional) This is an optional parameter that can be set to add a transaction fee for processing the chargeback. By default, this fee will be deducted from the referring affiliate's payout. For example, If you want the chargeback fee to be $25.00, you would set this parameter to "25.00".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.

===Examples===
<pre>http://demo.offerit.com/signup/process_void.php?orderid=12345&type=chargeback&cost=25.00</pre>
<pre>http://demo.offerit.com/signup/process_void.php?click_hash=45a552e2b7ea632.76210061</pre>

==Reversing a Void or Chargeback Transaction==

Parameters:
*'''reverse''' - This parameter is required to reverse a void/chargeback transaction and must be set to 1.

==Security==
To protect your system and prevent fraudulent transactions from being recorded, you can restrict which IP addresses can send posts to process_void.php. To do this, edit the landing page of the offer you are trying to restrict postbacks for, then enter the comma-separated list of IP addresses in the field named "Secure Landing Page Void IPs".

===Example===
11.22.33.44,55.66.77.88

Void Conversions Remotely

2020-06-23T22:42:54Z

OfferitRob: /* Posting a Chargeback Transaction */

{{Offerit Manual
| show_misc_section = true
}}

You can void any conversion recorded remotely by sending a post to the process_void.php script. This will allow you to automate voiding transactions in your system so you don't have to manually void customer transactions in the Customers Admin. (

When a void is recorded for a transaction the amount of revenue recorded for that transaction will be deducted from your Profit and Loss reports. Also, your offers will (by default) remove any affiliate payout given to the affiliate for that conversion.

A transaction may only be voided if you can supply the orderid of the transaction. This means that your system must create a unique orderid when a conversion occurs and the pixel for this conversion must contain the orderid.

==Enabling Void Posts==
Before voids can be posted to your network, you must first enable this feature in the Misc section of the [[Configuration Admin]] by checking the setting named "Allow Remote Void Posts".

==Posting a Void Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to void.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being voided.
*'''type''' - (optional) This is an optional parameter for recording voids. (Can be sent as either "void" or you can omit this parameter.)
*'''approved''' - (optional) If you want to void a pending transaction that has been approved, pass in the "orderid" of the pending transaction and set this parameter to "1".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
===Example===
<pre>http://yourdomain.offerit.com/signup/process_void.php?orderid=12345</pre>

==Posting a Chargeback Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to chargeback.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being charged back.
*'''type''' - 'chargeback' This is a required parameter for recording chargebacks. (This must be set to "chargeback".)
*'''cost''' - (optional) This is an optional parameter that can be set to add a transaction fee for processing the chargeback. By default, this fee will be deducted from the referring affiliate's payout. For example, If you want the chargeback fee to be $25.00, you would set this parameter to "25.00".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.

===Examples===
<pre>http://demo.offerit.com/signup/process_void.php?orderid=12345&type=chargeback&cost=25.00</pre>
<pre>http://demo.offerit.com/signup/process_void.php?click_hash=45a552e2b7ea632.76210061</pre>

==Reversing a Void or Chargeback Transaction==

Parameters:
*'''reverse''' - This parameter is required to reverse a void/chargeback transaction and must be set to 1.

==Security==
To protect your system and prevent fraudulent transactions from being recorded, you can restrict which IP addresses can send posts to process_void.php. To do this, edit the landing page of the offer you are trying to restrict postbacks for, then enter the comma-separated list of IP addresses in the field named "Secure Landing Page Void IPs".

===Example===
11.22.33.44,55.66.77.88

Void Conversions Remotely

2020-06-23T22:41:49Z

OfferitRob: /* Posting a Chargeback Transaction */

{{Offerit Manual
| show_misc_section = true
}}

You can void any conversion recorded remotely by sending a post to the process_void.php script. This will allow you to automate voiding transactions in your system so you don't have to manually void customer transactions in the Customers Admin. (

When a void is recorded for a transaction the amount of revenue recorded for that transaction will be deducted from your Profit and Loss reports. Also, your offers will (by default) remove any affiliate payout given to the affiliate for that conversion.

A transaction may only be voided if you can supply the orderid of the transaction. This means that your system must create a unique orderid when a conversion occurs and the pixel for this conversion must contain the orderid.

==Enabling Void Posts==
Before voids can be posted to your network, you must first enable this feature in the Misc section of the [[Configuration Admin]] by checking the setting named "Allow Remote Void Posts".

==Posting a Void Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to void.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being voided.
*'''type''' - (optional) This is an optional parameter for recording voids. (Can be sent as either "void" or you can omit this parameter.)
*'''approved''' - (optional) If you want to void a pending transaction that has been approved, pass in the "orderid" of the pending transaction and set this parameter to "1".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
===Example===
<pre>http://yourdomain.offerit.com/signup/process_void.php?orderid=12345</pre>

==Posting a Chargeback Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to chargeback.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being charged back.
*'''type''' - (optional) This is a required parameter for recording chargebacks. (This must be set to "chargeback".)
*'''cost''' - (optional) This is an optional parameter that can be set to add a transaction fee for processing the chargeback. By default, this fee will be deducted from the referring affiliate's payout. For example, If you want the chargeback fee to be $25.00, you would set this parameter to "25.00".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.

===Examples===
<pre>http://demo.offerit.com/signup/process_void.php?orderid=12345&type=chargeback&cost=25.00</pre>
<pre>http://demo.offerit.com/signup/process_void.php?click_hash=45a552e2b7ea632.76210061</pre>

==Reversing a Void or Chargeback Transaction==

Parameters:
*'''reverse''' - This parameter is required to reverse a void/chargeback transaction and must be set to 1.

==Security==
To protect your system and prevent fraudulent transactions from being recorded, you can restrict which IP addresses can send posts to process_void.php. To do this, edit the landing page of the offer you are trying to restrict postbacks for, then enter the comma-separated list of IP addresses in the field named "Secure Landing Page Void IPs".

===Example===
11.22.33.44,55.66.77.88

Void Conversions Remotely

2020-06-23T22:40:17Z

OfferitRob: /* Posting a Void Transaction */

{{Offerit Manual
| show_misc_section = true
}}

You can void any conversion recorded remotely by sending a post to the process_void.php script. This will allow you to automate voiding transactions in your system so you don't have to manually void customer transactions in the Customers Admin. (

When a void is recorded for a transaction the amount of revenue recorded for that transaction will be deducted from your Profit and Loss reports. Also, your offers will (by default) remove any affiliate payout given to the affiliate for that conversion.

A transaction may only be voided if you can supply the orderid of the transaction. This means that your system must create a unique orderid when a conversion occurs and the pixel for this conversion must contain the orderid.

==Enabling Void Posts==
Before voids can be posted to your network, you must first enable this feature in the Misc section of the [[Configuration Admin]] by checking the setting named "Allow Remote Void Posts".

==Posting a Void Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to void.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being voided.
*'''type''' - (optional) This is an optional parameter for recording voids. (Can be sent as either "void" or you can omit this parameter.)
*'''approved''' - (optional) If you want to void a pending transaction that has been approved, pass in the "orderid" of the pending transaction and set this parameter to "1".
*'''trans_custom1''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom2''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom3''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom4''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
*'''trans_custom5''' - (optional) This is an optional parameter to record a custom value with a transaction. -1 is a reserved value and should not be used.
===Example===
<pre>http://yourdomain.offerit.com/signup/process_void.php?orderid=12345</pre>

==Posting a Chargeback Transaction==

Parameters:
*'''orderid''' - The orderid of the conversion/transaction you are trying to chargeback.
*'''click_hash/transaction_hash''' - (optional) The click_hash/transaction_hash of the transaction being charged back.
*'''type''' - (optional) This is a required parameter for recording chargebacks. (This must be set to "chargeback".)
*'''cost''' - (optional) This is an optional parameter that can be set to add a transaction fee for processing the chargeback. By default, this fee will be deducted from the referring affiliate's payout. For example, If you want the chargeback fee to be $25.00, you would set this parameter to "25.00".

===Examples===
<pre>http://demo.offerit.com/signup/process_void.php?orderid=12345&type=chargeback&cost=25.00</pre>
<pre>http://demo.offerit.com/signup/process_void.php?click_hash=45a552e2b7ea632.76210061</pre>

==Reversing a Void or Chargeback Transaction==

Parameters:
*'''reverse''' - This parameter is required to reverse a void/chargeback transaction and must be set to 1.

==Security==
To protect your system and prevent fraudulent transactions from being recorded, you can restrict which IP addresses can send posts to process_void.php. To do this, edit the landing page of the offer you are trying to restrict postbacks for, then enter the comma-separated list of IP addresses in the field named "Secure Landing Page Void IPs".

===Example===
11.22.33.44,55.66.77.88

Offerit REST API Process Reversal

2020-06-23T22:28:14Z

OfferitRob: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST transaction/process_reversal''' ==
'''Description'''
This REST API resource to used to issue a reversal for a transaction that was previously voided/chargedback

'''Resource URL'''
*<nowiki>http://domain/api/transaction/process_reversal</nowiki>
*Replace domain with your Offerit network domain

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

'''Response Format'''
*JSON

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

== '''Parameters''' ==
*'''reverse''': ''This is a flag to trigger the reversal.''
**'''''type: bool'''''
**'''''required'''''

*'''transaction_hash''': ''The click_hash/transaction_hash of the transaction you want to reverse.''
**'''''type: string'''''
**'''''optional'''''

*'''click_hash''': ''The click_hash/transaction_hash of the transaction you want to reverse.''
**'''''type: string'''''
**'''''optional'''''

*'''orderid''': ''The transaction identifier sent on conversion (orderid) you want to reverse.''
**'''''type: string'''''
**'''''optional'''''

*'''transactionid''': ''The Offerit generated transaction identifier you want to reverse''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom1 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom2 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom3 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom4 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom5 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

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

'''POST'''

<nowiki>http://domain.com/api/transaction/process_reversal</nowiki>

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

Failure
{
"result": "error",
"message": "Missing required flag (reverse)."
}
</pre>

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

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

$data = array(
'reverse' => TRUE,
'transaction_hash' => '156097c947ece92.38318951',
);
$url = 'http://domain/api/transaction/process_reversal';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
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 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 Process Void

2020-06-23T20:44:40Z

OfferitRob: /* Parameters */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST transaction/process_void''' ==
'''Description'''
*This REST API resource is used to void a transaction that was previously converted

'''Resource URL'''
*<nowiki>http://domain/api/transaction/process_void</nowiki>
*Replace domain with your Offerit network domain

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

'''Response Format'''
*JSON

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

== '''Parameters''' ==
*'''type''': ''This should always be set as void''
**'''''type: string'''''
**'''''required'''''

*'''transaction_hash''': ''The click_hash/transaction_hash of the transaction you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''click_hash''': ''The click_hash/transaction_hash of the transaction you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''orderid''': ''The transaction identifier sent on conversion (orderid) you want voided.''
**'''''type: string'''''
**'''''optional'''''

*'''transactionid''': ''The Offerit generated transaction identifier you want voided''
**'''''type: string'''''
**'''''optional'''''

*'''approved''': ''Used in setups with pending conversions so the initial transaction identifier can be sent to void the associated approval''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom1 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom2 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom3 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom4 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

*'''trans_custom5 ''': ''custom value to record with a transaction. -1 is a reserved value and should not be used.''
**'''''type: string'''''
**'''''optional'''''

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

'''POST'''

<nowiki>http://domain.com/api/transaction/process_void</nowiki>

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

Failure
{
"result": "error",
"message": "*error* - Void transaction exists."
}
</pre>

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

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

$data = array(
'type' => 'void',
'transaction_hash' => '156097c947ece92.38318951',
);
$url = 'http://domain/api/transaction/process_void';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_POST, 1);
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 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 Postback Examples

2020-04-16T21:47:09Z

OfferitRob:

{{Offerit Manual|show_setup_section=true}}
= Event Postbacks =
Offerit uses the 'process_pixel.php' script to record events. Below are the examples of different events you may need to send postbacks for, and what parameters are required to record each event type in Offerit.

== Conversion Postback ==
The first transaction for a customer is considered a "conversion". For conversions, the only required field is the 'click_hash' which was generated for a surfer when they went through one of our tracking links:
<pre>http://example.offerit.com/signup/process_pixel.php?click_hash={CLICK_HASH}</pre>

'''Although sending just click_hash will work for recording a conversion event, here are some optional parameters that are commonly sent:'''
*'' subscription_id ''- the Subscription ID is generally a unique customer identifier from your system. Sending a subscription_id allows you to tie future events to the same cusotmer record
*'' amount ''- This parameter is the amount of revenue your network made for the event. It will override the "Conversion Amount" defined on the offer. This allows you to record transactions for any amount rather than just the default amount for the offer. This value should be sent in the base currency for your network. The default is USD, but you can check your network's default in the Config Admin -> Currency - All page. This value should also be in decimal format. For example, if a transaction amount is $9.95, the amount should be sent as "&amount=9.95"

== Continuity Postback ==
Any transaction for a customer after the initial conversion is considered a "continuity". (Ex: Recurring Subscriptions may have periodic continuity transactions sent)
<pre>http://example.offerit.com/signup/process_pixel.php?subscription_id={USER_ID}&orderid={TRANSACTION_ID}</pre>

For continuities, you must send at minimum the subscription_id (same as from conversion postback), and the orderid:
*'' subscription_id ''- the Subscription ID is generally a unique customer identifier from your system. Sending a subscription_id allows you to tie future events to the same cusotmer record
*'' orderid ''- The Order ID is generally a unique identifier for the transaction from your system. Sending us an identifier for your transactions helps us to ensure that if you accidentally send the same transaction postback multiple times, we will only record it once. It also helps with advertiser communication to find and reference transactions if disputes arise.

== Goal Postback ==
For flexibility, Offerit allows you to define your own custom events called "Goals". A common example that is added as a goal is a free registration or signup. When setting up a new Goal, you will be asked to define a "Goal Slug" (ex: freereg). This is slug is what you add to your postbacks to indicate that it is not a normal conversion event, but rather a custom event:
<pre>http://example.offerit.com/signup/process_pixel.php?click_hash={CLICK_HASH}&subscription_id={USER_ID}&goal_slug={GOAL_SLUG}</pre>

Goal postbacks require the following fields:
*'' click_hash '' - This is the same click_hash generated for a surfer when they go through our tracking links. This field is only required if this is the first postback being sent for the customer (before conversion)
*'' subscription_id '' - If this is the first post for the customer, this field will set the customer's ID from your system in Offerit so it can be used for future postbacks instead of click_hash. If this is a follow up post, this will be used to look up the existing customer to insert the Goal transaction in the same customer record.
*'' goal_slug '' - This is the "Goal Slug" defined when adding a new Goal. You can look up your existing goal slugs from the Offers Admin -> Manage Goals page. This indicates what type of transaction you are trying to report.
*'' orderid '' - This field is only required if this is NOT the first postback being sent for the customer (no click_hash). The Order ID is generally a unique identifier for the transaction from your system. Sending us an identifier for your transactions helps us to ensure that if you accidentally send the same transaction postback multiple times, we will only record it once. It also helps with advertiser communication to find and reference transactions if disputes arise.

You can optionally ask us to enable a setting which will require "orderid" for cases where the goal postback is the first postback for a customer.

= Optional Parameters =
The following paremeters can also be sent in your postbacks to be recorded with the customer record:
*'' amount ''- This parameter is the amount of revenue your network made for the event. If the amount for a transaction doesn't match what's defined as the default amount for the event on the offer, you can send this parameter to set the proper transaction amount to be recorded. This value should be sent in the base currency for your network. The default is USD, but you can check your network's default in the Config Admin -> Currency - All page. This value should also be in decimal format. For example, if a transaction amount is $9.95, the amount should be sent as "&amount=9.95". If you have default amounts set on the offer, and you want a $0 transaction, you must pass amount as "zero".
*'' currency ''- This paremeter defines the currency that the "amount" parameter is sent in. The possible 3 letter currency values are listed on the Config Admin -> Currency - All page. This page is also where you would need to manually maintain conversion rates for your install. When Offerit receives a transaction in a currency that is not your base currency, it will automatically convert the amount to the equivalent amount in your base currency for reporting.
*'' username ''
*'' password ''
*'' email ''
*'' ip ''
*'' firstname ''
*'' lastname ''
*'' address1 ''
*'' address2 ''
*'' zip ''
*'' city ''
*'' state ''
*'' country ''
*'' shipping_firstname ''
*'' shipping_lastname ''
*'' shipping_address1 ''
*'' shipping_address2 ''
*'' shipping_zip ''
*'' shipping_city ''
*'' shipping_state ''
*'' shipping_country ''
*'' phone ''
*'' custom1 '' - custom value to record with a customer
*'' custom2 ''
*'' custom3 ''
*'' custom4 ''
*'' custom5 ''
*'' trans_custom1 '' - custom value to record with a transaction. -1 is a reserved value and should not be used.
*'' trans_custom2 ''
*'' trans_custom3 ''
*'' trans_custom4 ''
*'' trans_custom5 ''
''' If you send postbacks with different personal data for the same customer, Offerit will take the latest information sent and update the customer record in question. '''

Template:Offerit Manual

2019-05-02T15:14:02Z

OfferitRob:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| 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]]
|-

| [[Affiliate Custom Signup]]
|-
| [[Offeritcode]]
|-
| [[Tracking in Offerit]]
|-
| [[Offerit Logos]]
|-
| [[Void Conversions Remotely]]
|-
|}
<hr />


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

Rewards Admin

2019-05-02T15:13:25Z

OfferitRob: Protected "Rewards Admin" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

{{Offerit Manual
| show_misc_section = true
}}

__TOC__

The Rewards Admin in Offerit allows you to create and manage rewards to use as additional incentives for your affiliates. You may access the rewards admin by going to the [[Offerit Configuration Admin|configurations admin]] and selecting ''Manage Rewards'' from the sidebar.

[[File:Admin Configuration Admin.png]]

== Creating a Rewards Category ==
Before you can add a reward in the Rewards Admin, first you must create a Rewards Category. To do this, enter a category name of your choosing in the field labeled, "New Rewards Category" and click "Add". This will create a category that you may then select from the "Choose Category" drop down menu.

[[File:reward_category.png|650px|||Rewards Admin Add Category]]

== Adding a Reward to a Category==

Once at least one rewards category is set up, you may start adding rewards from which your affiliates can choose.

[[File:create_reward.png|700px|||Rewards Admin Add Reward]]

For each reward, you can set the following:

*'''Name''' - The name of the reward you are offering to the affiliate.
*'''Cost''' - The amount of reward points that are required for the affiliate to purchase this reward.
*'''URL''' - A link to a page containing details about the reward.
*'''Thumbnail''' - Allows you to upload a thumbnail image to display for this reward.
*'''Description ''' - A description of the reward being offered.

== Setting up Points ==
In order for affiliates to accumulate reward points, you must set up a way for affiliates to earn these points. By clicking the "Points" tab under the Rewards Admin in the left navigation, you can set up a way for affiliates to accumulate traffic across all Offers by configuring the "Default Points" values. Points can be awarded based on page views, unique visitors, initial sales, continuity and refunds. If you would like to remove points from the affiliate for any of these things, set the point value to be negative. Additionally, you can add point changes in this section, allowing you to change the amount of points rewarded for particular actions based on the offer and the affiliate.

[[File:reward_nav_points.png|175px|||Rewards Admin Navigation Points]]
[[File:reward_points.png|850px|||Rewards Admin Configure Points]]

== Purchasing Rewards as an Affiliate ==
Affiliates can view their bonus points accumulated in the "My Account" section of the affiliate area once they have accumulated at least 1 reward point. Next, they can purchase rewards by clicking on the "Bonus Rewards" link in the Navigation section. Once an affiliate has accumulated bonus points they will

[[File:affiliate_nav_bonus.png|200px|||Affiliate Navigation Bonus]]
[[File:purchase.png|850px|||Affiliate Purchase Rewards]]

Once an affiliate has purchased a reward, they will prompted to enter details regarding shipping information for that reward:

[[File:purchase_details.png|850px|||Affiliate Purchase Details]]

== Sending out Purchased Rewards ==
Once an affiliate purchases a reward, the cost of the reward will be deducted from their total bonus points and the reward will be listed in the "Unshipped" section of the Rewards Admin. By clicking on the "Unshipped" link beneath the Rewards Admin you can manage the shipping details of the reward for the affiliate and mark the reward as shipped by clicking the "Mark as Shipped" action icon or return the reward points to the affiliate by clicking the "Return Reward Order" icon.

[[File:rewards_unshipped.png|850px|||Rewards Admin Unshipped]]

Once marked as shipped, the reward will be listed in the "Shipped" section of the rewards Admin. This section contains details about the date the reward was purchased and shipped and you can also mark the reward as not shipped by clicking "Mark as Unshipped".

Tracking Domain

2019-04-12T17:18:37Z

OfferitRob:

{{Offerit Manual
| show_setup_section = true
| show_offers_admin_section = true
}}

Your tracking domain is a custom domain used for the affiliate links (to promote your offers). [[Linkcode]]s for your affiliates will appear in the following form:

<nowiki>http://<tracking domain>/track/<</nowiki>[[Offeritcode|offeritcode]]>

By default, your offerit domain will be ''[YourCompanyName.offerit.com]''. However, you can add as many custom domains as you'd like.

To add a tracking domain to Offerit, first navigate to the [[Offerit Offers Admin|The Offers Admin]], then click "''Tracking Domains''" on the left side of the screen. There are three requirements needed to create a new tracking domain:

[[File:AddNewTrackingDomain.png|900px|Adding a new tracking domain]]

* '''Domain Name''' – The name (URL) you would like to use for this particular domain. This can be a custom domain as long as it points to the domain of your Offerit Install.
**Point the DNS for your domain, using a CNAME record, at your Offerit domain. For example, if your tracking domain is ''track.example.com'' and your Offerit domain is ''example.offerit.com'', you would create the following CNAME record in your DNS configuration:
<pre>
track.example.com CNAME example.offerit.com
</pre>
If you need help with this, please [http://support.offerit.com submit a ticket] and we will be happy to assist you.
* '''Hide Affiliate Area (Redirect)''' – The URL you would like to use to redirect away from the affiliate area. Leave this blank if you do not want to hide the affiliate area.
* '''Hide Affiliate Area (Template)''' – Choose whether or not to hide the affiliate area by showing an alternate template.

The "Hide Affiliate Area" settings can later be altered by clicking on the “Edit Tracking Domain” action icon. When you have finished entering your tracking domain, click "Add". Once you have set up a Tracking Domain, you will be able to select it to be used for an offer's tracking links when configuring your landing pages.

[[Category:Offerit Affiliate Information]]

Tracking Domain

2019-04-12T17:18:01Z

OfferitRob:

{{Offerit Manual
| show_setup_section = true
| show_offers_admin_section = true
}}

Your tracking domain is used for the affiliate linkcodes to promote your offers. [[Linkcode]]s for your affiliates will appear in the following form:

<nowiki>http://<tracking domain>/track/<</nowiki>[[Offeritcode|offeritcode]]>

By default, your offerit domain will be ''[YourCompanyName.offerit.com]''. However, you can add as many custom domains as you'd like.

To add a tracking domain to Offerit, first navigate to the [[Offerit Offers Admin|The Offers Admin]], then click "''Tracking Domains''" on the left side of the screen. There are three requirements needed to create a new tracking domain:

[[File:AddNewTrackingDomain.png|900px|Adding a new tracking domain]]

* '''Domain Name''' – The name (URL) you would like to use for this particular domain. This can be a custom domain as long as it points to the domain of your Offerit Install.
**Point the DNS for your domain, using a CNAME record, at your Offerit domain. For example, if your tracking domain is ''track.example.com'' and your Offerit domain is ''example.offerit.com'', you would create the following CNAME record in your DNS configuration:
<pre>
track.example.com CNAME example.offerit.com
</pre>
If you need help with this, please [http://support.offerit.com submit a ticket] and we will be happy to assist you.
* '''Hide Affiliate Area (Redirect)''' – The URL you would like to use to redirect away from the affiliate area. Leave this blank if you do not want to hide the affiliate area.
* '''Hide Affiliate Area (Template)''' – Choose whether or not to hide the affiliate area by showing an alternate template.

The "Hide Affiliate Area" settings can later be altered by clicking on the “Edit Tracking Domain” action icon. When you have finished entering your tracking domain, click "Add". Once you have set up a Tracking Domain, you will be able to select it to be used for an offer's tracking links when configuring your landing pages.

[[Category:Offerit Affiliate Information]]

Offerit REST API Get Conversion Caps

2019-03-15T19:30:52Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_conversion_caps''' ==
'''Description'''
*Offerit supports an API resource to get a list of configured conversion caps.

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_conversion_caps</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''' ==

'''''Parameters can be sent as url encoded params. All parameters are optional so if none are entered, all enabled conversion caps will be returned.''.'''

*offerid
**'''''type: integer'''''
**'''''optional'''''

*loginid
**'''''type: string'''''
**'''''allowed values: all/each/loginid'''''
**'''''optional'''''

*enabled
**'''''type: integer'''''
**'''''allowed values: 0/1'''''
**'''''optional'''''

*deleted
**'''''type: integer'''''
**'''''allowed values: 0/1'''''
**'''''default: 0'''''
**'''''optional'''''

*type
**'''''type: string'''''
**'''''allowed values: Conversions/Dollars/Registrations/Unique Clicks/Clicks/Net Conversions'''''
**'''''optional'''''

*duration
**'''''type: string'''''
**'''''allowed values: Day, Week, Month, Year, All Time, Hour'''''
**'''''optional'''''

*timeframe_restriction
**'''''type: string'''''
**'''''allowed values: None/Weekdays/Weekends/Saturday/Sunday/Monday/Tuesday/Wednesday/Thursday/Friday'''''
**'''''optional'''''

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

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

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

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_conversion_caps?'.$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 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>

*Response:
<pre>
{
"result": "success",
"message": "Caps found.",
"data": [
{
"cap_redirect_id": "1",
"offerid": "2",
"loginid": "each",
"new_offerid": "5",
"new_landing_pageid": "6",
"track": "0",
"type": "5",
"value": "2",
"deleted": "0",
"enabled": "1",
"duration": "0",
"start": "1551296102",
"end": "0",
"timeframe_restriction": "0",
"advertiserid": "all",
"redirect_action": "landing_page",
"admin_notify": "0",
"start_nice": "2019/02/27 14:35:02",
"end_nice": "Never",
"type_nice": "Net Conversions",
"duration_nice": "Day",
"timeframe_restriction_nice": "None"
},
{
"cap_redirect_id": "2",
"offerid": "all",
"loginid": "all",
"track": "0",
"type": "0",
"value": "1",
"deleted": "0",
"enabled": "1",
"duration": "0",
"start": "1552422904",
"end": "0",
"timeframe_restriction": "0",
"advertiserid": "all",
"redirect_action": "none",
"admin_notify": "0",
"start_nice": "2019/03/12 16:35:04",
"end_nice": "Never",
"type_nice": "Conversions",
"duration_nice": "Day",
"timeframe_restriction_nice": "None"
}
]
}
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Get Conversion Caps

2019-03-15T19:29:54Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /offer/get_conversion_caps''' == '''Description''' *Offerit supports an API resource to get a list of configured..."

{{Offerit Manual
| show_rest_api_section = true
}}

== '''GET /offer/get_conversion_caps''' ==
'''Description'''
*Offerit supports an API resource to get a list of configured conversion caps.

'''Resource URL'''
*<nowiki>http://domain/api/offer/get_conversion_caps</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''' ==

'''''Parameters can be sent as url encoded params. All parameters are optional so if none are entered, all enabled conversion caps will be returned.''.'''

*offerid
**'''''type: integer'''''
**'''''optional'''''

*loginid
**'''''type: string'''''
**'''''allowed values: all/each/loginid'''''
**'''''optional'''''

*enabled
**'''''type: integer'''''
**'''''allowed values: 0/1'''''
**'''''optional'''''

*deleted
**'''''type: integer'''''
**'''''allowed values: 0/1'''''
**'''''default: 0'''''
**'''''optional'''''

*type
**'''''type: string'''''
**'''''allowed values: Conversions/Dollars/Registrations/Unique Clicks/Clicks/Net Conversions'''''
**'''''optional'''''

*duration
**'''''type: string'''''
**'''''allowed values: Day, Week, Month, Year, All Time, Hour'''''
**'''''optional'''''

*timeframe_restriction
**'''''type: string'''''
**'''''allowed values: None/Weekdays/Weekends/Saturday/Sunday/Monday/Tuesday/Wednesday/Thursday/Friday'''''
**'''''optional'''''

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

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

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

$data_string = http_build_query($data);
$url = 'http://domain/api/offer/get_conversion_caps?'.$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 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>

*Response:
<pre>
{
"result": "success",
"message": "Caps found.",
"data": [ {
"cap_redirect_id": "2",
"offerid": "all",
"loginid": "all",
"track": "0",
"type": "0",
"value": "1",
"deleted": "0",
"enabled": "1",
"duration": "0",
"start": "1552422904",
"end": "0",
"timeframe_restriction": "0",
"advertiserid": "all",
"redirect_action": "none",
"admin_notify": "0",
"start_nice": "2019/03/12 16:35:04",
"end_nice": "Never",
"type_nice": "Conversions",
"duration_nice": "Day",
"timeframe_restriction_nice": "None"
}]
}
</pre>

[[Category:Offerit API Articles]]

Template:Offerit Manual

2019-03-15T16:53:10Z

OfferitRob:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| 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>

Template:Offerit Manual

2019-03-15T16:52:23Z

OfferitRob:

{| class="offeritnavbox"
! [[Offerit|Offerit]]
{| 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 Get Conversion Caps|GET /offer/get_conversion_caps]
*}
|-
| [[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 Logos

2019-01-09T17:45:27Z

OfferitRob:

* Logo, with Attribution Simplified
** High Res, EPS: http://offerit.com/images/offerit-logo-large-attr-simp.eps
** High Res, PDF: http://offerit.com/images/offerit-logo-large-attr-simp.pdf



*Full-Sized Logos:
** [[Media:Offerit 2000x788.jpg]](full-ize JPEG)
** [[Media:Offerit transparent 2000x788.png]] (full-size PNG, transparent background)

*JPEGs with tagline:
**[[Media:Offerit 300x120.jpg]]
**[[Media:Offerit 300x100.jpg]]

*JPEGs without tagline:
**[[Media:Offerit alt 300x120.jpg]]
**[[Media:Offerit alt 300x100.jpg]]
**[[Media:Offerit alt 96x96.jpg]]

*PNGs with tagline (transparent background):
**[[Media:Offerit transparent 300x120.png]]
**[[Media:Offerit transparent 300x100.png]]

*PNGs without tagline (transparent background):
**[[Media:Offerit transparent alt 300x120.png]]
**[[Media:Offerit transparent alt 300x100.png]]
**[[Media:Offerit transparent alt 96x96.png]]

File:Offerit test.png

2019-01-09T17:28:40Z

OfferitRob: