Offerit REST API Get Global Void Ips - Revision history

OfferitRob at 20:37, 22 July 2022

2022-07-22T20:37:59Z

OfferitRob at 18:10, 22 July 2022

2022-07-22T18:10:38Z

OfferitRob at 18:09, 22 July 2022

2022-07-22T18:09:45Z

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..."

2022-07-22T18:08:39Z

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..."

New page

{{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]]

← Older revision		Revision as of 18:10, 22 July 2022
Line 73:		Line 73:

	payload = {}		payload = {}
−

	headers = {		headers = {

@@ Line 4: / Line 4: @@
 == '''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
+*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
+*Replace domain with the Offerit domain
 '''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]