Commands über die Public API ansteuern
Im Folgenden werden die Commands erklärt, die Sie über die Public API ansteuern können. Diese sind, zur besseren Orientierung, nach Entitäten gegliedert.
Zur korrekten Verwendung der Befehle müssen folgende Voraussetzungen erfüllt sein:
- Es muss eine aktive Verbindung zwischen SICS und ACMP bestehen
- Es muss eine Session erstellt werden, bei welcher der Login konfiguriert ist
- Inhalte im Body beim Befehl Publish müssen immer Base64 encoded eingegeben werden
- Inhalte im Body beim Befehl Consume werden immer Base64 codiert zurück geliefert
Die genannten Commands sind jeweils aufgeteilt in einen Request-Teil, welcher (sofern nicht anders angegeben) mit dem publish-Befehl und dem Response-Teil, der mit dem consume-Befehl ausgeführt wird.
Im Response wird Ihnen immer einer der folgenden Resultcodes zurückgeliefert.
| ID | Name | Beschreibung |
|---|---|---|
| -1 | ErrorUnspecified | Fehler nicht näher bekannt |
| 0 | ErrorOK | Anfrage OK |
| 7 | ErrorInvalidSession | Ungültige Session ID |
| 15 | ErrorUserNamePasswordWrong | Benutzername oder Passwort falsch |
| 18 | ErrorInternalError | Interner Fehler |
| 19 | ErrorDatabaseError | Datenbank Fehler |
| 26 | ErrorClientNotExist | Client existiert nicht |
| 30 | ErrorElementNotFound | Element nicht gefunden |
| 32 | ErrorLicenseAmountReached | Client besitzt keine ACMP Lizenz für diese Anfrage |
| 35 | ErrorInvalidRequest | Anfrage fehlerhaft |
Außerdem muss der ACMP mit dem SICS verbunden werden.
Arbeiten Sie bereits mit dem AESB, dann werden Sie i.d.R. eine Verbindung vom ACMP zum AESB über den SICS hergestellt haben. Kontrollieren können Sie diese in der ACMP Console unter System > Einstellungen > ACMP Server > SICS-Verbindung.
Haben Sie noch keine Informationen zum AESB eingetragen, dann können Sie hier nachlesen, wie Sie die Verbindung eintragen.
Note:
Beachten Sie unter den Einstellungen der SICS-Verbindung die Einstellung Public API Zugriffsberechtigung. Gewähren Sie über das Aktivieren der Checkbox den Zugriff, dann können SICS-Benutzer ebenfalls Public API Commands ausführen.