Skip to main content
Deutsch English

Correct Creation of API Users

Andreas Föll
  • Updated

When using AEB applications hosted in the AEB data center via front-end systems, communication takes place via API users. This article describes how to correctly create an API user, also known as a WebServiceManager (WSM) in AEB cloud applications such as Trade Compliance Management, Carrier Connect, or Customs Management.

  • Prerequisite: To create the API user, you need the I_CLIENTADMIN user administration role. 

Settings for the API user

  1. From the Office menu, go to User administration > Users and click the New button.
  2. First, uncheck all tick boxes. These are initially checked in the Change passw. immed. and Dialog user fields. 
    Background: 
    • Change passw. immed.: If this checkbox is ticked, all API calls are blocked.
    • Dialog user: If this checkbox is ticked, this user can log in locally via the browser. During this time, API calls are blocked. In addition, the AEB data center checks whether this checkbox is ticked in conjunction with the I_BUSINESSFACADE role; if so, the role is removed for security reasons.
  3. Assign a name for the User and a descriptive Remark.  
    This reduces the risk of accidental deletion, even when internal user administration changes. 
  4. Choose a password that is as complex as possible. Since the password is persistent, be sure to choose a particularly secure one.
  5. Set the Pwd validity (days) to 99,999 days. 
    • Please note: It is not possible to change expired passwords via API calls. API calls are immediately blocked when a password expires.
  6. Leave the E-mail address field blank.  
    An email address is only required to receive a new initial password when resetting your password via the login screen. In that case, however, you would need to change your password again, which would block API usage. 
    API_user.png
  7. Select the Roles tab and click the Add button. 
  8. Tick the System roles checkbox and assign the technical role "I_BUSINESSFACADE" to the API user. 
    This role is required to enable the new API user to authenticate calls from source systems.
    Roles.png
    • Please note: Do not assign any additional roles to this user. The API user is used exclusively for authentication. 

Further Information

For more information on setting up API calls and the relevant environment, please visit AEB's API hubs.