The Credas API uses an API key for authentication. All requests to the Credas API must be authenticated. You will receive a 403 response if you fail to provide a valid API key as part of your request.
Authenticating a request
To authenticate your request with the Credas API you must specify a header value of 'X-API-KEY' and provide a valid API key as the value.
Curl example
-H 'X-API-KEY: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
Postman example
Credas environments
You may have access to more than one Credas environment, so you will need to ensure that you use the correct key for each environment.
You will receive a 403 response from our API if you do not provide us with a valid API key.
Generate a demo API key
Properly permissioned users can generate an API key within the Credas portal. This API key will be associated to an individual user - client-wide API keys can be requested via your support contact.
We recommend that you utilise portal-generated API keys for our demo environment and use a client-wide API key for your production environment.
Below is a step by step guide on how to generate your API key within your demo portal.
Step 1 – Login to the Credas portal using your username and password. Select ‘portal’ in the top left.
Note: If you cannot see 'Admin Portal' in this list speak to your system administrator or technical contact.
Step 2 - select admin portal from the drop down.
Step 3 - click the 3 dots next to your user and select 'Issue API key'.
Your API key will automatically be copied to your clipboard however you can copy, reissue or revoke an API key from this menu at any time.
Generate a production API key
Your technical contact will provide you with a secure share of your production API key once your portal is ready.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article