Authentication

Authentication for the GraphQL API can be performed in one of two ways, either using basic authentication or by generating a JWT token that can be used with subsequent calls.

We recommend using an API token for authentication. This can be generated for a user and provided as the password, with the user as the Avantra user ID, when making requests the GraphQL API.

For productive use, we recommend creating a specific user in Avantra that can access only the required information needed for the integration and is not tied to any specific real user account that may be deactivated if that users' roles and permissions change in the future so that the integration continues to work.

API key creation can be performed through the User Management menu item in Administration or through your own profile management for testing/development purposes.