Custom Integrations - Refresh Secret Authentication Tokens Documentation

You can request a fresh API secret for a given user by calling the refresh API. This will generate and return a new API secret which you can use to make future requests. It is encouraged that you refresh periodically or whenever you have reason to believe your user's API secret is compromised.

Calling Refresh

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

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.

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
secret	The user's new secret created by this request and used for all future authentication.	char(128)

Example Code


// URL for this request.
$URL = 'https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/refresh';

// 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);
	
	// Store new secret.
	// $output['secret'];
} else {
	echo "There appears to be an unforeseen error. Please contact IPQualityScore support if this persists.";
}