API Reference¶
Dive into the specifics of each API endpoint by checking out our complete documentation.
Authorization Flow¶
Authorization Flow
sequenceDiagram
autonumber
participant user as User (Resource Owner)
participant client as Client (Application)
participant authorization_server as Authorization Server
participant resource_server as Dimdata API
user ->> client: Log in
client ->> authorization_server: Authorization Code Request to /authorize
authorization_server ->> user: Redirect to login/authorization prompt
user ->> authorization_server: Authenticate & consent
authorization_server ->> client: Authorization Code Response
client ->> authorization_server: Send authorization code + clientID to /token
alt Validate
authorization_server ->> authorization_server: authorization code + clientID + redirectURI
end
authorization_server ->> client: Access token (and optionally refresh token)
client ->> resource_server: Request with access token
resource_server ->> client: ResponseView API for step 1-5 Authorize user
View API for step 6 Request access token
Refresh access tokens Flow¶
Refresh access tokens Flow
Refresh tokens are the credentials that can be used to acquire new access tokens.
sequenceDiagram
autonumber
participant client as Client (Application)
participant authorization_server as Authorization Server
participant resource_server as Dimdata API
client ->> authorization_server: Use refresh token to request new access token
authorization_server ->> client: Return new access token and new refresh token
client ->> resource_server: Request with new access token
resource_server ->> client: ResponseView API Refresh access token