Authentication

Using the API needs and authentication with an API token.

Methods

There are two ways to transmit an token:

Request header

Request header Api-Token is required

GET parameter

GET parameter apiToken is required

Token administration

Tokens are stored in the database table rest_users.

Column

Value

name

User name / Token info optional

api-token

Token required

api-rights

rw/r required

While installation user with token t6PEqwkBpbdsf93osDSF913Bmcsd78pYWLtEgvs is created.

Permissions

It´s possible to set read/write (default) and only read permissions.

Status

Permission

rw

GET, PUT, POST, DELETE

r

GET

Before production remove test user from rest_users table.