Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
De BlueDolphin Public API is standaard beschikbaar voor alle tenants.
API-gegevens
Genereer een API-sleutel
Om een API-sleutel aan te maken in BlueDolphin, moet je de rol van Admin gebruiker hebben. Er zijn twee hoofdtypen sleutels:
Sleutelbeheer API-sleutel
Om API-sleutels te beheren in BlueDolphin, maak je via de gebruikersinterface een unieke API-sleutel aan. Ga hiervoor naar Admin > Public API keys en kies het bereik User key management.
Gebruiker API-sleutel
Deze sleutel wordt gebruikt voor alle BlueDolphin API-eindpunten, behalve voor het /user-api-keys eindpunt. Hiervoor heb je de API-sleutel nodig zoals beschreven in 1 (zie hierboven). Om deze sleutel te genereren, stuur je een POST-verzoek naar het eindpunt /user-api-keys.
Authenticatie
De BlueDolphin public API is gebaseerd op REST-principes en volgt de standaard HTTP-regels. Om deze te gebruiken, geef je de waarden op voor de volgende parameters in de HTTP request header:
Parameter | Vereist | Type | Beschrijving |
x-api-key | ✓ | string | Dit kan zijn:
Ben je geen Admin, vraag dan je Admin om een gebruikerssleutel. |
tenant | ✓ | string | De naam van de tenant in de database |
Content-Type | ✓ | application/json | Geeft aan dat het formaat van de request body JSON is |
Let op: alle voorbeelden en tutorials in de API documentatie worden gegeven in CURL en gebruiken de EU resource URL. Mogelijk moet je deze aanpassen op basis van de taal en het framework dat je gebruikt en de locatie van je tenant (https://public-api.us.bluedolphin.app voor US tenants).