Prerequisites
To use our public API, make sure your tenant has the PUBLIC_API add-on activated.
If the add-on is not activated, any calls to the BlueDolphin public API will result in a 403 Forbidden error.
API Credentials
Generate an API key
To create an API key in BlueDolphin, you must have an Admin user role. There are two main types of keys:
Key management API key
To manage API keys in BlueDolphin, create a unique API key secret through the UI. To do this, navigate to Admin > Public API keys and choose the User key management scope.
User API key
This key is used for all BlueDolphin API endpoints except for the
/user-api-keysendpoint, which requires the API key described in 1 (see above). To generate this key, send a POST request to the endpoint/user-api-keys.
Authentication
BlueDolphin public API is based on REST principles and follows standard HTTP rules. To use it, please specify the values for the following parameters in your HTTP request header:
Parameter | Required | Type | Description |
x-api-key | ✓ | string | This will either be:
If you are not an Admin, ask your Admin for a user key. |
tenant | ✓ | string | The name of the tenant in the database |
Content-Type | ✓ | application/json | Indicates that the request body format is JSON |
Please note that all examples and tutorials in the API documentation are provided in cURL and use the EU resource URL. You might have to adjust these based on the language and framework you are using and the location of your tenant (https://public-api.us.bluedolphin.app for US tenants).