BlueDolphin offers a public REST API that provides the following features:
Scope | Description | Endpoints | Product documentation |
Data collector | Upload and download files without the DataCollector client. Note: DataCollector client still uses the old key. | /datasources, /datasource-reports | |
User provisioning | Integrate with a SCIM-compliant IAM tool to automatically manage BlueDolphin users and their role assignments. | /Users, /Groups | |
OData feed | Download OData feeds | /objects, /relations/, history, /information | |
User Key Management | Manage API keys in BlueDolphin | /user-api-keys |
To issue an API call for a certain feature, you must use an API key with the corresponding feature as its scope.
To manage API keys for your tenant, go to Admin > Public API keys.
To create an API key, you need to choose a name, a scope, and an expiration date.
BlueDolphin generates a unique 'key secret' for a new API key. You must copy that key secret and store it securely, because you cannot retrieve it after an API key has been created. You cannot change the scope or expiration date of an existing API key either.
For more detailed documentation on the BlueDolphin public REST API, see API Documentation.