Denna slutpunkt möjliggör återställning av en client i RetailForce Middleware med data (inklusive konfigurationsinformation) från RetailForce Cloud.
Det kan bli nödvändigt att återställa en client vid byte av kassahårdvara eller vid hårdvarufel.
Funktionen POST /api/v1/management/clients/recovery/restoreByCloud/ID är i princip identisk med PUT /api/v1/management/clients/byCloud, men den senare kan endast utföras en gång vid den initiala driftsättningen av en client.
Resultat
Ett lyckat anrop till slutpunkten (200):
- Laddar ned konfigurationsobjektet för den aktuella klienten på nytt från Cloud-systemet och konfigurerar klienten därefter.
- Återställer en klient som redan har tagits i drift i middleware och tilldelar den motsvarande uniqueClientId för terminalen från RetailForce Cloud.
Användning
Denna slutpunkt används när en client, som redan har skapats en gång och vars clientId är känt, behöver återställas (till exempel vid byte av hårdvara).
Förutsättningar
- Clients must have been created once and clientId must be known.
- Organisationsstruktur och konfigurationsobjekt har skapats i RetailForce Cloud och tilldelats på lämpligt sätt.
- Fiscal Middleware är installerat.
- RestoreByCloud kan endast användas om:
- en motsvarande licens används (licenspaket som inkluderar ”Cloud Archive Access”),
- checkboxen ”Cloud Archive” är markerad i konfigurationen (Cloud),
- clienten redan har överfört data till molnarkivet (INNAN återställningen).
- I Tyskland måste minst en daglig avstängning (när som helst i det förflutna) ha registrerats i klienten och överförts till Cloud-arkivet.
Obs: restoreByCloud fungerar endast korrekt om
- middleware har installerats på nytt på systemet INNAN restoreByCloud körs,
- eller (utan ominstallation) att fiscalisationstjänsten (RetailForce-tjänsten) har startats om innan restoreByCloud körs.
Formulärfält
Följande information måste överföras:
| Namn | Beskrivning | Exempel |
| Typ |
Typ av företagsidentifikation. Typen måste också anges och finnas i RetailForce Cloud. Följande typer finns tillgängliga: [0] = VatNumber, Se även: Företagsidentifikation Vi rekommenderar att typ [0] = VatNumber används som primärt ID i alla länder (EU), även om det inte används som obligatorisk företagsidentifierare i respektive land. |
[0] = VatNumber |
| Identifiering | Själva företagsidentifieraren. Den måste stämma överens med den information som angavs i RetailForce Cloud. | ATU57780814 |
| storeNumber |
Numret på den butik där kassan är placerad. Det måste stämma överens med den information som angivits i RetailForce Cloud.
OBS:
I Frankrike ska SIRET-numret (en utvidgning av SIREN-numret med butiksnumret) anges här.
|
|
| terminalNumber | Kassanummer. Det måste stämma överens med den information som angavs i RetailForce Cloud. | 0010 |
| cloudApiKey | API-nyckel för att autentisera kommunikationen med Cloud | RFC_4a2abc... |
| cloudApiSecret | API Secret för autentisering av Cloud-kommunikationen | ypts7u5OU... |
Svar
Möjliga svar:
| Kod | Beskrivning | Exempel |
| 200 | Klienten har återställts och konfigurerats. Svarobjektet returnerar uniqueClientId för den återställda klienten. uniqueClientId måste lagras av kassasystemet och användas under hela den fortsatta kommunikationsprocessen (avseende klienten). | b7cf6d59-cec4-4cc2-a647-01XXXX |
| 406 |
Typen för den angivna företagsidentifieraren är inte en unik typ. Felhantering: Använd en av följande företagsidentifierare: [0] = VatNumber, |
- |
Den här artikeln har översatts automatiskt.
Kommentarer
0 kommentarer
logga in för att lämna en kommentar.