Creating API Tokens

API tokens are used to authorize the user to access the API. This allows the user to directly access the API without having to provide the login credentials.

Complete the following steps to create an API token.

  1. On the menu, go to Admin > API Tokens.
    The API Tokens window is displayed.
    Note: The columns in the API Tokens window can be resized to meet your requirements.
  2. Click the icon to create an API token.
    The Add Token dialog box is displayed.
  3. Complete the following fields to add a token.
    • Description: Type a description.
    • Role: Select a role from the list to be assigned to the user.
      • Super Admin: A user who is assigned the role of super admin has complete privileges and can perform any actions on all the modules.
      • Admin: A user who has the admin role has restricted privileges and is not allowed to perform actions related to user accounts and API tokens.
      • View: The user is permitted only to view information but not create, modify, or delete it.
    • Status: Enable the option to make the token active.
  4. Click Save to create the API token.
    An information dialog box is displayed indicating that the API token is created successfully.
Parent topic: Working with APIs