Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Met de BlueDolphin API’s kun je verschillende handelingen uitvoeren die beschikbaar zijn via ons webplatform of ondersteunende tools.
De BlueDolphin Public API is gebouwd volgens REST-principes, wat zorgt voor voorspelbare URL’s en het eenvoudig maakt om applicaties te schrijven. Deze API volgt de HTTP-regels, waardoor je een breed scala aan HTTP-clients kunt gebruiken om met de API te communiceren.
Bronnen | Rapporten Hiermee kun je de output van rapporten uit je BlueDolphin-omgeving ophalen. | Bestanden delen Biedt de koppeling om met bronnen en rapportgegevens te werken. |
Eerste stappen
Om BlueDolphin API’s te gebruiken voor integraties, heb je het volgende nodig:
Een BlueDolphin-omgeving
Een API-sleutel. Heb je er nog geen? Kijk dan hier.
En je favoriete tool die met REST kan werken
Authenticatie
De BlueDolphin API gebruikt API-sleutels om verzoeken te authenticeren. Je kunt je API-sleutels bekijken en beheren in het admin-gedeelte van je BlueDolphin-omgeving.
Authenticatie voor de API gebeurt via HTTP-headers.
ApiKey - API-sleutel request header
Tenant - Header met de naam van de tenant die je wilt benaderen
Je API-sleutels geven veel rechten, dus bewaar ze goed! Deel je geheime API-sleutels nooit op publiek toegankelijke plekken zoals GitHub, client-side code of vergelijkbare locaties.
Alle API-verzoeken moeten via HTTPS worden gedaan. Verzoeken via gewoon HTTP zullen mislukken. API-verzoeken zonder authenticatie zullen ook mislukken.
Geauthenticeerd verzoek
De verzoeken moeten de apiKey- en tenant-headers bevatten.
$ curl GET "https://services.eu.bluedolphin.app/api/v1/datasource-reports"
-H "apiKey: f08a2bb9-3ab4-451a-9099-2ef531375147"
-H "tenant: contoso"
HTTP-methoden
BlueDolphin API gebruikt de juiste HTTP-verbs voor elke actie.
Naam | Beschrijving |
GET | Wordt gebruikt om bedrijfsmiddelen op te halen. |
POST | Wordt gebruikt om bedrijfsmiddelen aan te maken en acties op bedrijfsmiddelen uit te voeren. |
PUT | Wordt gebruikt om bedrijfsmiddelen bij te werken. |
PATCH | Wordt gebruikt om een specifiek detail van het bedrijfsmiddel bij te werken. |
DELETE | Wordt gebruikt om bedrijfsmiddelen te verwijderen. |
Voorbeeld
Met de GET-methode kun je een lijst van bedrijfsmiddelen of details van een specifieke instantie van een bedrijfsmiddel ophalen.
Hieronder zie je een verzoek om een lijst van databronnen op te halen.
$ curl GET "https://services.eu.bluedolphin.app/api/v1/datasources"
-H "apiKey: f08a2bb9-3ab4-451a-9099-2ef531375147"
-H "tenant: contoso"
Antwoord
Antwoorden zijn in JSON-formaat en hebben de volgende algemene structuur.
Naam | Beschrijving |
error_code | BlueDolphin-foutcode. Dit is nul bij een succesvol antwoord en niet-nul bij een fout. |
error_message | Als een API-aanroep mislukt, bevat dit veld een korte omschrijving van de fout; anders is het null. |
error_message | Bij een mislukte API-aanroep kan dit veld meer informatie over de fout bevatten. |
Data | Bevat de data van de aangeroepen API. |
Antwoordstructuur
De antwoordstructuur voor de export-API volgt het onderstaande formaat.
{
"error_code": 0,
"error_message": null,
"error_message_explain": null,
"data": {
"file_name": "..."
}
}Fouten
BlueDolphin gebruikt HTTP-statuscodes om aan te geven of een API-aanroep is geslaagd of mislukt. Over het algemeen betekent een statuscode in de 2xx-reeks succes, 4xx betekent dat er een fout is in de aangeleverde informatie, en 5xx geeft een serverfout aan.
HTTP-statuscodes
2xx | Succes |
4xx | Ongeldig verzoek naar de server gestuurd |
5xx | Serverfout |
Versiebeheer
Wanneer er niet-achterwaarts-compatibele wijzigingen aan de API worden doorgevoerd, wordt er een nieuwe versie uitgebracht. De huidige versie is v1. Upgrades en breaking changes worden vermeld op de API-referentiepagina onder het changelog-gedeelte.
Versiegebonden verzoeken
Verzoeken maken gebruik van een pad-gebaseerd versiebeheer.
https://services.eu.bluedolphin.app/api/v1