Authentication

To access an Application API endpoint, you (or the API client) must authenticate to the API endpoint.

You have two options for authenticating on an Application API endpoint.

Authentication via API login endpoint and cookies (without API key)

The first way to authenticate to an endpoint requires you to first log in to the portal. There are API endpoints provided for this in Intrexx by default. After successful login to the portal, Intrexx returns a session cookie and a CSRF token. These can then be used to authenticate access to Application API endpoints. This type of authentication is mainly used for accesses from web pages in the browser.

Login endpoints

A detailed overview and description of login endpoints can be found in the section Login API endpoints.

Authentication via API keys

The second way to authenticate to an endpoint is via API keys. API keys can be used to authenticate to the portal without explicitly logging in via an API login endpoint and cookies.

For authentication to be performed using the API key, it must be included in HTTP requests as an X-API-KEY header.

Postman

API keys

Detailed explanations of API keys can be found in the section Create and manage API keys.