The endpoint allows you to expire the quiz immediately (before expiry days). To identify a quiz url
(long/short) is required. A json object is required to be posted as raw body. See example request, response objects and authentication process. The full API URL is :
POST https://authified.com/api/v1/quiz/expire
Name | Type | Description |
---|---|---|
/url | string | A valid quiz "long_url" or "short_url" to expire - (required) |
{
"url": ""
}
{
"http_status_code": 200,
"query_reference_id": "",
"response_time": 0,
"query_at": "",
"tiny_url": "",
"long_url": "",
"expired": 0,
"expired_at": ""
}
curl --location --request POST 'https://authified.com/api/v1/quiz/expire' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Api-Key: ' \
--header 'Signature: ' \
--data-raw '{
"url": "",
}'
POST /api/v1/quiz/expire HTTP/1.1
Host: https://authified.com
Accept: application/json
Content-Type: application/json
Api-Key:
Signature:
Content-Length:
{
"url": "",
}
var settings = {
"url": "https://authified.com/api/v1/quiz/expire",
"method": "POST",
"timeout": 0,
"headers": {
"Accept": "application/json",
"Content-Type": "application/json",
"Api-Key": "",
"Signature": ""
},
"data": JSON.stringify({"url":""}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var data = JSON.stringify({"url":""});
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if(this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://authified.com/api/v1/quiz/expire");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Api-Key", "");
xhr.setRequestHeader("Signature", "");
xhr.send(data);
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://authified.com/api/v1/quiz/expire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS =>'{
"url": "",
}',
CURLOPT_HTTPHEADER => array(
"Accept: application/json",
"Content-Type: application/json",
"Api-Key: ",
"Signature: "
),
));
$response = curl_exec($curl);
$http_code = curl_getinfo($url, CURLINFO_HTTP_CODE);
curl_close($url);
if ($http_code === 200):
echo $response;
else:
echo "Un-expected server response http_code($http_code)<br/>$response";
endif;
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://authified.com/api/v1/quiz/expire');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Accept' => 'application/json',
'Content-Type' => 'application/json',
'Api-Key' => '',
'Signature' => ''
));
$request->setBody('{\n "url": ""}');
try {
$response = $request->send();
if ($response->getStatus() === 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}