Az ügyfél üzembe helyezéséhez szükséges lépések áttekintése:
- Szervezeti struktúra létrehozása
- Konfigurálás
- Cloud-kapcsolat létrehozása
- Az ügyfél inicializálása
1. Szervezeti felépítés létrehozása
Az üzembe helyezés első lépéseként először meg kell alkotni a pénztárgépet üzemeltető vállalat szervezeti felépítését a RetailForce Cloudban. Erről részletes információkat a linkelt cikkben talál.
Ez a lépés kihagyható azoknál a rendszereknél, amelyek teljesen offline módon működnek, és soha nem létesítenek kapcsolatot a RetailForce Clouddal.
2. Konfigurálás
A middleware kliens konfigurálása alapvetően kétféle módon végezhető el (a pénztárgép-szoftver gyártója és a pénztárgép-üzemeltető vállalat által megállapított beállításoktól és megállapodásoktól függően):
- Konfigurálás a RetailForce Cloudon keresztül, vagy alternatívaként
- Konfigurálás POS-szoftver (pénztárgép-rendszer, elektronikus nyilvántartási rendszer) segítségével
1. Konfigurálás a RetailForce Cloudon keresztül
Ebben a változatban a client letölti a RetailForce Cloudban előkészített konfigurációs objektumot a helyi rendszerére. Ez automatikus konfigurációnak tekinthető. A konfigurációs objektumok létrehozását a linkelt cikk ismerteti.
A pénzügyi egység felhőn keresztüli konfigurálásakor a rendszer által igényelt összes adat már előre be van állítva a Cloud-ban (utasítások és általános információk a konfiguráció létrehozásáról). Ezeket az adatokat a pénzügyi kliens egy hívás (CreateClientByCloud) segítségével tölti be a Cloud-ból.
A hívás paraméterei a következők:
- Vállalati azonosító (companyIdentification), általában az áfa-azonosító szám (VatNumber). Az adóügyi országtól függően szükség lehet más azonosító jellemzők megadására is, alternatívaként vagy kiegészítésként (!). Az induláshoz azonban az áfa-azonosító szám használata ajánlott.
- Üzlet-/fiók száma
- Pénztárgép száma
- cloudApiKey
- cloudApiSecret
Ha a PUT api/v1/management/clients/byCloud funkció hiba nélkül végrehajtódik, a pénzügyi kliens konfigurálása befejeződött. A pénzügyi modul GUID-ja (=clientId) visszatérési értékként kerül továbbításra.
2. Konfigurálás POS-szoftver segítségével
A RetailForce Cloud systemen keresztüli automatikus klienskonfiguráció alternatívájaként a konfigurációs objektumot a POS-szoftver is előkészítheti. Ezt a típusú konfigurációt olyan rendszereknél alkalmazzák, amelyek nem rendelkeznek kapcsolattal a RetailForce Cloudhoz. Ehhez a /api/v1/management/clients végpontot használják.
A pénztárgép-szoftver konfigurálásakor kétféle módon lehet a modult helyesen elindítani:
- Felhőkapcsolat nélküli modul helyi adattárolással és exportálással
- Felhőkapcsolattal rendelkező modul, helyi és Cloud-alapú adattárolással és exporttal
Minden esetben szükséges, hogy a szükséges konfigurációs paramétereket a dokumentáció szerint helyesen állítsák be.
A 2. változat (felhőkapcsolattal) később is aktiválható, azaz lehetséges felhőkapcsolat nélkül létrehozni egy adóügyi konfigurációt, majd azt szinkronizálni a Cloud-val.
Fontos megjegyezni, hogy a Cloud-ban történő client létrehozását a POS-szoftver gyártójának és/vagy a szervezetnek engedélyeznie kell a Cloud-beállításokban. A szokásos eljárás az, hogy először egy konfigurációs objektumot hozunk létre a Cloud-ban.
3. Cloud-kapcsolat létrehozása
A következő lépés az ügyfél csatlakoztatása a RetailForce Cloudhoz (offline rendszerek esetében, felhőkapcsolat nélkül, ez a lépés kihagyható). Ez a következő függvény segítségével történik:
A hívás paraméterei:
- clientId – az egyedi kliens-azonosító (Guid), amelyet a RetailForce Cloudon keresztül történő konfiguráláskor a pénztárgép kapott.
- cloudApiKey
- cloudApiSecret
Az API-kulcsot és az API Secret-et a POS-szoftvernek kell elmentenie. A client nem menti el ezeket az információkat!
4. Client inicializálása
Az InitializeClient függvény (POST /api/v1/management/clients/initialize) meghívásával, a (start document) paraméterrel az adott országra vonatkozó inicializálási rutin hívódik meg, amely során (szükség esetén) a biztonsági komponensek is inicializálódnak.
Ország- és/vagy hardverspecifikus témákkal kapcsolatban kérjük, olvassa el a vonatkozó dokumentációt.
A kezdő dokumentum a szolgáltatástól a következő függvény végrehajtásával kérhető le:
-
GET /api/v1/transactions/document/{clientId}/start
(parameter: clientId, optional: BookDate).
Ha a FiscalClient-et fiskalizálás nélkül (NoFiscalisation) használják, például ha csak digitális nyugtákat vagy archív adatokat továbbítanak a clientnek, az inicializálás nem szükséges.
- Az inicializálási funkció meghívása (InitializeClient – POST /api/v1/management/clients/initialize)
A pénzügyi egység inicializálása ezután az InitializeClient hívással történik.
Az InitializeClient függvénynek egy NullReceipt-et kell átadni, egy példát alább talál:
{
"modelVersion": "1.5.2",
"uniqueClientId": "c1062c55-57c4-4ed2-9c53-aff1762326a4",
"additionalFields": {},
"documentGuid": "5efa5306-fe53-452d-9c81-68329475eee0",
"documentId": "1",
"createDate": "2025-05-02T07:08:17.8334419+02:00",
"bookDate": "2025-05-02T07:08:17.8335535+02:00",
"documentNumber": "1",
"documentType": 1000,
"documentTypeCaption": "Startbeleg",
"user": {
"id": "1",
"caption": "User 1",
"firstName": "1",
"lastName": "User",
"dateOfEntry": "2025-05-02T07:08:17.833596+02:00"
},
"allocationGroups": [],
"positionCount": 0,
"fiscalDocumentNumber": 1,
"fiscalDocumentRevision": 1,
"positions": [],
"Payments": [],
"additionalHeader": [],
"additionalFooter": [],
"fiscalAdditionalFields": {}
}
Az inicializálási folyamat alapvetően országspecifikus, de a hívás minden ország esetében azonos marad. Az országspecifikus inicializálásokkal kapcsolatos részletekért kérjük, olvassa el az adott ország dokumentációját.
Az üzembe helyezés áttekintése
Az ügyfél üzembe helyezéséhez a következő függvényeket kell a megadott sorrendben meghívni:
| Funkció | Leírás |
| PUT api/v1/management/clients/byCloud |
|
|
|
|
|
|
Kapcsolódó cikkek
Hibakezelés
Hiba: A <CLIENTID> ügyfél GetConfiguration parancsa nem található
Ezt a cikket automatikusan lefordították.
Hozzászólások
0 hozzászólás
Hozzászólások írásához jelentkezzen be.