Skip to Content
Last modified by Sabrina V. on 2026/10/06 05:47
From version 3.1
edited by Sabrina V.
on 2026/06/02 05:25
Change comment: There is no comment for this version
To version 6.1
edited by Sabrina V.
on 2026/10/06 05:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Data Exchange with ACMP via Public API
1 +Data Exchange with acmp via Public API
Content
... ... @@ -2,28 +2,28 @@
2 2  
3 3  = What is the purpose of working with an API? =
4 4  
5 -An API enables the quick and easy exchange of data between systems. In ACMP, the public API communicates between the ACMP Server and the AESB, reading and storing information using public API commands. Additionally, a REST client is required to access and execute the commands.
6 -These components enable data exchange and can be used by the ACMP app, among other things, to read and save data from ACMP.
5 +An API enables the quick and easy exchange of data between systems. In acmp, the public API communicates between the acmp Server and the aesb, reading and storing information using public API commands. Additionally, a REST client is required to access and execute the commands.
6 +These components enable data exchange and can be used by the acmp app, among other things, to read and save data from acmp.
7 7  
8 -= Requirements for Working with ACMP and the Public API =
8 += Requirements for Working with acmp and the Public API =
9 9  
10 -To enable data exchange between ACMP and AESB via the public API, the following requirements must be met:
10 +To enable data exchange between acmp and aesb via the public API, the following requirements must be met:
11 11  
12 -* You already have an AESB in use that is connected to and configured with the ACMP Server.
12 +* You already have an aesb in use that is connected to and configured with the acmp Server.
13 13  * You have installed a REST client, such as Insomnia REST. You will receive the predefined definition file from us.
14 14  
15 15  = Preparing for Data Exchange =
16 16  
17 17  (% class="wikigeneratedid" %)
18 -The following explains the steps that must be taken in ACMP and the REST client to enable proper data exchange. The settings for the REST client are shown using Insomnia REST as an example. However, any other REST client can be used in principle.
18 +The following explains the steps that must be taken in acmp and the REST client to enable proper data exchange. The settings for the REST client are shown using Insomnia REST as an example. However, any other REST client can be used in principle.
19 19  
20 -== Verbindungsaufbau vom ACMP zum AESB ==
20 +== Verbindungsaufbau vom acmp zum aesb ==
21 21  
22 -If you are already working with the AESB, you have likely established a connection from the ACMP to the AESB via the SICS. You can verify this in the ACMP console by navigating to System > Settings > ACMP Server > SICS Connection.
23 -If you have not entered any information about the AESB yet, you can read [[here>>doc:ACMP.610.ACMP-Solutions.System.Einstellungen.ACMP Server.WebHome||anchor="#HSICS-Verbindung"]] how to set up the connection.
22 +If you are already working with the aesb, you have likely established a connection from the acmp to the aesb via the SICS. You can verify this in the acmp console by navigating to System > Settings > acmp Server > SICS Connection.
23 +If you have not entered any information about the aesb yet, you can read [[here>>doc:ACMP.610.ACMP-Solutions.System.Einstellungen.ACMP Server.WebHome||anchor="HSICSconnection"]] how to set up the connection.
24 24  
25 25  {{aagon.infobox}}
26 -Please note the public API access rights setting in the SICS connection settings. Enabling access by checking the box will allow SICS users to execute public API commands. On the ACMP Server, every message from an unknown user will be interpreted as a SICS user and assigned administrative permissions. In this case, no permission check will be performed!
26 +Please note the public API access rights setting in the SICS connection settings. Enabling access by checking the box will allow SICS users to execute public API commands. On the acmp Server, every message from an unknown user will be interpreted as a SICS user and assigned administrative permissions. In this case, no permission check will be performed!
27 27  {{/aagon.infobox}}
28 28  
29 29  == Establishing a connection from the REST client to SICS ==
... ... @@ -45,7 +45,7 @@
45 45  2. Press Ctrl + E to open the Insomnia Environment Config. Enter the server URL //https:~/~/ 127.0.0.1:3900///.
46 46  
47 47  {{aagon.infobox}}
48 -The default port for the AESB REST API is 3900.
48 +The default port for the aesb REST API is 3900.
49 49  {{/aagon.infobox}}
50 50  
51 51  {{figure}}
... ... @@ -59,7 +59,7 @@
59 59  = Starting a Session =
60 60  
61 61  In order for data exchange to take place, a session — and thus a request — must be initiated.
62 -Log in to Insomnia, select the environment, and specify whether you want to use an ACMP or SICS user for the session.
62 +Log in to Insomnia, select the environment, and specify whether you want to use an acmp or SICS user for the session.
63 63  
64 64  {{figure}}
65 65  [[image:vmware_ti4pZCCmEj.png]]
... ... @@ -72,19 +72,19 @@
72 72  To use a SICS user, select "ConnectionRequest" on the right side of the command tree.
73 73  Enter the SICS user's name and password in the editing window. Finally, click Send.
74 74  
75 -== Use ACMP users ==
75 +== Use acmp users ==
76 76  
77 77  {{aagon.infobox}}
78 -We recommend creating a separate ACMP user for the connection if you decide to use an ACMP user.
78 +We recommend creating a separate acmp user for the connection if you decide to use an acmp user.
79 79  {{/aagon.infobox}}
80 80  
81 -If an ACMP user is to be used instead of a SICS user, a hash value must first be generated from a password.
81 +If an acmp user is to be used instead of a SICS user, a hash value must first be generated from a password.
82 82  
83 83  {{aagon.infobox}}
84 84  The tool for generating the hash value is available from Aagon Support.
85 85  {{/aagon.infobox}}
86 86  
87 -Then select Use Acmp under //Activate Environment//, enter the user name and the Acmp server name. Now click //Send// to obtain the salt and iteration count for hashing the password.
87 +Then select Use acmp under //Activate Environment//, enter the user name and the acmp server name. Now click //Send// to obtain the salt and iteration count for hashing the password.
88 88  
89 89  {{aagon.infobox}}
90 90  The value for “PasswordHash” must be calculated using the PBKDF2 algorithm, which uses HMAC_SHA256 and a HMAC length of 32, based on the following values. User password ‘Salt’ from the response “IterationCount” from the response.
... ... @@ -95,7 +95,7 @@
95 95  
96 96  = Create Callback Target =
97 97  
98 -A callback target stores the response that the ACMP Server sends in response to a request. This allows you to detect errors and respond accordingly. For better organization, it is recommended that you create a separate virtual router and store the callback target in it.
98 +A callback target stores the response that the acmp Server sends in response to a request. This allows you to detect errors and respond accordingly. For better organization, it is recommended that you create a separate virtual router and store the callback target in it.
99 99  Proceed as follows:
100 100  ~1. Create a VirtualRouter by selecting the CreateVirtualRouter command from the navigation menu. 2. Enter the desired name in the editing window and click Send.
101 101  2. Once the virtual router has been created, you can create the actual callback target. To do so, select "Create Target" from the navigation menu. In our example, we use the "Queue" TargetType because incoming messages are stored here until they are read manually.
... ... @@ -109,7 +109,7 @@
109 109  6. Then, click Send.
110 110  
111 111  {{aagon.infobox}}
112 -Please note that the content of the body must always be Base64 encoded. To encode, you can either use the Client Command available in ACMP or encode the text on this page.
112 +Please note that the content of the body must always be Base64 encoded. To encode, you can either use the Client Command available in acmp or encode the text on this page.
113 113  {{/aagon.infobox}}
114 114  
115 115  == Collect result ==
... ... @@ -116,13 +116,13 @@
116 116  
117 117  7. To check whether an error occurred when creating the asset, select the Consume command.
118 118  8. Click Send.
119 -9. The result from the ACMP is now displayed on the right side of the window.
119 +9. The result from the acmp is now displayed on the right side of the window.
120 120  
121 121  {{aagon.infobox}}
122 122  Please note that the content of the body is always returned Base64 encoded.
123 123  {{/aagon.infobox}}
124 124  
125 -To decode, you can either use the Client Command available in ACMP or decode the text on this page.
125 +To decode, you can either use the Client Command available in acmp or decode the text on this page.
126 126  
127 127  = Clean up resources =
128 128  
© Aagon GmbH 2026
Besuchen Sie unsere aagon-Community