Skip to main content

Manage API keys

The HTTP(S) API has been available since MXSuite version 3.3.0.

To create an API key, there are 2 steps needed:

  1. Create the API-user
  2. Create the API-key
Create an API user
  1. Open the Administration module 
  2. Click on Users

    image.png


  3. Create a new user for the API with the correct user rights. Assure that you select user type API.

    image.png


Create the API key
  1. Open the Administration module
  2. Click on API keys

    image.png


  3. Click on New...

    image.png

  4. Enter the Name of the API so you can easily distinguish all API keys.
  5. Select the related API user
  6. If needed, enter an expiry date.
  7. Click on Save & close
  8. Now the API key is created and visible.