Zuletzt geändert von Steffi F am 2025/05/26 13:00

Verstecke letzte Bearbeiter
Steffi F 3.1 1 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.
Steffi F 2.1 2
Steffi F 3.1 3 Zur korrekten Verwendung der Befehle müssen folgende Voraussetzungen erfüllt sein:
4
5 * Es muss eine aktive Verbindung zwischen SICS und ACMP bestehen
6 * Es muss eine Session erstellt werden, bei welcher der Login konfiguriert ist
7 * Inhalte im Body beim Befehl //Publish// müssen immer Base64 encoded eingegeben werden
8 * Inhalte im Body beim Befehl //Consume// werden immer Base64 codiert zurück geliefert
9
10 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.
11
12 Im Response wird Ihnen immer einer der folgenden Resultcodes zurückgeliefert.
13
14 (% style="width:796px" %)
15 |=ID|=(% style="width: 282px;" %)Name|=(% style="width: 433px;" %)Beschreibung
16 |-1|(% style="width:282px" %)ErrorUnspecified|(% style="width:433px" %)Fehler nicht näher bekannt
17 |0|(% style="width:282px" %)ErrorOK|(% style="width:433px" %)Anfrage OK
18 |7|(% style="width:282px" %)ErrorInvalidSession|(% style="width:433px" %)Ungültige Session ID
19 |15|(% style="width:282px" %)ErrorUserNamePasswordWrong|(% style="width:433px" %)Benutzername oder Passwort falsch
20 |18|(% style="width:282px" %)ErrorInternalError|(% style="width:433px" %)Interner Fehler
21 |19|(% style="width:282px" %)ErrorDatabaseError|(% style="width:433px" %)Datenbank Fehler
22 |26|(% style="width:282px" %)ErrorClientNotExist|(% style="width:433px" %)Client existiert nicht
23 |30|(% style="width:282px" %)ErrorElementNotFound|(% style="width:433px" %)Element nicht gefunden
24 |32|(% style="width:282px" %)ErrorLicenseAmountReached|(% style="width:433px" %)Client besitzt keine ACMP Lizenz für diese Anfrage
25 |35|(% style="width:282px" %)ErrorInvalidRequest|(% style="width:433px" %)Anfrage fehlerhaft
26
27 Außerdem muss der ACMP mit dem SICS verbunden werden.
28
Steffi F 2.1 29 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.//
30
31 Haben Sie noch keine Informationen zum AESB eingetragen, dann können Sie [[hier>>doc:ACMP.68.ACMP-Solutions.System.Einstellungen.ACMP Server.WebHome]] nachlesen, wie Sie die Verbindung eintragen.
32
33 {{aagon.infobox}}
34 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.
35 {{/aagon.infobox}}
36
37
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community