Test api key
Get /settings/apikeys/{id}/test
URL parameters:
| Name | Description | Type |
|---|---|---|
| id | API key Id | String |
Response:
| Name | Description | Type |
|---|---|---|
| status | success / failure | String |
Programming language:
Response exemple:
{
"status": "success"
}
Code example:
curl -X GET -H "Content-Type: application/json" -H "X-Tipimail-ApiUser:YOUR_SMTP_USERNAME" -H "X-Tipimail-ApiKey:YOUR_SMTP_KEY" https://api.tipimail.com/v1/settings/apikeys/64d5ze654ze6f54ezf87fe58/test
require 'vendor/autoload.php';
$tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY');
try {
$tipimail->getSettingsService()->getApiKeysService()->test('646r54g6r4gr6g46g46546d4');
}
catch(Tipimail\Exceptions\TipimailException $e) {
echo 'Exception received :', $e->getMessage(), "\n";
}