Api Keys

Application Programming Interface (API)

An API Key, also known as an Application Programming Interface Key, is a code or credential used to authenticate and authorize access to a specific API (Application Programming Interface).

Request Header

Each request header must be authenticated using your API key, which serves as the Private Key for either the sandbox or live environments, accessible within the 'developers' section under settings.

Sample of a proper format for your request header is as follows:"

{
  "headers": {
    "Authorization": "Bearer your_api_key_here",
    "Content-Type": "application/json",
    "Accept": "application/json"
  }
}

In this format:

  • "Authorization" is the key, and "Bearer your_api_key_here" is the value. Replace "your_api_key_here" with your actual API key.
  • "Content-Type" is set to "application/json" to specify that the content of the request is in JSON format.
  • "Accept" is set to "application/json" to indicate that the client expects a JSON response from the server.

When interacting with the API, it is essential to include this authorization header with your API key to ensure proper authentication and authorization of your requests. This enables the API to validate your identity and permissions, granting you access to the requested resources or actions as needed.