Access to API endpoints is controlled via users. This includes two ways for controlling access.
User permission at the application level
In the first option, a user is assigned to the API endpoint.
This can be done in the properties of the application to which the API endpoint belongs. The assigned user can access the API endpoint if authentication to the portal is done using the API login endpoint and cookies (without API key) included in delivery by default.
Administrator
The "Administrator" user is automatically assigned to every API endpoint.
Detailed information about this option can be found in the following sections:
User authorization at the API key level
In the second option, the assignment of a user is done via an API key, which is (in turn) assigned to the API endpoint. This also gives the user access to the API endpoint.
The "Integration" module is used to assign a user to an API key. When accessing an API endpoint via an API key, no explicit login of the corresponding user to the portal is required.
Detailed information about this option can be found in the following sections:
Interaction of users at the API-endpoint and API-key level
If a user has access to an API endpoint via an API key, they do not need any (additional) application-level assignment. The API key-level assignment is sufficient.
Email us