Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.

Dit artikel legt uit hoe je API-sleutels voor alle gebruikers in BlueDolphin kunt ophalen. Alleen de Admin-rol in BlueDolphin geeft de gebruiker de mogelijkheid om gepersonaliseerde API-sleutels van andere gebruikers op te halen.

HTTP-responses

HTTP response status code	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: Gebruikers-ID is leeg of onjuist
401 Unauthorized	Ongeldige of ontbrekende API-sleutel secret en/of tenant

Curl-commando om gebruikerssleutels op te halen,

EU:

curl --location 'https://public-api.eu.bluedolphin.app/v1/user-api-keys' \
--header 'x-api-key: {api-key}' \
--header 'tenant: {tenant}' \
--header 'Content-Type: application/json'

US:

curl --location 'https://public-api.us.bluedolphin.app/v1/user-api-keys' \
--header 'x-api-key: {api-key}' \
--header 'tenant: {tenant}' \
--header '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, gebruik een duidelijke naam zodat je deze later herkent. Bijvoorbeeld “<userX> apikey” of “<appY> integratie”
expiration_date	string	De verloopdatum in ISO-8601 datumformaat (JJJJ-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 deze nog niet is bijgewerkt
scopes	string[]	De lijst met scope-identificaties. Op dit moment is er één waarde beschikbaar, namelijk 'public_api'.

Een succesvolle call 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"
      ]
   }
]

API-sleutels ophalen voor alle Gebruikers

HTTP-responses

Response Eigenschappen