Generate Credentials
API credential generation is completed using the Principa Cloud Portal by visiting your applicable Environment.
| Environment | Principa Cloud Portal URL |
|---|---|
| Test | https://portal.staging.principa.cloud |
| Production | https://portal.principa.cloud |
ⓘ You will need to have the Developer or Administrator role assigned to your account to be able to generate and manage API credentials.
Once signed in, navigate to SERVICES > Developer using the left navigation.
Developer Settings
The Developer Settings console provides 3 areas to manage your credentials.
You can create / manage your credentials in 2 ways:
- Select the Credentials tab
- Select Manage Credentials shortcut on the Dashboard view
Creating a new API Credentials
Press + Add button to add a new credential and complete the prompts that follow:
| Input | Description |
|---|---|
| Name | Give your new credential a friendly name. |
| Expiration Date | How long you would like the API credential to be valid. On expiry date, the API credential can no longer be used. |
| Scope Selection | Select which actions the API credential may perform. |
Press Create once complete.
You will be displayed your API key and secret. Ensure you copy your API Secret to a safe location as it will only be displayed once.
ⓘ If the API Secret is lost, a new token will need to be generated.
Portal Developer Credentials View
Notes
- Each credentials can be viewed (excluding secret) and revoked using the action icons
- API Credentials can have a status of Active, Revoked or Expired.
- Revoked and expired credentials must be re-created.
Continue: Loading Credits >>