How to Create an API Key

Owned by CBE
Last updated: Jun 13, 2023
1 min read

API keys allow you to access the Tax Balance REST API. API keys can be saved in scripts or external tools, without having to use your username and password. Each user account can have multiple API keys.

Creating an API Key

You can create API keys by performing the following steps:

  1. Open the Swagger UI documentation at https://<your-tax-balance-url>/swagger/index.html

  2. Click Authorize.

  3. In the Bearer section click Authorize. (client_id and client_secret should be prefilled, otherwise contact your administrator)

  4. You will be directed to the Portal Login page.

  5. Enter your credentials and click Login.

  6. Click Close or X in the modal dialog.

  7. Scroll to the ApiKeys section in Swagger UI.

  8. Expand the POST operation and click Try it out.

  9. Enter your User ID. You will get your User ID by navigating to Master Data → Users → Overview in the Portal application.

  10. In the request body you might want to state the purpose of the API key and set the expiry date. Be aware to enter the date in a valid ISO-8601 format.

  11. Click Execute.

  12. Copy the new API key starting with “API-…” from the response body

Write Your Key Down After you generate an API key, it cannot be retrieved again, we store only a one-way hash of the API key. If you want to use the API key again, you need to store it in a secure place such as a password manager.