PUT /api/v1/management/clients/ byCloud – RetailForce

Questo endpoint crea un nuovo client nel Fiscal Middleware e lo collega a un terminal nel RetailForce Cloud. Rappresenta il primo passo nella messa in servizio di un nuovo registratore di cassa.

Risultati

Una chiamata riuscita all’endpoint (200)

crea un nuovo client nel middleware, gli assegna l’uniqueClientId del terminal (Cloud) e
scarica l’oggetto di configurazione dal sistema Cloud e configura il client di conseguenza.

Utilizzo

L’operazione va eseguita una sola volta, al momento della messa in funzione di un nuovo registratore di cassa. Una nuova chiamata all’endpoint per lo stesso client (clientId) genererà un errore.

ATTENZIONE : se un determinato client è già stato associato una volta al terminal creato nel cloud (assegnazione dell’uniqueClientId), richiamare l’endpoint genererà un messaggio di errore: «409 - Il client esiste già». Qualora fosse necessario ricreare un client (ad es. in caso di guasto del disco rigido, ecc.), occorre utilizzare l’endpoint /api/v1/management/clients/recovery/restoreByCloud.

Prerequisiti

La struttura organizzativa e l’oggetto di configurazione sono stati creati nel RetailForce Cloud e assegnati di conseguenza
Fiscal Middleware installato

Campi del modulo

È necessario fornire le seguenti informazioni:

Designazione	Descrizione	Esempio
Tipo	Tipo di identificazione aziendale. Il tipo deve essere stato inserito e deve essere presente nel RetailForce Cloud. Sono disponibili i seguenti tipi: [0] = VatNumber, [1] = taxNumber, [2] = GLNNumber, [3] = BusinessIdentificationNumber, [4] = Classificazione statistica, [5] = Numero di iscrizione al registro delle imprese, [6] = Ufficio di iscrizione al registro delle imprese, [7] = Numero di iscrizione al registro commerciale 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 della filiale/del punto vendita in cui è installato il registratore di cassa. Deve corrispondere alle informazioni inserite in RetailForce Cloud. ATTENZIONE: in Francia, in questo campo deve essere indicato il SIRET (estensione del SIREN con il numero di filiale).	S001, 12345 ecc.
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 cloud	ypts7u5OU...

Risposta

Possibili risposte:

Codice	Descrizione	Esempio
200	Il client è stato creato e configurato con successo. Il uniqueClientId viene restituito come oggetto di risposta. L’uniqueClientId deve essere persistito dal sistema POS e utilizzato dallo stesso per l’intero processo di comunicazione successivo (relativo al client).	3fa85f64-5717-4562-b3fc-2c963f66afa6
404	Non è stata trovata alcuna organizzazione nel RetailForce Cloud per l’ID aziendale specificato. Risoluzione dei problemi: Verifichi l’ID aziendale in RetailForce Cloud e presso il registratore di cassa. Creare un’azienda (organizzazione o società) in RetailForce Cloud	-
406	A causa del tipo specificato (codice aziendale), non è possibile effettuare un'assegnazione univoca (ad es. quando si utilizza [6] = CommercialRegisterNumberOffice). Risoluzione dei problemi: Utilizzare un tipo di ID diverso (ad es. [0] = VatNumber)	-
409	Nel Fiscal Service (Fiscal Middleware) è già presente un client con l’uniqueClientId in questione. Risoluzione del problema: Utilizzare il client esistente.	-

Questo articolo è stato tradotto automaticamente.