Explore the documentation or divedirectly into the API reference.
\n Get started\n REST API\n
You can register a new account or login.
Explore guides whichhelp you get started quickly.
Dive directly into thecomplete API reference.
Find all availablesupport options if you get stuck.
Learn how to start using this API. Explore the endpoints, sign up for an account, and connect with the\ncommunity.
This is a quick introduction to help you get started using this API.
To access protected parts of the API you need to obtain an access token. The following page shows how\nto obtain an access token.
The most basic way to obtain an access token is to use your personal credentials.
Request
POST /consumer/login\nContent-Type: application/json\n\n{\n "username": "[username]",\n "password": "[password]"\n}\n
Response
\n{\n "token": "",\n "expires_in": "",\n "refresh_token": ""\n}\n
It is also possible to use the OAuth2 authorization endpoint.
POST /authorization/token\nAuthorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW\nContent-Type: application/x-www-form-urlencoded\n\ngrant_type=client_credentials\n
As Basic authorization header you need to provide the [app key] + ":" + [app secret] as base64\nencoded string. It is also possible to provide your username and password but in general it is recommended to use the\napp key and secret since the app access can always be revoked later on.
[app key] + ":" + [app secret]
base64
\n{\n "access_token": "",\n "token_type": "bearer",\n "expires_in": 3600,\n "refresh_token": ""\n}\n
Most token responses always include a refresh token. You can use this refresh token to extend an access token before\nit expires.
POST /authorization/token\nAuthorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW\nContent-Type: application/x-www-form-urlencoded\n\ngrant_type=refresh_token&refresh_token=[refresh_token]\n
Like at the client credentials call the Basic header must contain the base64 encode app key and secret.
As response you will get a new access token.
This API was build with Fusio please visit the website of\nthe API provider to see available support options.
At the following page you can download the automatically generated client SDKs which help you to\nintegrate the API into your project.