This article describes a new feature which is currently in early access and not available for general use at this time. This will be available in a future release.
If you are interested in being an early access client, reach out to your Customer Success Manager.
Use API keys to authenticate with the Bluecore REST API to view and update data programmatically.
| User Role | View | Edit |
|---|---|---|
| Client Admin | Yes | Yes |
| Developer | Yes | Yes |
| Viewer | Yes | No |
Create an API key
- Navigate to
Account > Developer Portal. The Developers page opens.
- If you want to create the API key for multiple Namespaces, navigate to your parent Namespace and create the API key.
- If you want to create the API key for a single Namespace, navigate to that Namespace and create the API key.
- Click Create Key. The New API Key page opens.
- Under Access Level, choose from the following permissions:
- Read-Only
- Allows all GET requests for supported APIs.
- Read & Write
- Allows all GET and POST requests for supported APIs.
- Custom
- You can select which calls the API key can perform in the Permissions table.
- Read-Only
- If you are in a parent Namespace, select which other Namespaces the API key should have access to.
- To automatically add all accounts, click the Automatically add connected accounts toggle to the on position.
- When finished, click Save & Create. A dialog box appears with your token. The API key is saved.
Account > Developer Portal. The Developers page opens.
If you create a new API key, the token only displays once. Make sure you save it in a secure location.
Edit an API key
Once an API key is created, you can add permissions but can't remove them.
For example, if you update an API key that has read-only permissions to include write permissions, you can't revert it to read-only.
If you need to reduce permissions, you must create a new API key.