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

Obszar ARCHIVE interfejsu API RetailForce Middleware (swagger) służy do przesyłania (i pobierania) danych do RetailForce Secure Archive bez stosowania fiskalizacji.

Korzystanie z funkcji / punktów końcowych w tym obszarze jest konieczne wyłącznie w przypadku wyłączenia fiskalizacji za pośrednictwem RetailForce Middleware, tj. gdy funkcja ta NIE jest używana.

W przypadku archiwizacji danych w ramach fiskalizacji wymagana jest jedynie odpowiednia licencja (przypisanie poprzez konfigurację). Przesyłanie danych fiskalnych do archiwum w Cloud jest wówczas realizowane automatycznie przez middleware do celów fiskalnych.

Metoda

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

służy do przesyłania danych do archiwum chmurowego RetailForce Cloud.

Wynik

Pomyślne wywołanie punktu końcowego (200) spowodowało przesłanie odpowiednich danych do bezpiecznego archiwum.

Zastosowanie

Za każdym razem, gdy dane mają zostać przesłane do archiwum w celu wykonania kopii zapasowej.

Wymagania wstępne

Zainstalowane oprogramowanie RetailForce Middleware (Fiscal) oraz
zainicjowany client,

Żądanie

Pola formularza

Należy przesłać następujące parametry:

Stanowisko	Opis	Przykład
clientId	Unikalny identyfikator klienta (uniqueClientId) kasy fiskalnej (z RetailForce systemu).	c1062c55-57c4-4ed2-9c53-aff1762326a4

Request body

Dane, które mają zostać przesłane do archiwum, należy odpowiednio określić. Odbywa się to za pomocą payloadu opisanego poniżej w żądaniu.

Przykład:

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

Informacje w kolumnie „Typ”:

M … obowiązkowe / wymagane
M* ... obowiązkowe / wymagane w niektórych krajach lub pod pewnymi warunkami
R … zalecane
O... opcjonalne

Elementy	Typ	Opis
typ	M	Definicja typu danych, które mają zostać przekazane do archiwum. Typy: 0 ... DSFinV-K (JSON) 1 ... DSFinV-K (CSV) 2 ... Dane kopii zapasowej (różne) Uwaga: Rozmiary plików są ograniczone w następujący sposób: Typ 0: 200 kB Typ 1: 200 kB Typ 2: 10 MB
kontener	M*	Nazwa (oznaczenie) kontenera (plik .zip) Uwaga: TYLKO jeśli Typ = 2 („type”: 2,)
entity	M*	Dane, które mają zostać przeniesione do archiwum (plik lub folder!).
rekurencyjny	M*	wartość „true”, jeśli mają zostać przesłane również podfoldery, w przeciwnym razie wartość „false”. Nie ma zastosowania, jeśli obiekt NIE jest folderem! Uwaga: TYLKO jeśli Typ = 2 („type”: 2,)

Odpowiedź

Możliwe odpowiedzi:

Kod	Opis	Przykład
200	Dane zostały pomyślnie przesłane	-

Ten artykuł został przetłumaczony automatycznie.