Learn how to obtain and use your API keys
To ensure secure access to our API endpoints, Rootline employs API key authentication. The API key grants you the necessary privileges to interact with our services.
How to obtain your API key
To obtain your API key, go to Dashboard > Developers > API users.
- Create an API user. Note: make sure to assign the PaymentApi role when creating the API user
- Create an API key for the API user you created
- Store your API key securely in your system. After retrieving the API key once, it is not possible to retrieve it again.
How to use your API key
To authenticate your API requests using the API key, you need to include the x-api-key
header in each API call:
x-api-key: YOUR_API_KEY
Replace YOUR_API_KEY
with the API key generated through the Dashboard. The API key should be presented as a plain string without any additional prefixes or suffixes.