Questo endpoint consente il ripristino di un client nel RetailForce Middleware, con i dati (comprese le informazioni di configurazione) provenienti dal RetailForce Cloud.
Il recupero del client può rendersi necessario in caso di sostituzione dell’hardware del registratore di cassa o di difetti hardware.
La funzione POST /api/v1/management/clients/recovery/restoreByCloud/ID è sostanzialmente identica a PUT /api/v1/management/clients/byCloud; tuttavia, quest’ultima può essere eseguita una sola volta durante la messa in servizio iniziale di un client.
Risultato
Una chiamata riuscita all’endpoint (200):
- Scarica nuovamente l’oggetto di configurazione per il client in questione dal sistema Cloud e configura il client di conseguenza.
- Ripristina un client già messo in funzione nel middleware e gli assegna il corrispondente uniqueClientId del terminal proveniente dal RetailForce Cloud.
Utilizzo
Questo endpoint viene utilizzato quando è necessario ripristinare un client già creato in precedenza e di cui è noto il clientId (ad esempio in caso di sostituzione dell’hardware).
Prerequisiti
- Il client deve essere stato creato in precedenza e il ClientId deve essere noto.
- La struttura organizzativa e l’oggetto di configurazione devono essere stati creati in RetailForce Cloud e assegnati di conseguenza.
- Il middleware fiscale deve essere installato.
- RestoreByCloud può essere utilizzato solo se:
- si disponga di una licenza corrispondente (pacchetto licenze che includa «Cloud Archive Access»),
- la casella di controllo «Cloud Archive» sia abilitata nella configurazione (Cloud),
- il client abbia già trasferito i dati all’archivio Cloud (PRIMA del ripristino).
- In Germania, nel client deve essere stata registrata e trasferita all’archivio Cloud almeno una chiusura giornaliera (in qualsiasi momento nel passato).
Nota: restoreByCloud funzionerà correttamente solo se
- il middleware sia stato installato ex novo sul sistema PRIMA di eseguire restoreByCloud,
- oppure, in assenza di reinstallazione, il servizio di fiscalizzazione (servizio RetailForce) sia stato riavviato prima di eseguire restoreByCloud.
Campi del modulo
È necessario trasmettere le seguenti informazioni:
| Nome | Descrizione | Esempi |
| Tipo |
Tipo di identificativo aziendale. È necessario specificare il tipo, che deve essere presente nel RetailForce Cloud. Sono disponibili i seguenti tipi: [0] = VatNumber, Vedi anche: Identificativo aziendale Si raccomanda di utilizzare il Tipo [0] = VatNumber come ID primario in tutti i paesi dell’Unione Europea, anche qualora non fosse l’ID aziendale obbligatorio nel paese specifico. |
[0] = VatNumber |
| Identificazione | L’identificativo univoco dell’organizzazione. Deve corrispondere esattamente alle informazioni registrate in RetailForce Cloud. | ATU57780814 |
| storeNumber |
Il numero del punto vendita in cui è installato il registratore di cassa. Deve corrispondere alle informazioni configurate in RetailForce Cloud.
NOTA:
in Francia, in questa sezione deve essere indicato il SIRET (estensione del SIREN con l’aggiunta del numero del punto vendita).
|
|
| terminalNumber | Numero del registratore di cassa. Deve corrispondere alle informazioni inserite in RetailForce Cloud. | 0010 |
| cloudApiKey | Chiave API per l’autenticazione della comunicazione con il Cloud | RFC_4a2abc... |
| cloudApiSecret | API Secret per l’autenticazione della comunicazione con il Cloud | ypts7u5OU... |
Risposta
Possibili risposte:
| Codice | Descrizione | Esempio |
| 200 | Il cliente è stato ripristinato e configurato con successo. L’oggetto di risposta restituisce l’uniqueClientId del cliente ripristinato. L’uniqueClientId deve essere memorizzato dal sistema di cassa e utilizzato per l’intero processo di comunicazione successivo (relativo al cliente). | b7cf6d59-cec4-4cc2-a647-01XXXX |
| 406 |
Il tipo dell’identificativo aziendale specificato non è univoco. Gestione degli errori: Utilizzare uno dei seguenti identificativi aziendali: [0] = VatNumber, |
- |
Questo articolo è stato tradotto automaticamente.
Commenti
0 commenti
Accedi per aggiungere un commento.