Overview#
Authentication is required to access the partners API. Clients must include the correct API key and API secret in the request headers for each API call.Obtaining API Credentials#
To access the API, you must retrieve your API key and secret from the Partners Platform API Security page.3.
Generate or retrieve your API Key and API Secret.
4.
Use these credentials in your API requests as described below.
IP Whitelisting#
To ensure secure access, the API requires IP whitelisting. Only requests originating from approved IP addresses will be allowed.Configuring IP Whitelisting#
3.
Locate the IP Whitelisting configuration.
4.
Add the necessary IP addresses that should have access.
5.
Save the changes to apply the whitelist settings.
x-api-key: The API key assigned to your application.
x-api-secret: The API secret associated with your API key.
x-api-key: CEDAR_DEV_api_key_cc77406f-06e1-4f83-a5f3-def6128e4ce2
x-api-secret: CEDAR_DEV_api_secret_RvDAeLtIF9kik17sds0TYEnPLlhvHjBDZ6yutIgK52BvQj5aR1caA7HF6Vzk9JD6sJHb8Tl9I6WzWdgwiIi5TC8cYgD4yydBIQy4
Example Request#
A sample cURL request demonstrating authentication:Authentication Failure Responses#
If authentication fails due to missing or incorrect credentials, the API will return an appropriate HTTP status code and error message.400 Bad Request: Missing or invalid API key/secret.
403 Forbidden: Authentication succeeded but access to the resource is denied.
{
"exception":{
"errorCode":"API_KEY_MISSING",
"message":"API key missing"
}
}
Security Recommendations#
Keep your API key and secret confidential.
Rotate credentials periodically for security. Rotating credentials is available at the partners platform.
Use HTTPS to encrypt API requests and responses.
Modified at 2025-03-02 13:55:29
