Zum Inhalt springen
Zuletzt geändert von Sabrina V. am 2026/10/06 05:57
Von Version 27.1
bearbeitet von Steffi F
am 2026/06/24 10:43
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 28.1
bearbeitet von Sabrina V.
am 2026/10/06 05:57
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.SF
1 +XWiki.SV
Inhalt
... ... @@ -2,29 +2,29 @@
2 2  
3 3  = **Wozu dient das Arbeiten mit der API?** =
4 4  
5 -Mithilfe einer API haben Sie die Möglichkeit, einen Datenaustausch zwischen einzelnen Systemen schnell und unkompliziert durchzuführen. Im ACMP wird dafür die Public API genutzt, welche zwischen dem ACMP Server und dem AESB kommuniziert und mittels Public API-Befehlen bzw. Commands Informationen ausliest, abspeichert sowie Aktionen ausführt. Zusätzlich wird ein REST-Client benötigt, welcher den Zugriff und das Ausführen der Commands gewährleistet.
5 +Mithilfe einer API haben Sie die Möglichkeit, einen Datenaustausch zwischen einzelnen Systemen schnell und unkompliziert durchzuführen. Im acmp wird dafür die Public API genutzt, welche zwischen dem acmp Server und dem aesb kommuniziert und mittels Public API-Befehlen bzw. Commands Informationen ausliest, abspeichert sowie Aktionen ausführt. Zusätzlich wird ein REST-Client benötigt, welcher den Zugriff und das Ausführen der Commands gewährleistet.
6 6  
7 -Diese Komponenten ermöglichen den Datenaustausch und kann u.a. von der ACMP App genutzt werden, um Daten aus ACMP auszulesen und zu speichern.
7 +Diese Komponenten ermöglichen den Datenaustausch und kann u.a. von der acmp App genutzt werden, um Daten aus acmp auszulesen und zu speichern.
8 8  
9 -= Voraussetzungen für das Arbeiten mit ACMP und der ACMP Public API =
9 += Voraussetzungen für das Arbeiten mit acmp und der acmp Public API =
10 10  
11 -Um den Datenaustausch zwischen ACMP und AESB über die Public API zu ermöglichen, müssen folgende Voraussetzungen gegeben sein:
11 +Um den Datenaustausch zwischen acmp und aesb über die Public API zu ermöglichen, müssen folgende Voraussetzungen gegeben sein:
12 12  
13 -* Sie haben bereits einen AESB im Einsatz, der mit dem ACMP Server verbunden und konfiguriert ist
13 +* Sie haben bereits einen aesb im Einsatz, der mit dem acmp Server verbunden und konfiguriert ist
14 14  * Sie haben einen REST-Client installiert (z.B. Insomnia REST, dessen vorgefertigte Definitionsdatei Sie von uns erhalten)
15 15  
16 16  = Vorbereitung zum Datenaustausch =
17 17  
18 -Im Folgenden werden die notwendigen Schritte erläutert, welche im ACMP und im REST-Client vorgenommen werden müssen, um einen einwandfreien Datenaustausch zu ermöglichen. Die Einstellungen für den REST-Client werden hier am Beispiel von Insomnia REST aufgezeigt. Prinzipiell aber kann jeder andere REST-Client ebenfalls dazu genutzt werden.
18 +Im Folgenden werden die notwendigen Schritte erläutert, welche im acmp und im REST-Client vorgenommen werden müssen, um einen einwandfreien Datenaustausch zu ermöglichen. Die Einstellungen für den REST-Client werden hier am Beispiel von Insomnia REST aufgezeigt. Prinzipiell aber kann jeder andere REST-Client ebenfalls dazu genutzt werden.
19 19  
20 -== Verbindungsaufbau vom ACMP zum AESB ==
20 +== Verbindungsaufbau vom acmp zum aesb ==
21 21  
22 -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.//
22 +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.//
23 23  
24 -Haben Sie noch keine Informationen zum AESB eingetragen, dann können Sie [[hier>>https://doc.aagon.com/bin/view/AESB/111/Workspaces/Einstellungen/SICS-Einstellungen/]] nachlesen, wie Sie die Verbindung eintragen.
24 +Haben Sie noch keine Informationen zum aesb eingetragen, dann können Sie [[hier>>https://doc.aagon.com/bin/view/AESB/111/Workspaces/Einstellungen/SICS-Einstellungen/]] nachlesen, wie Sie die Verbindung eintragen.
25 25  
26 26  {{aagon.infobox}}
27 -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. Auf dem ACMP Server wird dann jede Nachricht von einem unbekannten Benutzer als SICS-Benutzer interpretiert und mit administrativen Berechtigungen versehen. Dadurch greift in diesem Fall keine Berechtigungsüberprüfung!
27 +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. Auf dem acmp Server wird dann jede Nachricht von einem unbekannten Benutzer als SICS-Benutzer interpretiert und mit administrativen Berechtigungen versehen. Dadurch greift in diesem Fall keine Berechtigungsüberprüfung!
28 28  {{/aagon.infobox}}
29 29  
30 30  Außerdem sollten Sie unter dem Abschnitt //Public API Antwort// die maximale Anzahl an Elementen der Public API Antwort erhöhen.
... ... @@ -35,7 +35,7 @@
35 35  Als REST-Client wird hier Insomnia REST genutzt.
36 36  {{/aagon.infobox}}
37 37  
38 -I.d.R. erhalten Sie zu Insomnia die Definitionsdatei vom Aagon Support.
38 +I.d.R. erhalten Sie zu Insomnia die Definitionsdatei vom aagon Support.
39 39  
40 40  ~1. Öffnen Sie Insomnia und navigieren Sie in der obersten Leiste zu Application > Preferences.
41 41  
... ... @@ -56,7 +56,7 @@
56 56  3. Klicken Sie im linken Arbeitsbereich auf Base Environment und tragen Sie unter „BaseUrl“ die Server-URL //https:~/~/ 127.0.0.1:3900/// ein.
57 57  
58 58  {{aagon.infobox}}
59 -Der Standard-Port für die AESB REST-API ist 3900.
59 +Der Standard-Port für die aesb REST-API ist 3900.
60 60  {{/aagon.infobox}}
61 61  
62 62  [[BaseUrl angeben>>image:1770211018165-737.png]]
... ... @@ -69,7 +69,7 @@
69 69  
70 70  Damit der Datenaustausch stattfinden kann, muss erst eine Session und damit ein Request gestartet werden.
71 71  
72 -Loggen Sie sich dazu in Insomnia ein und legen Sie die Umgebung fest, indem Sie für die Session einen ACMP- oder einen SICS-Benutzer verwenden.
72 +Loggen Sie sich dazu in Insomnia ein und legen Sie die Umgebung fest, indem Sie für die Session einen acmp- oder einen SICS-Benutzer verwenden.
73 73  
74 74  [[Umgebung festlegen>>image:1770211096221-588.png]]
75 75  
... ... @@ -83,19 +83,19 @@
83 83  
84 84  [[SICS-Benutzer verwenden>>image:1770211159654-389.png]]
85 85  
86 -== ACMP-Benutzer verwenden ==
86 +== acmp-Benutzer verwenden ==
87 87  
88 88  {{aagon.infobox}}
89 -Wenn Sie sich für die Verwendung eines ACMP-Benutzers entscheiden, wird das Anlegen eines eigenen ACMP-Benutzers für die Verbindung empfohlen.
89 +Wenn Sie sich für die Verwendung eines acmp -Benutzers entscheiden, wird das Anlegen eines eigenen acmp -Benutzers für die Verbindung empfohlen.
90 90  {{/aagon.infobox}}
91 91  
92 -Für die Verwendung und das anschließende Arbeiten mit einem ACMP-Benutzer, muss zunächst ein Hashwert aus einem Passwort generiert werden.
92 +Für die Verwendung und das anschließende Arbeiten mit einem acmp-Benutzer, muss zunächst ein Hashwert aus einem Passwort generiert werden.
93 93  
94 94  {{aagon.infobox}}
95 -Das Tool zum Generieren des Hashwertes erhalten Sie beim Aagon Support.
95 +Das Tool zum Generieren des Hashwertes erhalten Sie beim aagon Support.
96 96  {{/aagon.infobox}}
97 97  
98 -Wählen Sie im Insomnia unter //Activate Environment// Use Acmp, tragen Sie dann den Usernamen und den AcmpServerNamen ein. Klicken Sie nun auf //Send//, um Salt und Iterationcount für das Hashen des Passworts zu erhalten.
98 +Wählen Sie im Insomnia unter //Activate Environment// Use acmp, tragen Sie dann den Usernamen und den acmpServerNamen ein. Klicken Sie nun auf //Send//, um Salt und Iterationcount für das Hashen des Passworts zu erhalten.
99 99  
100 100  {{aagon.infobox}}
101 101  Falls Sie den Hash selbst generieren möchten, dann sollte der Wert für "PasswordHash" mit dem PBKDF2Algorithmus, der HMAC_SHA256 und einer HMAC-Länge von 32 verwendet und anhand der folgenden Werte berechnet werden: Passwort des Benutzers "Salt" aus der Antwort, "IterationCount" aus der Antwort
... ... @@ -113,7 +113,7 @@
113 113  
114 114  Falls diese Option nicht nötig ist, können Sie direkt zu Clientliste laden springen.
115 115  
116 -Ein Callback Target dient dazu, die vom ACMP Server gesendete Antwort auf den Request zu speichern.
116 +Ein Callback Target dient dazu, die vom acmp Server gesendete Antwort auf den Request zu speichern.
117 117  
118 118  Zur besseren Trennung empfiehlt es sich, einen eigenen VirtualRouter zu erstellen und in diesem das Callback Target abzulegen.
119 119  
... ... @@ -146,7 +146,7 @@
146 146  {{/aagon.infobox}}
147 147  
148 148  1. Wählen Sie hierzu den Befehl //Publish// in der linken Arbeitsleiste aus.
149 -1. Encoden Sie dann das Command Clientliste laden, indem Sie entweder das im ACMP vorhandene Client Command Encode Base64 string nutzen oder auf einer beliebigen Internetseite den Text encoden lassen.
149 +1. Encoden Sie dann das Command Clientliste laden, indem Sie entweder das im acmp vorhandene Client Command Encode Base64 string nutzen oder auf einer beliebigen Internetseite den Text encoden lassen.
150 150  
151 151  {{aagon.infobox}}
152 152  Beachten Sie, dass der Inhalt des Bodys immer Base64 encoded sein muss.
... ... @@ -158,13 +158,13 @@
158 158  Um zu prüfen, ob beim Laden der Clientliste ein Fehler aufgetreten ist, gehen Sie folgendermaßen vor:
159 159  
160 160  1. Wählen Sie nun den Consume-Befehl im linken Arbeitsbereich.
161 -1. Klicken auf Send. Auf der rechten Seite des Fensters wird Ihnen nun das Ergebnis vom ACMP angezeigt.
161 +1. Klicken auf Send. Auf der rechten Seite des Fensters wird Ihnen nun das Ergebnis vom acmp angezeigt.
162 162  
163 163  {{aagon.infobox}}
164 164  Beachten Sie, dass der Inhalt des Bodys immer Base64 encoded zurückgeliefert wird.
165 165  {{/aagon.infobox}}
166 166  
167 -1. Zum Decoden können Sie entweder das im ACMP vorhandene Client Command //Decode Base64 string //nutzen oder den Text auf einer beliebigen Internetseite decoden lassen.
167 +1. Zum Decoden können Sie entweder das im acmp vorhandene Client Command //Decode Base64 string //nutzen oder den Text auf einer beliebigen Internetseite decoden lassen.
168 168  
169 169  == Ressourcen aufräumen ==
170 170  
© Aagon GmbH 2026
Besuchen Sie unsere aagon-Community