Basic Authentication proves that you are who you say you are. Authentication tokens identify a user - the person - that is using the app or site.
To authenticate API calls, you need a bearer token or an API shared key and secret key. A shared key and secret key serve as a secure token to authenticate and authorize requests. Unauthorized use of a shared key or secret key could potentially cause a security breach. The shared key and secret key enable the authentication token used to access real data through the API.
Basic Authentication is not set up by default for applications and requires an API request.
Setting up Basic Authentication
You will need the following items to set up Basic Authentication:
- A Developer Experience account
- A Sandbox environment with an organization
- A shared key
- A secret key
If you do not have a sandbox environment, refer to the Getting Started with Candescent APIs document for the steps
Accessing Your Apps and Shared Keys
Important: Only admins and developers have access to view applications that have been created and assigned to a particular developer.
Log in to your Developer Experience account.
Click on Apps in the menu on the left side of the screen.
On the My Apps dashboard, all the applications you have access to displays on the right side of the screen.
Locate the Shared Key in the All Access Keys section for your application. Click the Eye icon to view the full length of the Shared Key.
To copy the Shared Key, click on the Copy icon.
To delete the Shared Key, click on the Trash Can icon.
Generating a Secret Key
A secret key serves as a secure token to authenticate and authorize requests. Unauthorized use of a secret key could potentially cause a security breach. The Secret Key holds the error token used to access real data through the API.
Log in to your Developer Experience account.
Click on Apps in the menu on the left side of the screen.
Locate the app for which you need a secret key and click the Generate Key button.
The system displays the Shared Key and Secret Key in the Access Key window.
Copy and store your new secret key. After closing the Access Key window, the secret key cannot be retrieved. For each key, click the copy icon and save to a secure location.
Click the Close button to complete the process.