Skip to content

API Token

Screenshot

To enable automated data exchange between maXzie and other systems, so-called API tokens can be created. These tokens serve as an authentication method for accessing the API endpoints provided by maXzie.

All API tokens are linked to a specific employee and can be revoked at any time. The API token has the same permissions as the linked employee. It is important to store these tokens securely, as they allow access to sensitive data.

At the moment, API tokens can only be generated by superusers in the API Token section. A new token can be created using the “Plus” button. In the dialog, a linked employee and a description must be provided.

Screenshot

After creation, the token is only shown once in the next dialog, so it should be stored securely.

Screenshot

In the API Token list, existing tokens can be deleted at any time. A deleted API Token immediately becomes invalid and cannot be restored. In addition, API Token entries can also be renewed after creation. This generates a new Token; the old Token immediately becomes invalid and cannot be restored.

To distinguish between different API Token entries, the first 4 characters of the token are shown in the list.

Screenshot

All endpoints that can be used with an API Token are described in the API documentation. It can be accessed via the three-dot menu in the API Token section.