Custom Integrations - Login Tokens Documentation

This API allows your service to generate links that allow a user to automatically login to their IPQualityScore account. NOTE: Your application must be approved to access this functionality and users will be notified that your service can login to their account.

Calling Request Token

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

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)

Result

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

The token provided from this API is a one time use token to log a user into their IPQualityScore account. To use it you must redirect the user to the URL below:

https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/token?token=TOKENHERE

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
token	A one time use token to login a user to their account.	char(128)

Example Code


// URL for this request.
$URL = 'https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/token';
	
// URL for where we'll send the user after the request is successful (and replace %s with the token we receive)
$redirect = 'Location: https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/token?token=%s';
	
// Configuration items for this request. NOTE: $secret will be user specific not application specific.
$key = 'example.com';
$secret = 'WkYwHzjeWMqGBuJKBA98Ko63arm3Cd6n3gwfucxaldFPyflJQ4X4oYmaHZmEudy7RGzF3v7I8GCVvaPpCBbsJD17XdGWYSunc8dmpvbxkH6QlcT5SxuH2pmt2Dhu4cDM';

// Prepare POST fields.
$fields = array(
	'secret' => $secret,
	'key' => $key
);
	
// 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){
		exit(header(sprintf($login_url, $output['token'])));
	} else {
		echo "Unable to log you in. Please check your request and try again.";
	}
} else {
	echo "There appears to be an unforeseen error. Please contact IPQualityScore support if this persists.";
}