All requests to the API must include a valid API key.
To authenticate requests to the API, you will need to generate an API Key and Secret Key from your Intend system.
Step 1: Create an Application
Navigate To: Settings > Integration & System > Access Keys
Create a new application to enable API access.
Step 2: Generate API Keys
After creating your application, click Generate API Keys.
A popup will appear where you can:
Once confirmed, your API Key and Secret Key will be available for use.
Step 3: Use Your Keys
After generating your keys, you can use them to authenticate and make requests to the API.
Pass the following headers with every request:
api-key: Your generated API Key.timestamp: Current timestamp.signature: A request signature generated using your Secrect Key.
Include the API key in the request header with the parameter name api-key:
//replace BASEURL and ENDPOINT
$testApiUrl = 'https://{BASEURL}/api/{ENDPOINT}';
$apiKey = 'a0761d825272c0a394e80f6cfc48bf9a';
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $testApiUrl);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
'Accept: application/json',
'api-key: ' . $apiKey,
'timestamp: ' . $timestamp,
'signature: ' . $signature,
]);
$response = curl_exec($curl);
if ($response === false) {
die('cURL Error: ' . curl_error($curl));
}
curl_close($curl);
echo $response;
If the API key is missing or invalid, the API will return a 401 error.
Every API response will contain a status field indicating the result of the request:
Every API response will contain a status field indicating the result of the request:
| Status Code | Meaning |
|---|---|
| 200 | Request successful |
| 401 | Bad request / Authentication failed |
| 404 | Endpoint not found |
| 500 | Internal server error |
When retrieving lists of data, results are paginated with a maximum of 50 records per request. Pagination parameters can be passed using:
/api/clients/get?page=2