The configuration of a client can be updated via the function PUT /api/v1/management/clients/byCloud/{clientId}. This downloads the configuration currently assigned to the terminal in the RetailForce Cloud.
Attention: This method requests the configuration from the cloud. This incurs GetConfiguration licence costs. Extensive use can result in high costs.
Result
A successful call of the function (200)
- loads the currently valid configuration object from the RetailForce Cloud and stores it in the middleware's Config Store.
Usage
The function is used to:
- apply configuration changes (changes to the configuration in the RetailForce Cloud) in the client,
- download the current configuration again.
Prerequisites
- The corresponding client has already been activated (commissioning process completed).
Form fields
The following information must be submitted:
| Designation | Description | Example |
| clientId |
The uniqueClientId of the cash register (from RetailForce system). |
c1062c55-57c4-4ed2-9c53-aff1762326a4 |
| cloudApiKey |
API Key to authorise cloud communication. |
RFC_4a2abc... |
| cloudApiSecret |
API Secret for authorising cloud communication
Attention: API secret must always be placed under single quotes, e.g. 'ypmqt7s5UVZOyY9mDFzOeVgdpRnJ8GrOsQ'
|
ypts7u5OU... |
Response
Possible responses:
| Code | Beschreibung | Beispiel |
| 200 |
Configuration has been successfully downloaded and saved in the Config Store. |
- |
| 404 |
The specified ClientId is not active in the system. Troubleshooting:
|
- |
| 422 |
The specified clientId could not be found in the local system or access data were not specified Troubleshooting:
|
- |
Comments
0 comments
Please sign in to leave a comment.