Skip to main content

How to set up a service account for API communication

Create a service account and private key for connecting an integration to the LivionKey API.

Written by Yassine Jouahri

A service account gives an integration its own credentials for the LivionKey API. Each service account has an ID and a private key, and can only access the organization units you give it.

Creating a service account

  1. Click API in the left menu. The Service accounts tab opens. Click CREATE at the top right of the page.

    Note!

    If you don't see API in the menu, API access isn't enabled for your organization. Contact technical support by clicking Support in the left menu or by emailing [email protected].

  2. Enter a name for the service account. Under Organization permissions, select the Organization unit the integration needs access to (you can search for it), and select API as the Role. Click SAVE.

  3. The Service account has been created view opens. It shows the service account's ID and Private Key. You need both to set up API communication.

IMPORTANT!

Click COPY PRIVATE KEY and store the key securely before you close the view. The private key can't be shown again. If it's lost, create a new service account and delete the old one.

The new service account is now shown in the list.

For how to use the ID and private key, see LivionKey API v2: Mechanical keys and key contracts.

Did this answer your question?