Skip to main content

API users

Some functionalities in EVA will require you to configure an API user, to interact with it. This user can interact with features without the need for a real user.

About API users

API users can be used to authenticate in our environment. This can be needed for external integration with EVA, and can be outfitted with roles and permissions to give the API user the exact scope it needs to have. The configuration of API users is possible in the API users chapter in Admin Suite.

In the chapter, you will be presented with all your API users and you can search and filter for them, just like you can filter in many parts of Admin Suite.

One use case for API users is the connection and authentification with Adyen.

Relevant functionalities and permissions

There are two functionalities when it comes to monitors, namely UserRoles and ApiKeys.

Create API user

To create an API user, click the '+' icon in the overview. Now you can give your API user a name and nickname. Once you finished that, you will be redirected to the API user detail page, where you can further configure it.

Configure API users

In the API user detail page, you will be able to see the information you just configured for the API user. Next up is the configuration of permissions. You can either assign a single OU or an OU set role to the API user, depending on the scope that is needed. We recommend only giving it the permissions that are needed for its purpose, to limit access. Of course, you can assign multiple roles to an API user.


Create API key

For the authentification you will need an API key, which allows other applications to connect to EVA, using the API user. This can be created at the bottom of the API user details. Here you can configure the key, assign it to an OU and select if it is a permanently used one. This is important to set-up functions like payment providers, as they will be used over and over again.

Once that is configured, you can hit the save button. The key will transfered to your clipboard.

danger

You can not get access to the API key again after this. Make sure to save it somewhere save. Furthermore, like passwords, you should not share these API keys if not needed.