Offeritnick at 21:32, 12 May 2017

2017-05-12T21:32:55Z

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /offer/add_tracking_domain''' == '''Description''' *add_tracking_domain adds a new tracking domain '''Resource..."

2017-05-11T23:54:35Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /offer/add_tracking_domain''' == '''Description''' *add_tracking_domain adds a new tracking domain '''Resource..."

New page

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

'''Resource URL'''
*<nowiki>http://domain/api/offer/add_tracking_domain</nowiki>
*Enable a new tracking domain for the network

'''Response Format'''
*JSON

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

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

== '''Parameters''' ==
*domain
**'''''type: string'''''
**'''''required'''
** domain including protocol. ex http://t.mydomain.com
*redirect_domain
**'''''type: string'''''
** url destination for non tracking requests. This prevents the affiliate portal from displaying on this domain.
*template_protect
**'''''type: Bool'''''
** if true, an error message will display instead of the affiliate portal for this domain.

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

'''POST'''
<pre>
<nowiki>http://domain/api/offer/add_tracking_domain
domain=https://t.mydomain.com
template_protect=TRUE
</nowiki>
</pre>

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

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

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

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

$data = Array(
'domain' => 'https://t.mydomain.com',
'template_protect' => TRUE,

);

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
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

@@ Line 78: / Line 78: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);

Offerit REST API Add Tracking Domain - Revision history

Offeritnick at 21:32, 12 May 2017

Offeritnick: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /offer/add_tracking_domain''' == '''Description''' *add_tracking_domain adds a new tracking domain '''Resource..."