Authentication

Authentication

For clients to authenticate, the API key should be included in the Authorization HTTP header.

The key should be prefixed by the string literal “Token”, with whitespace separating the two strings.

Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b

You must replace 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b with your personal API key.

Obtaining an API key

API keys are created from the GSMtasks dashboard:

  1. Open Settings → API keys to manage the keys that determine what data your app can access.
  2. Click Create API key, fill in a Name and Email for the key, and press Save.
  3. The key is shown only once, immediately after creation. Copy it and store it somewhere safe.
⚠️

The API key is non-recoverable. If you lose it, you will have to create a new one.

💡

Keys are valid until they are revoked from the API keys page.

IntroductionVersioning