API Token
API tokens are essential tools in our helpdesk system, offering secure access to the system's functionality and data. This documentation provides a concise guide on API token management, emphasizing their generation, usage, also including their role in creating new tickets through external systems.
A. Purpose of API Tokens
API tokens serve as authentication keys, facilitating interactions with the Helpdesk system's API. They are used to securely authenticate requests, ensuring that only authorized users and systems can access and manipulate the ticketing data.
B. Creating an API Token
To create a new API token, follow these steps:
- Navigation: Open Settings > Integration > API Tokens.
- Create API Token: Click on the Create API Token button.
- Token Name: Enter a name for the token. This name helps you identify the token later.
Once the token is created, it will be displayed in the list of API tokens. You can then use this token to authenticate API requests.
C. Using API Tokens (Postman Documentation)
API tokens are used to authenticate API requests made to the helpdesk system. They must be included in the headers of the API requests. For detailed instructions on how to use the API tokens to create new tickets, refer to the Postman documentation:
Helpdesk API Postman Documentation
D. API Token Management
API Token Management in Qiscus Helpdesk offers an intuitive interface for handling your tokens efficiently, providing essential features to maintain security and organization:
- Search and Manage API Tokens: The search bar at the top of the token list allows users to quickly locate specific tokens by entering keywords. This feature is invaluable when managing multiple tokens, enabling swift identification without the need to scroll through extensive lists.
- Update: Each token entry is accompanied by an action menu, represented by three dots under the "Action" column. Clicking this menu provides the option to edit the token's name to better reflect its purpose or associated project. This aids in better organization and identification of tokens within the system.
- Delete: The action menu also provides the option to delete a token if it is no longer in use or needs to be revoked for security reasons. Deleting a token removes it from the list and permanently revokes its access to the API, ensuring that only active and necessary tokens are maintained.