Über die Funktion PUT /api/v1/management/clients/byCloud/{clientId} kann die bestehende Konfiguration eines Clients aktualisiert werden. Dabei wird die aktuell dem Terminal in der RetailForce Cloud zugewiesene Konfiguration heruntergeladen.
Ergebnis
Ein erfolgreicher Aufruf der Funktion (200)
- lädt das aktuell gültige Konfigurationsobjekt aus der RetailForce Cloud und speichert diese im Config-Store der Middleware.
Verwendung
Die Funktion wird verwendet um:
- Konfigurationsänderungen (Änderungen an der Konfiguration in der RetailForce Cloud) im Client zu übernehmen,
- die aktuelle Konfiguration nochmals herunterzuladen.
Voraussetzungen
- Der entsprechende Client wurde bereits aktiviert (Inbetriebnahme-Prozess abgeschlossen).
Formularfelder
Folgende Informationen müssen übermittelt werden:
| Bezeichnung | Beschreibung | Beispiele |
| clientId |
Die uniqueClientId der Registrierkasse (aus RetailForce System) |
c1062c55-57c4-4ed2-9c53-aff1762326a4 |
| cloudApiKey |
API Key um die Cloud-Kommunikation zu authentisieren |
RFC_4a2abc... |
| cloudApiSecret |
API Secret zur Authentisierung der Cloud-Kommunikation
Achtung: API secret muss immer unter einfachen Anführungszeichen gesetzt werden, z.B. 'ypmqt7s5UVZOyY9mDFzOeVgdpRnJ8GrOsQ'
|
ypts7u5OU... |
Antwort
Mögliche Antworten:
| Code | Beschreibung | Beispiel |
| 200 |
Konfiguration wurde erfolgreich heruntergeladen und im Config Store gespeichert. |
- |
| 404 |
Die angegebene ClientId ist im System nicht aktiv. Fehlerbehebung:
|
- |
| 422 |
Die angegebene clientId konnte im lokalen System nicht gefunden werden oder Zugangsdaten wurden nicht angegeben Fehlerbehebung:
|
- |
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.