Learn how to authenticate with the Carbon Business API.
The Carbon Business API uses API key-based authentication. Every request to the API must include the x-carbon-key
header with your API key.
apikey
The apikey
is a security scheme used to authenticate requests. It must be included in the request header as authorization
. This key is required for all API interactions.
x-carbon-key
The x-carbon-key
is the header where your app API key is passed. It is mandatory for every request to the Carbon Business API. Without this header, the API will reject the request with an authentication error.
Include the apikey
header in your requests:
Include the x-carbon-key
header in your requests:
Environment | URL |
---|---|
Live | [Production URL] |
Sandbox | https://carbonapistagingsecure.getcarbon.co/baas/api |