Custom Integrations - Using Device Tracker Documentation

This API allows you to request a new device tracker URL for your users so that they or you can embed a JavaScript fraud tracker into their domain.

Calling Request Token

https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/generate_device_tracker

Request Parameters

Parameter	Description	Example Value / Format
key	Your site's domain or the domain that requested this integration. REQUIRED	google.com
secret	Your user's current secret created during the authentication process. REQUIRED	char(128)
domain	The domain this JavaScript/pixel will be placed on. If this parameter is not passed the domain will default to your key.	varchar(256)

Result

Note: Only JSON responses are available from this API and this API should ONLY be called server side for security reasons.

The result of this API will provide you with both the tracking JavaScript link and the pixel link. It is possible to use both provided the pixel is wrapped in a noscript tag.

Parameter	Description	Example Value / Format
message	Description of the status of this call. May contain errors if errors exist.	text
success	Boolean result of if the request was successful or not.	boolean
domain	The domain which these URLs can be used on.	varchar(256)
tracker	The unique authentication key for these tracker links. This can also be found in the URLs below.	char(256)
script_url	The URL to the device tracking JavaScript without the script open/closing tags.	string
pixel_url	The URL to the device tracking pixel without the img open/closing tags.	string

Example Code


// URL for this request.
$URL = 'https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/generate_device_tracker';
	
// Configuration items for this request. NOTE: $secret will be user specific not application specific.
$key = 'example.com';
$secret = 'WkYwHzjeWMqGBuJKBA98Ko63arm3Cd6n3gwfucxaldFPyflJQ4X4oYmaHZmEudy7RGzF3v7I8GCVvaPpCBbsJD17XdGWYSunc8dmpvbxkH6QlcT5SxuH2pmt2Dhu4cDM';

// The domain where these tracking links will be used on.
$domain = 'google.com';
	
// Prepare POST fields.
$fields = array(
	'secret' => $secret,
	'key' => $key,
	'domain' => $domain
);
	
// Create CURL.
$curl = curl_init();
	
// Configure CURL
curl_setopt($curl, CURLOPT_URL, $URL);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_POST, 1);

// Set POST Parameters
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($fields));

// Fetch URL
$result = curl_exec($curl);

// GET response code.
$response_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);

// Close CURL
curl_close($curl);
	
// Handle result.
if((int) $response_code === 200){
	// JSON Decode
	$output = json_decode($result, true);
	
	// Was the request successful?
	if($output['success'] === true){
		echo '<script src="'.$output["script_url"].'"></script><noscript><img src="'.$output["pixel_url"].'" /></script>';
	} else {
		echo "Unable to generate tracking links.";
	}
} else {
	echo "There appears to be an unforeseen error. Please contact IPQualityScore support if this persists.";
}