Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Hier leggen we uit hoe je alle API-sleutels voor een specifieke gebruiker in BlueDolphin kunt ophalen. Alleen de Rol Administrators in BlueDolphin geeft de gebruiker de mogelijkheid om gepersonaliseerde API-sleutels van andere gebruikers op te halen.
HTTP-responses
HTTP response statuscode | Interpretatie |
200 OK | Een lijst met API-sleutels is succesvol opgehaald |
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 key secret en/of tenant |
Om de lijst met alle gepersonaliseerde API-sleutels voor een bepaalde gebruiker op te halen, doe je een GET-verzoek naar het /user-api-keys[?UserId={id}] endpoint en geef je het volgende op:
Bedrijfsmiddel/endpoint bestemming URL. Vervang de padparameter {id} door het ID van de gebruiker waarvoor je de API-sleutels wilt ophalen.
De header voor je API-verzoek
In dit voorbeeld willen we de lijst met gepersonaliseerde API-sleutels ophalen voor het gebruikers-ID 72f62077d23a6eeb4a772836. Om de lijst te krijgen, sturen we een GET-verzoek naar de URI https://public-api.eu.bluedolphin.app/v1/user-api-keys?UserId=72f62077d23a6eeb4a772836.
curl -L 'https://public-api.eu.bluedolphin.app/v1/user-api-keys?UserId=72f62077d23a6eeb4a772836' \-H 'x-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json'
Response-eigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor de API-sleutel |
user_id | string | Unieke identificatie voor de gebruiker |
name | string | Naam van de sleutel |
expiration_date | string | De verloopdatum in ISO-8601 datumformaat (JJ-MM-DD) |
created_on | string | De aanmaakdatum in ISO-8601 datum-tijd Zulu-formaat |
updated_on | string | null | De datum van de laatste wijziging in ISO-8601 datum-tijd Zulu-formaat of null als er nog geen wijziging is geweest |
scopes | string[] | De lijst met scope-identificaties. Op dit moment is er één waarde beschikbaar, namelijk 'public_api'. |
Een succesvol verzoek geeft een response met een 200 OK HTTP statuscode en de volgende array terug:
[ { "id": "63c57b3882345012d9e7a157", "user_id": "72f62077d23a6eeb4a772836", "name": "NewKey", "expiration_date": "2024-08-08", "created_on": "2023-08-08T09:15:00Z", "updated_on": "2023-08-09T10:15:00Z", "scopes": [ "public_api" ] }, { "id": "57b57c2197287115e4a3e397", "user_id": "72f62077d23a6eeb4a772836", "name": "NewAPIKey", "expiration_date": "2024-07-08", "created_on": "2023-07-08T09:15:00Z", "updated_on": "2023-07-08T10:15:00Z", "scopes": [ "public_api" ] }]