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 | Automatic User Provisioning |
| OData feed | Download OData feeds | Get reporting data using OData | |
| User Key Management |
This scope is for the upcoming public API, which is currently in development and will be released for general use soon. Note: As of Hector.3, this scope does not drive any functionality. |
To issue an API call for a certain feature, the call needs to include an API key that has that feature as its scope.
To manage (view, create, and delete) API keys for your tenant, go to Admin > Public API keys.
When you create an API key, choose a name, a scope, and an expiration date.
BlueDolphin generates a unique 'key secret' for the new API key. You must copy that key secret and store it securely, as API calls without a key secret will fail and you cannot retrieve the key secret after the API key is created. You cannot change the scope or expiration date of an existing API key.
For more detailed documentation on the BlueDolphin public REST API, see BlueDolphin API documentation.
Comments
4 comments
The URL cannot be opened on Edge and Chrome also issues serious warnings.
Hi Sander,
Apologies, this was changed to Home - Microsoft Azure API Management - developer portal (bluedolphin.app)
Is it correct that it doesn't work yet? I followed the tutorial, but I get the following JSON result:
{
"error_code": 0,
"error_message": null,
"error_message_explain": null,
"data": []
}
However, we do have around 12 saved reports in the environment I tested.
Hi Sander, not sure what the 'it' is in your remark that 'it doesn't work yet'.
Best create a Zendesk ticket with support so we can look at 'it' in more detail.
Please sign in to leave a comment.