Authentication

Authentication is required to access resources and perform operations using the REST API. This section provides an overview of the authentication methods supported by the API, which include Basic Authentication and API Token Authentication.

Basic Authentication

Basic authentication allows to use your username and password and retrieve a sessionid which can then be used on subsequent API calls to send and receive responses. Another option is to send the credentials in the HTTP request headers using the Basic Auth authorization header. For more information, see the Basic Authentication topic.

Basic Authentication using Login API 

The Login API allows you to log into the application by providing your user name and password. If the login is successful, the application returns a unique session identifier. For security purposes, you are required to pass this identifier with each subsequent request. Upon logging in, you will receive a sessionid that has to be included in the header of all API requests. For more information, see the Login topic.

API Token Authentication

An API token is a string that is provided when making API calls and is sent as part of the HTTP request header. API tokens make authentication possible without the need for user credentials, simplifying the integration. For more information, see the API Tokens topic.