Welcome, this is a quick introduction to help you get started using the API. On the left sidebar you see all available endpoints. Each endpoint shows the available request methods and the request/response data format.

Through the developer portal it is possible to manage all your apps and authorizations. If you have obtained an app key and secret you have several options to obtain an access token. The API uses OAuth2 for authorization so you can use any OAuth2 compatible library to request an access token.

Authorization-Endpoint

/developer/auth

Token-Endpoint

/authorization/token

App Registration

Available for registered user at url /developer/account/app

Authorization Code Grant

For obtaining the authorization code you have to redirect the resource owner's browser to the consumer endpoint: /developer/auth?response_type=code&client_id=[app_key]&redirect_uri=[redirect_uri]&scope=[scopes]

• app_key - application key
• redirect_uri - should be on the same host as application url
• scopes - comma separated list of scopes which should be subset of application scopes

If the authorization was successful the user gets redirected to the redirect_uri of your app. The redirect_uri contains a GET parameter code which can be exchanged for an access token at the Token-Endpoint.

Authorization Token Grant from Authorization Code

POST /authorization/token
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code&code=[code]&client_id=[app_key]&redirect_uri=[redirect_uri]&client_secret=[app_secret]

• code - authorization code obtained at previous step
• redirect_uri - redirect uri used at previous step

Authorization Token Grant from Refresh Token

POST /authorization/token
Content-Type: application/x-www-form-urlencoded

grant_type=refresh_token&refresh_token=[token]&client_id=[app_key]&client_secret=[app_secret]

• token - refresh token obtained at previous step along with authorization token

Please contact the API provider for more information. This API was built with Fusio.