Dieser Endpunkt ermöglicht die Wiederherstellung eines Clients (Mandaten) in der RetailForce Middleware, mit Daten (inkl. Konfigurationsinformationen) aus der RetailForce Cloud.
Eine Wiederherstellung eines Clients kann etwa bei Wechsel der Registrierkassenhardware oder -defekten notwendig sein.
Die Funktion POST /api/v1/management/clients/recovery/restoreByCloud ist im Wesentlichen identisch zu PUT /api/v1/management/clients/byCloud allerdings kann Letzterer nur einmal bei der erstmaligen Inbetriebnahme eines Clients ausgeführt werden.
Ergebnis
Ein erfolgreicher Aufruf des Endpunktes (200):
- Lädt das Konfigurationsobjekt des betreffenden Clients aus dem Cloud-System erneut herunter und konfiguriert den Client dementsprechend.
- Stellt einen bereits vorher in Betrieb genommenen Client in der Middleware wieder her und weist diesem die entsprechende uniqueClientId des Terminals aus der RetailForce Cloud zu.
Verwendung
Dieser Endpunkt wird verwendet, wenn ein Client, der bereits einmal erstellt wurde und dessen ClientId bekannt ist, wiederhergestellt werden muss (etwa bei Wechsel der Hardware).
Voraussetzungen
- Der Client muss bereits einmal erstellt worden und die ClientId bekannt sein.
- Organisationsstruktur und Konfigurationsobjekt wurden in der RetailForce Cloud erstellt und entsprechend zugewiesen.
- Fiskal Middleware installiert.
- RestoreByCloud kann nur verwendet werden, wenn:
- eine entsprechende Lizenz verwendet wird (Lizenzpaket, welches 'Cloud Archive Access' inkludiert),
- die Checkbox 'Cloud Archive' in der Konfiguration (Cloud) aktiviert ist,
- der Client (VOR der Wiederherstellung) bereits Daten an das Cloud-Archiv übertragen hat.
- In Deutschland muss im Client zumindest ein Tagesabschluss (zu einem beliebigen Zeitpunkt in der Vergangenheit) verbucht und an das Cloud-Archiv übertragen worden sein.
Hinweis: RestoreByCloud funktioniert nur dann korrekt, wenn
- VOR einem RestoreByCloud die Middleware auf dem System neu installiert wurde,
- oder (ohne Neuinstallation), das Fiskalisierungs-Service (RetailForce Dienst), vor dem Ausführen von RestoreByCloud, neu gestartet wurde.
Formularfelder
Die folgende Information muss übermittelt werden:
| Bezeichnung | Beschreibung | Beispiele |
| Type |
Typ der Unternehmensidentifikation. Der Type muss auch in der RetailForce Cloud eingetragen worden und vorhanden sein. Folgende Typen stehen zur Verfügung: [0] = VatNumber, Siehe auch: Unternehmensidentifikation Wir empfehlen Typ [0] = VatNumber als primäre ID in allen Ländern (EU) zu verwenden, auch wenn diese nicht als verpflichtendes Unternehmenskennzeichen im jeweiligen Land verwendet wird. |
[0] = VatNumber |
| Identification | Das Unternehmenskennzeichen selbst. Muss mit den Informationen, welche in der RetailForce Cloud eingetragen wurden, übereinstimmen. | ATU57780814 |
| storeNumber |
Die Nummer der Filiale, in welcher sich die Kasse befindet. Muss mit den Informationen, welche in der RetailForce Cloud eingetragen wurden, übereinstimmen.
ACHTUNG: in Frankreich ist hier die SIRET (Erweiterung der SIREN um die Filialnummer) anzugeben.
|
|
| terminalNumber | Kassennummer. Muss mit den Informationen, welche in der RetailForce Cloud eingetragen wurden, übereinstimmen. | 0010 |
| cloudApiKey | API Key um die Cloud-Kommunikation zu authentisieren | RFC_4a2abc... |
| cloudApiSecret | API Secret zur Authentisierung der Cloud-Kommunikation | ypts7u5OU... |
Antwort
Mögliche Antworten:
| Code | Beschreibung | Beispiel |
| 200 | Der Client wurde erfolgreich wiederhergestellt und konfiguriert. Als Response-Objekt wird die uniqueClientId des wiederhergestellten Clients zurückgegeben. Die uniqueClientId muss vom Kassensystem gespeichert und für den gesamten weiteren Kommunikations-Prozess (den Client betreffend) vom Kassensystem verwendet werden. | b7cf6d59-cec4-4cc2-a647-01XXXX |
| 406 |
Typ des angegebenen Unternehmenskennzeichens ist kein eindeutiger Typ. Fehlerbehandlung: Verwenden Sie einen der folgenden Unternehmenskennzeichen: [0] = VatNumber, |
- |
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.