Send a test request

GET

ping

Ping the API

Response example:

  • Status code: 200 OK

{
"success": true
}

  • Status code: 401 Unauthorized

{
"success": false,
"message": "Invalid API key"
}

Code example:

<?php 
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '.../ping', //replace ... with the whole API URL
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'x-api-key: YOUR-API-KEY' //replace with your generated api key
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Did this answer your question?