Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Het systeem maakt het mogelijk om API-sleutels aan te maken voor individuele gebruikers in BlueDolphin, samen met een vervaldatum. Dit zorgt voor veilige toegang en interactie met de systeem-API's, beperkt tot hun toegewezen rollen en permissies. De rol Administrators in BlueDolphin stelt de gebruiker in staat om gepersonaliseerde API-sleutels voor andere gebruikers te genereren. Hieronder vind je de stappen voor het aanmaken van een nieuwe API-sleutel in BlueDolphin.
HTTP-responses
HTTP response status code | Interpretatie |
201 Created | Sleutel succesvol aangemaakt |
400 Bad Request | Eén of meer parameters ontbreken of zijn onjuist. De response body geeft een specifieke foutmelding terug:
|
401 Unauthorized | Ongeldige of ontbrekende API-sleutel of tenant |
Om een nieuwe API-sleutel aan te maken, doe je een POST-verzoek naar het /user-api-keys endpoint met daarin:
Resource/endpoint bestemmings-URL
De header voor je API-verzoek
De request body, die het volgende moet bevatten:
Parameter | Vereist | Type | Beschrijving |
name | ✓ | string | De naam van de sleutel die je wilt aanmaken. Dubbele namen zijn toegestaan. De naam moet tussen de drie en 255 tekens lang zijn. |
user_id | ✓ | string | Unieke identificatie van de bestaande gebruiker waarop de sleutel gebaseerd moet zijn. Deze sleutel vind je in BlueDolphin in het Admin-gedeelte onder Gebruikers. Het user_id-veld is de laatste parameter in de URL, bijvoorbeeld: |
expiration_date | ✓ | string | De vervaldatum van de sleutel, die niet in het verleden mag liggen. De datum moet in ISO-8601 formaat zijn ('YYYY-MM-DD'). |
Hieronder vind je een voorbeeld van een API-verzoek om een nieuwe API-sleutel aan te maken. Zie Gebruikerssleutelbeheer aanmaken voor meer informatie.
curl -L 'https://public-api.eu.bluedolphin.app/v1/user-api-keys' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{ "name": "BrandNewKey", "user_id": "643e9020d97c6a7e28665255", "expiration_date": "2024-12-12"}'
Response-eigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie van de API-sleutel |
key | string | Niet-gehashte API-sleutel |
Een succesvol verzoek geeft een response met een 201 OK HTTP-statuscode en de volgende body terug
{ "id": "63c57b3882345012d9e7a157", "key": "65662264-dd0e-46eb-9b11-ab2fb426bbc2"}
Er is nu een nieuwe sleutel 65662264-dd0e-46eb-9b11-ab2fb426bbc2 aangemaakt die verloopt op 2024-12-12.
Let op: de nieuwe sleutel kan na dit moment niet meer worden opgehaald. Je moet deze sleutel zelf opslaan voor verder gebruik en naslag.
Waarschuwing: Zet nooit een API-sleutel of een deel daarvan in de sleutelnaam. Hiermee stel je het geheim bloot aan iedereen die de naam kan zien, kan de sleutel in logs en rapporten terechtkomen, schendt je beveiligingsstandaarden en vergroot je het risico op misbruik.
Gebruik alleen sleutelnamen die het doel en de eigenaar beschrijven. Sla de geheime sleutel altijd veilig op en deel deze alleen op een veilige manier. Als een sleutelwaarde ooit wordt onthuld, trek deze dan direct in en vervang hem.