Skip to content
SchulungstoolSchulungstool API

Authentication

Schulungstool uses API keys to grant access to the API. You can generate an API key in your admin area under Settings > Advanced settings > Developer options.

Schulungstool expects the API key in every API request in the HTTP header:

Authorization: Token <API key>

Bearer <API key> is accepted as well.

Example:

Terminal window
curl "https://api.schulungstool.de/v1/users/" \
  -H "Authorization: Token <API key>"

Replace <API key> with your API key.

Without a valid key, the API responds with status code 401 and the error type AuthenticationFailed or NotAuthenticated, see Errors and rate limiting.

Try it directly in the reference

Section titled “Try it directly in the reference”

In the API reference you can send any request straight from your browser via Test Request. Enter your API key in the Auth field: it stays in your browser window only, is never stored, and is gone after you reload the page. Keep in mind that requests go to the production API, so writing calls (such as POST or DELETE) change real data.