Ten punkt końcowy umożliwia przywrócenie klienta w oprogramowaniu pośredniczącym RetailForce Middleware wraz z danymi (w tym informacjami konfiguracyjnymi) z RetailForce Cloud.
Przywrócenie klienta może okazać się konieczne w przypadku wymiany sprzętu kasowego lub wystąpienia usterek sprzętowych.
Funkcja POST /api/v1/management/clients/recovery/restoreByCloud/ID jest zasadniczo identyczna z funkcją PUT /api/v1/management/clients/byCloud, jednak ta ostatnia może zostać wykonana tylko raz podczas pierwszego uruchomienia klienta.
Wynik
Pomyślne wywołanie punktu końcowego (200):
- Powoduje ponowne pobranie obiektu konfiguracyjnego dla danego klienta z systemu Cloud i odpowiednie skonfigurowanie klienta.
- Przywraca klienta, który został już uruchomiony w middleware, i przypisuje mu odpowiedni identyfikator uniqueClientId terminala z RetailForce Cloud.
Zastosowanie
Ten punkt końcowy jest wykorzystywany w sytuacji, gdy konieczne jest przywrócenie klienta, który został już wcześniej utworzony i którego identyfikator clientId jest znany (na przykład w przypadku wymiany sprzętu).
Wymagania wstępne
- Client musi zostać wcześniej utworzony, a jego identyfikator clientId powinien być znany.
- W RetailForce Cloud utworzono strukturę organizacyjną oraz obiekt konfiguracyjny i przypisano je odpowiednio.
- Zainstalowano oprogramowanie Fiscal Middleware.
- Funkcja restoreByCloud może być wykorzystana wyłącznie pod warunkiem:
- korzysta się z odpowiedniej licencji (pakiet licencyjny obejmujący opcję „Cloud Archive Access”),
- w konfiguracji (Cloud) zaznaczone jest checkbox „Cloud Archive”,
- client przesłał już dane do archiwum w chmurze (PRZED przywróceniem).
- In Germany, in the client system, at least one daily closure (from any point in the past) must be registered and sent to the Cloud archive.
Uwaga: Funkcja restoreByCloud będzie działać poprawnie tylko wtedy, gdy
- middleware zostało na nowo zainstalowane w systemie PRZED uruchomieniem funkcji restoreByCloud,
- lub (bez ponownej instalacji) usługa fiskalizacji (usługa RetailForce) została ponownie uruchomiona przed uruchomieniem funkcji restoreByCloud.
Pola formularza
Należy przesłać następujące informacje:
| Nazwa | Opis | Przykłady |
| Typ |
Typ identyfikatora firmy. Należy również wprowadzić typ, który musi istnieć w systemie RetailForce Cloud. Dostępne są następujące typy: [0] = VatNumber, Zobacz także: Identyfikator firmy Zalecamy stosowanie typu [0] = VatNumber jako głównego ID we wszystkich krajach (UE), nawet jeśli nie jest on używany jako obowiązkowy ID przedsiębiorstwa w danym kraju. |
[0] = VatNumber |
| Identyfikacja | Sam identyfikator przedsiębiorstwa. Musi on być zgodny z informacjami wprowadzonymi w RetailForce Cloud. | ATU57780814 |
| storeNumber |
Numer sklepu, w którym znajduje się kasa fiskalna. Musi on być zgodny z danymi wprowadzonymi w RetailForce Cloud.
UWAGA:
we Francji należy podać tutaj numer SIRET (rozszerzenie numeru SIREN o numer sklepu).
|
|
| terminalNumber | Numer kasy fiskalnej. Musi on być zgodny z danymi wprowadzonymi w RetailForce Cloud. | 0010 |
| cloudApiKey | Klucz API służący do uwierzytelniania komunikacji z Cloud | RFC_4a2abc... |
| cloudApiSecret | API Secret służący do uwierzytelniania komunikacji z Cloud | ypts7u5OU... |
Odpowiedź
Możliwe odpowiedzi:
| Kod | Opis | Przykład |
| 200 | Klient został pomyślnie przywrócony i skonfigurowany. Obiekt odpowiedzi zwraca identyfikator uniqueClientId przywróconego klienta. Identyfikator uniqueClientId musi zostać zapisany w systemie kasowym i wykorzystywany w całym dalszym procesie komunikacji (dotyczącym tego klienta). | b7cf6d59-cec4-4cc2-a647-01XXXX |
| 406 |
Typ podanego identyfikatora firmy nie jest typem unikalnym. Postępowanie w przypadku błędu: Proszę użyć jednego z poniższych identyfikatorów firmy: [0] = VatNumber, |
- |
Ten artykuł został przetłumaczony automatycznie.
Komentarze
Komentarze: 0
Zaloguj się, aby dodać komentarz.