POST /api/v1/archive/de/{clientId} – RetailForce

L’area ARCHIVE dell’API del middleware (Swagger) viene utilizzata per trasmettere (e scaricare) dati all’RetailForce Secure Archive senza ricorrere alla fiscalizzazione.

L’utilizzo delle funzioni/endpoint presenti in quest’area è necessario solo se la fiscalizzazione è disattivata tramite il RetailForce Middleware, ovvero NON viene utilizzata.

Per l’archiviazione dei dati nell’ambito della fiscalizzazione, è necessaria solo una licenza corrispondente (assegnazione tramite configurazione). Il caricamento dei dati fiscali nel Cloud archivio viene quindi gestito automaticamente dal middleware fiscale.

endpoint POST /api/v1/archive/de/{clientId}

viene utilizzato per trasferire i dati all’archivio Cloud di RetailForce.

Risultato

Una chiamata riuscita all’endpoint (200) ha trasmesso i dati corrispondenti all’archivio sicuro.

Utilizzo

Ogni volta che è necessario trasmettere dati all’archivio a scopo di backup.

Prerequisiti

RetailForce (Fiscal) middleware installato e
il client sia stato inizializzato,

Richiesta

Campi del modulo

È necessario inviare i seguenti parametri:

Designazione	Descrizione	Esempio
clientId	The uniqueClientId del registratore di cassa (dal sistema RetailForce).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Corpo della richiesta

I dati da trasmettere all’archivio devono essere specificati di conseguenza. Ciò avviene tramite il payload descritto di seguito nella richiesta.

Esempio:

[
  {
    "type": 0,
    "container": "string",
    "entity": "string",
    "recursive": true
  }
]

Informazioni nella colonna «Tipo»:

M ... obbligatorio / richiesto
M* ... obbligatorio / richiesto in determinati paesi o a determinate condizioni
R ... raccomandato
O... facoltativo

Elementi	Tipo	Descrizione
tipo	M	Definizione del tipo di dati da trasferire all'archivio. Tipi: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Dati di backup (eterogenei) Nota: le dimensioni dei file sono soggette alle seguenti limitazioni: Tipo 0: 200 kB Tipo 1: 200 kB Tipo 2: 10 MB
contenitore	M*	Il nome (designazione) del contenitore (file .zip) Nota: SOLO se Tipo = 2 ("type": 2,)
entità	M*	Dati da trasferire nell’archivio (file o cartella).
ricorsivo	M*	true se devono essere trasmesse anche le sottocartelle, altrimenti falso. Non applicabile se l’entità NON è una cartella. Nota: SOLO se Tipo = 2 ("type": 2,)

Risposta

Risposte possibili:

Codice	Descrizione	Esempio
200	I dati sono stati trasmessi con successo	-

Questo articolo è stato tradotto automaticamente.