Integration users (API key)

In Kleer you can manage API keys for integrations.

An API key is linked to a user and controls what the integration is allowed to do, for example create vouchers, create supplier invoices or get access to the database (used, among other things, for access to SQL Analytics). This guide describes how you see your integration users, activate (generate) a key and revoke a key.

I need an API key. How do I get one?

The answer depends on whether the integration user already exists.

If it already exists, you see it under Settings > Integration users, and you generate the key yourself. See Activate (generate) a key below. You do not need to contact Kleer for that.

If it does not exist, it needs to be set up, and Kleer does that. Get in touch via Contact and support, or ask your Kleer consultant to pass the request on. Choose one of the routes, not both, so that the same request is not handled in two places.

What the request needs to state

• Which company it concerns.
• What the integration is to do, that is which system it is to connect to and which data it needs.
• A mobile number that the key can be sent to. If Kleer creates the key for you, it is sent by SMS, not by email.

In addition to the key, the person building the integration needs the company’s company ID, which is shown on the Integration users page, and the address of the API and the documentation. Ask for that in the same request, so that you avoid an extra round.

Are you building the integration for a customer?

If you, as a supplier, have no login of your own in Kleer, you cannot see the company ID or generate the key. Go via the customer, or via the customer’s Kleer consultant, who has the access.

Manage integration users

Where to find your integration users

1. Go to Settings.
2. Choose Integration users. Here you see the integration users for the company.
3. The page shows the Company ID: that number needs to be communicated to the customer for integrations to be carried out.

The columns in the list

For each integration user, the following are shown, among other things:

• User: who the key belongs to.
• Description: a free-text description of the key.
• Create voucher: whether the key may create vouchers.
• Create supplier invoices: whether the key may create supplier invoices.
• Access to database: whether the key gives access to the database.
• Database username: the username that is used for the database connection.
• Payment access: whether the key has payment access.
• Active: whether the key is active or revoked.

Activate (generate) a key

1. Find the integration user that is revoked or has no active key.
2. Click Activate.
3. The generated key is shown on the screen in the dialog Generated key.
4. Write down or copy the key straight away. No one at Kleer knows the key, and it is only shown this once.
5. Close the dialog by pressing ESC or clicking the cross.

Revoke a key

1. Find the active integration user.
2. Click Revoke.
3. Confirm in the question Revoke key?.
4. When you revoke the key, all integrations that use it stop working. If you need a new key afterwards, click Activate again.

History

1. Click the username in the list to open History.
2. Here you see the events that have occurred: when changes were made and who made them.

Good to know

• The company ID must be communicated to the customer for integrations to be carried out.
• Database access is used, among other things, for SQL Analytics. For keys with database access there are further settings such as secure connection, maximum number of connections and maximum number of queries per hour.
• For security reasons, Payment access can only be changed by specific people at Kleer.
• APIs created before 2020 may need to be reviewed. If you see users who no longer need their API, contact Kleer.