Naar inhoud
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authenticatie

Leer hoe u zich authenticeert bij de Dastra API.

Uw geheime API-sleutel ophalen

De Dastra REST API gebruikt API-sleutels om elk verzoek te authenticeren. U beheert uw sleutels op de pagina API-sleutels, die is voorbehouden aan de eigenaars van de organisatie. Zie API-sleutelbeheer.

U kunt een API-sleutel gebruiken voor een specifieke werkruimte of voor de hele organisatie.

Een API-sleutel geeft toegang tot uw gegevens, dus bewaar hem veilig. Deel uw privésleutel niet in openbare delen van toepassingen, zoals GitHub of code aan de clientzijde.

Een verlopen of onbekende sleutel wordt geweigerd met status 401.

Wilt u OAuth2-authenticatie gebruiken met de "authorization_code"-flow, vul dan de redirect-URI's en de toegestane CORS-oorsprongen in het detailpaneel van de sleutel in.

Het venster voor het aanmaken van een API-sleutel met de naam, de werkruimte, de vervaldatum en de machtigingen
Een API-sleutel aanmaken

API-sleutel (X-API-Key)

De eenvoudigste manier om u te authenticeren is de HTTP-header X-API-Key met het privégedeelte van uw API-sleutel, zoals in het voorbeeld hieronder:

OAuth2-flow "Authorization code"

Autorisatie

De autorisatiefase wordt uitgevoerd door de volgende URL aan te roepen:

Parameters

Parameternaam
Beschrijving

response_type

code

client_id

De publieke sleutel van uw API-sleutel die in uw Dastra-account is geconfigureerd

redirect_uri

De URL die in de Dastra-API-sleutel is geconfigureerd. U wordt aan het einde van het autorisatieproces automatisch naar deze pagina doorgestuurd

scope

api1 => verplicht offline_access => om een refresh_token te verkrijgen (lange sessies)

state

Een willekeurige tekenreeks die uw toepassing genereert om aanvallen van het type cross-site request forgery (CSRF) te voorkomen. Zie Mitigate CSRF Attacks With State Parameters. Clientbibliotheken doen dit meestal automatisch

OAuth2-flow "Client credentials"

Authenticatiemethode

De API-authenticatie is gebaseerd op het OAuth2-protocol met de flow "Client credentials". Deze authenticatiemodus mag alleen worden gebruikt voor server-naar-serververzoeken en nooit aan de clientzijde (bijvoorbeeld in een JavaScript-SPA).

Diagram van de flow Client credentials: uw server vraagt een token aan bij de identificatieserver van Dastra en roept daarna de API aan met dat token
De flow Client credentials

Het token ophalen

POST https://account.dastra.eu/connect/token

Voer een tokenverzoek uit met BASIC-headers.

Headers

Naam
Type
Beschrijving

Authorization

Basic {base64("{PublicKey}:{PrivateKey}")}

Request body

Naam
Type
Beschrijving

grant_type

string

client_credentials

scope

string

api1

Zodra u een access_token hebt opgehaald, kunt u elk REST API-endpoint aanroepen met dit token als "Bearer token".

Om bijvoorbeeld de lijst van uw werkruimten op te halen:

GET https://api.dastra.eu/v1/Workspaces

Haal de lijst van Dastra-werkruimten op.

Headers

Naam
Type
Beschrijving

Authorization

Bearer {access_token}

Alle verzoeken moeten via HTTPS en altijd vanaf de serverzijde worden gedaan. Verzoeken zonder authenticatie mislukken met foutcode 401.

Zie de API-referentie hier: https://api.dastra.eu/swagger/index.html

Laatst bijgewerkt

Was dit nuttig?