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

Tento koncový bod vytvorí nového klienta vo Fiscal Middleware a prepojí ho s terminálom v RetailForce Cloud. Predstavuje prvý krok pri uvedení novej pokladnice do prevádzky.

Výsledky

Úspešné volanie koncového bodu (200)

vytvorí nového klienta v middleware, priradí mu uniqueClientId terminálu (Cloud) a
stiahne konfiguračný objekt z Cloud systému a klienta podľa toho nakonfiguruje.

Použitie

Jednorazovo, pri uvedení novej pokladnice do prevádzky. Opätovné volanie koncového bodu pre toho istého klienta (clientId) spôsobí chybu!

POZOR : ak bol konkrétny klient už raz pripojený k terminálu vytvorenému v cloude (priradenie uniqueClientId), opätovné volanie koncového bodu vyvolá chybovú správu: „409 – Klient už existuje“. Ak je potrebné klienta vytvoriť znovu (napr. v dôsledku poruchy pevného disku atď.), je potrebné použiť koncový bod /api/v1/management/clients/recovery/restoreByCloud.

Predpoklady

Organizačná štruktúra a konfiguračný objekt boli vytvorené v RetailForce Cloud a príslušne priradené
Nainštalovaný Fiscal Middleware

Polia formulára

Je potrebné odoslať nasledujúce informácie:

Označenie	Popis	Príklad
Typ	Typ identifikácie spoločnosti. Typ musí byť tiež zadaný a musí existovať v RetailForce Cloud. K dispozícii sú nasledujúce typy: [0] = VatNumber, [1] = taxNumber, [2] = GLN číslo, [3] = BusinessIdentificationNumber, [4] = štatistická klasifikácia, [5] = číslo v obchodnom registri, [6] = úrad obchodného registra, [7] = číslo v živnostenskom registri Pozri tiež: Identifikácia spoločnosti Odporúčame používať typ [0] = VatNumber ako primárne ID vo všetkých krajinách (EÚ), aj keď sa v danej krajine nepoužíva ako povinný identifikátor spoločnosti.	[0] = VatNumber
Identifikácia	Samotná identifikácia spoločnosti. Musí zodpovedať informáciám zadaným v RetailForce Cloud.	ATU57780814
storeNumber	Číslo pobočky/predajne, kde sa nachádza pokladňa. Musí zodpovedať informáciám zadaným v RetailForce Cloud. POZOR: vo Francúzsku sa tu musí uviesť SIRET (rozšírenie čísla SIREN o číslo pobočky).	S001, 12345 atď.
terminalNumber	Číslo pokladnice. Musí zodpovedať informáciám zadaným v RetailForce Cloud.	0010
cloudApiKey	Kľúč API na overenie komunikácie s cloudom	RFC_4a2abc...
cloudApiSecret	API Secret na overenie komunikácie s cloudom	ypts7u5OU...

Odpoveď

Možné odpovede:

Kód	Popis	Príklad
200	Client bol úspešne vytvorený a nakonfigurovaný. Ako objekt odpovede sa vráti uniqueClientId. POS systém musí uniqueClientId uložiť a používať ho počas celého ďalšieho komunikačného procesu (týkajúceho sa klienta).	3fa85f64-5717-4562-b3fc-2c963f66afa6
404	V službe RetailForce Cloud nebola pre zadané ID spoločnosti nájdená žiadna organizácia. Riešenie problémov: Skontrolujte ID spoločnosti v RetailForce Cloud a na pokladni. Vytvorte spoločnosť (organizáciu alebo firmu) v RetailForce Cloud	-
406	Vzhľadom na zadaný typ (kód spoločnosti) nie je možné jednoznačné priradenie (napr. pri použití [6] = CommercialRegisterNumberOffice). Riešenie problémov: Použite iný typ ID (napr. [0] = VatNumber)	-
409	V službě Fiscal Service (Fiscal Middleware) už existuje klient s príslušným uniqueClientId. Riešenie problému: Použite existujúceho klienta	-

Tento článok bol preložený automaticky.