General

Please help us getting better, by sending us feedback and your questions! If you struggle with some details in the implementation or something is unclear, just drop us a line at devs@sensorberg.com.

This documentation is in active development mode and will change frequently.

Authentication

Authentication is taking place with the help of OAuth 2.0 on the API level. So you are able to use the API in the name of a user or an app itself.

OAuth 2

If you need any information about OAuth 2.0, we will extend this documentation. For now, please consult the official resources at oauth.net.

The following information will be provided by us:

  • Access Token URL: $base_url/oauth/token
  • Username: $username
  • Password: $password
  • Client ID: $client_id
  • Client Secret: $client_secret
  • Scope: me, app or basic

$username, $password, $client_id and $client_secret must be stored and transfered only via encrypted transport mechanisms.

Scopes

  • me - the endpoint requires an user access token
  • app - the endpoint requires an app access token
  • basic - the endpoint requires an app access token with the basic right

Supported grant flows

Please choose your required grant flow wisely and take special care of the user credentials.

Format

Our APIs are following the specifications at jsonapi.org.

Please be aware that you need to send application/vnd.api+json as Content-Type for POST and PUT requests.

Documentation

Each type of API is offering a Swagger based documentation. You can use this documentation during development. A link to the specific documentation can be found at the top of each API documentation.