Skip to content

Create API key

API keys are required to securely connect external systems (such as your web shop, your CRM or your ERP) to the tebio business portal. By assigning appropriate roles, you ensure that each application only receives the permissions it needs.

Use this feature if you:

  • You would like to connect the tebio business portal to your existing company systems via the REST API.
  • Must immediately revoke and delete a compromised API key.
  • You want to assign separate API keys with different authorizations for different third-party systems (e.g. front-end shop and back-end ERP).
  • You need administrative rights in the tebio business portal to access the developer area and generate keys.

The developer area is separate from the regular business functions:

  1. In the main navigation (top right), click on the Terminal icon (the icon next to the settings gear).
  2. You will go directly to the Developer overview.
  3. Select the API Key tab (this is usually preselected by default).

In the list view you will find all the API keys that have already been created.

  • Client: Abbreviation of the client for which this key is valid.
  • Role: List of assigned permissions (e.g. r_apiUser, r_tebio_subscriptionManagement) assigned to the key.
  • API Key: The actual API key (partially masked for security reasons).
  • Actions:
    • Copy: Copies the key directly to your clipboard.
    • Delete: Revokes and deletes the API key. Use this if a system is being replaced or there is a suspicion of compromise.

To create a new API key for an integration, do the following:

  1. In the list view, click Create API Key.
  2. The Create dialog opens. Please fill out the following mandatory fields:
    • Name of the key: Assign a unique name (e.g. “Shopify Sync” or “Accounting Export”) so that it can later be traced which system uses this API key.
    • Prefix: A short abbreviation that is placed in front of the actual API key to make it easier to identify when analyzing protocols or logs.
    • Role: Open the dropdown and select one or more roles using checkboxes. For general API access, select at least r_apiUser. Depending on the use case, more specific roles may be required.
  3. Confirm your entries with Create.
  4. Important: Then immediately copy the newly generated key from the list view and save it securely in the backend of the connected system.

The API key is created and appears in the list. Immediately after creating the key, copy it and store it safely.

The portal uses the following REST endpoints for key management:

End pointMethodDescriptionOperationId
/v1/client/{realm}/apikey/listGETList API keys of the current tenantlistApiKeys
/v1/client/{realm}/apikeyPOSTCreate API keys with rolescreateApiKey
/v1/client/{realm}/apikey/{apiKeyId}GETGet details of an API keygetApiKey
/v1/client/{realm}/apikey/{apiKeyId}DELETERevoke and delete API keysdeleteApiKey