The BlueDolphin API uses API keys to authenticate requests. You can view and manage your API keys in the admin section of your BlueDolphin environment.
Authentication to the API is performed via HTTP headers.
ApiKey - an API key request header
Tenant - a header that contains the name of the tenant that you need to access
Prerequisites
To start using BlueDolphin APIs to create integrations, you need to have a BlueDolphin environment.
If you want to create integrations for a BlueDolphin environment where you are an administrator, just follow the steps to create a new API key. Otherwise, ask your administrator to create one for you and jump to Step 2.
Step 1: Create a new API key
Example: Request a blob storage URI
1. Configure the request headers.
$ curl GET "https://{base}/api/v1/sharedaccessstring/write" \
-H "apiKey: <api-key>" \
-H "tenant: <tenant>"Replace:
{base} with "services.eu.bluedolphin.app" or "services.us.bluedolphin.app", for EU and US tenants respectively.
<api-key> with the API key that you saved before.
<tenant> with the name of your environment. It is also part of the URL for BlueDolphin.
2. Send a request.
$ curl GET "https://{base}/api/v1/sharedaccessstring/write" \
-H "apiKey: 0faad704-28a8-4a18-aa4d-d267f6642ea3" \
-H "tenant: contoso"Replace:
{base} with "services.eu.bluedolphin.app" or "services.us.bluedolphin.app", for EU and US tenants respectively.
Next steps
Learn more about data import/export: