API Tokens

For our technical users, we offer API tokens.

What are API tokens

API tokens are keys that call APIs in the backend for authentication and authorization.

Simply put, API tokens help you connect to a workspace remotely via Terminal or Command Prompt.

Using an API token, you can create, view, update, or delete data, user, payment info, and more without having to log in via the Mammoth interface.

How does API token work

When you create an API token, the system generates two strings - a key and a secret. You must have the right key and secret combination to authorize an account. In absence of the right key and secret match, the system denies the API call.

api token example

Fig. 167 Example of an API token

Creating API tokens

This is how you can create an API token in Mammoth:

  • Go to Settings

  • Scroll down to the ‘API Tokens’ section

  • Click on the ‘Create token’ button

  • Add name and description for the API

  • Copy the secret, and save it somewhere safe

  • Click on ‘Sumbit’.

api token create

Fig. 168 Creating an API token

Note

The system shows the secret key only once. If you lose the secret key, you can regenerate a new one.

Managing API tokens

You can edit or delete an exisiting API token from the workspace settings.

Editing an API token

To edit an API token:

  • Go to Settings

  • Scroll down to the ‘API Tokens’ section

  • Click on the three dot menu to open more options

  • Select ‘Edit’

  • Update name, descriptions or generate a new secret for the token.

api token edit

Fig. 169 Editing an API token

Deleting an API token

To delete an API token:

  • Go to Settings

  • Scroll down to the ‘API Tokens’ section

  • Click on the three dot menu to open more options

  • Select ‘Delete’ and confirm your choice.

api token delete

Fig. 170 Deleting an API token