Control Commands via Public API
The commands that you can control via the public API are explained below. For better orientation, these are structured according to entities.
The following prerequisites must be met for the commands to be used correctly:
- There must be an active connection between SICS and ACMP
- A session must be created in which the login is configured
- Content in the body of the Publish command must always be entered in Base64 encoded format
- Contents in the body of the Consume command are always returned Base64 encoded.
The commands listed are divided into a request part, which (unless otherwise specified) is executed with the publish command, and a response part, which is executed with the consume command.
The response always returns one of the following result codes.
| ID | Name | Description |
|---|---|---|
| -1 | ErrorUnspecified | Error not known in detail |
| 0 | ErrorOK | Request OK |
| 7 | ErrorInvalidSession | Invalid session ID |
| 15 | ErrorUserNamePasswordWrong | Username or password incorrect |
| 18 | ErrorInternalError | Internal error |
| 19 | ErrorDatabaseError | Database error |
| 26 | ErrorClientNotExist | Client does not exist |
| 30 | ErrorElementNotFound | Element not found |
| 32 | ErrorLicenseAmountReached | Client does not have an ACMP license for this request |
| 35 | ErrorInvalidRequest | Inquiry incorrect |
The ACMP must also be connected to the SICS.
If you are already working with the AESB, you will usually have established a connection from the ACMP to the AESB via the SICS. You can check this in the ACMP Console under System > Settings > ACMP Server > SICS connection.
If you have not yet entered any information about the AESB, you can read here how to enter the connection.
Note:
Note the Public API access rights setting in the SICS connection settings. If you enable access by selecting the checkbox, SICS users will also be able to execute public API commands.