SupportPal Documentation

API Tokens

API Tokens must be created in order to authenticate with the API. Token access levels can be controlled at either read only or read and write access.

Contents

Searching for API Tokens

Table sorting

By default the table is sorted alphabetically. Once the table has loaded you're able to change the sort column by clicking the up/down arrows:

This action is only temporary and will disappear once the page has been reloaded.

Filtering the table

It's possible to filter API tokens based on their name, token value and access level:

  1. Visit Settings -> Core -> API Tokens and click "Filter Results".
  2. Search terms:
    1. Name - It is possible to search for partial names. For example, you could find "forums" by searching for "for" or "ums".
    2. Token - The API token value.
    3. Access Level - Whether the token permits read only access or read and write.
  3. The table will be filtered automatically as you enter search terms.

Creating or Updating an API Token

To create a new API Token, or update an existing token, please follow the following steps.

  1. Visit Settings -> Core -> API Tokens. If you're creating a new token click "Add API Token", or if you're updating an existing token, search for it and click the edit (pencil) icon on the right side of the table row.
  2. Complete the input fields:
    1. Name - A name used to identify the purpose of the token.
    2. Token - The token value used to authenticate with the API. Click the "edit" button if you prefer to specify your own API token.
    3. Access Level - Whether the token permits read only access or read and write.
  3. Click the "Submit" button.

Deleting an API Token

To delete an API Token, follow the below steps:

  1. Visit Settings -> Core -> API Tokens.
  2. Search for the token you wish to delete (see Searching for API Tokens).
  3. Click the delete (cross) icon located on the right of the table.
  4. Click on the left button, "Yes, Delete API Token", that pops up confirming you would like to delete this token and it will now be deleted.