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

Denna slutpunkt skapar en ny client i Fiscal Middleware och kopplar den till en terminal i RetailForce Cloud. Det utgör det första steget i driftsättningen av en ny kassaapparat.

Resultat

Ett lyckat anrop till slutpunkten (200)

skapar en ny klient i middleware, tilldelar den terminalens (Clouds) uniqueClientId och
laddar ner konfigurationsobjektet från Cloud-systemet och konfigurerar clienten därefter.

Användning

En gång, när en ny kassa tas i drift. Om du anropar slutpunkten igen för samma klient (clientId) kommer det att resultera i ett fel!

OBSERVERA : Om en specifik klient redan har kopplats en gång till den terminal som skapats i molnet (tilldelning av uniqueClientId), kommer ett nytt anrop till slutpunkten att resultera i ett felmeddelande: ”409 – Klienten finns redan”. Om en klient måste skapas på nytt (t.ex. vid hårddiskfel m.m.) måste slutpunkten /api/v1/management/clients/recovery/restoreByCloud användas.

Förutsättningar

Organisationsstrukturen och konfigurationsobjektet har skapats i RetailForce Cloud och tilldelats på rätt sätt
Fiscal Middleware är installerat

Formulärfält

Följande information måste anges:

Benämning	Beskrivning	Exempel
Typ	Typ av företagsidentifikation. Typen måste också ha angetts och finnas i RetailForce Cloud. Följande typer finns tillgängliga: [0] = VatNumber, [1] = taxNumber, [2] = GLN-nummer, [3] = BusinessIdentificationNumber, [4] = statistisk klassificering, [5] = handelsregisternummer, [6] = handelsregisterkontor, [7] = handelsregistreringsnummer Se även: Företagsidentifikation Vi rekommenderar att typ [0] = VatNumber används som primärt ID i alla länder (EU), även om det inte används som obligatorisk företagsidentifierare i respektive land.	[0] = VatNumber
Identifiering	Själva företagsidentifieringen. Måste stämma överens med den information som angetts i RetailForce Cloud.	ATU57780814
storeNumber	Numret på den filial/butik där kassan är placerad. Måste stämma överens med den information som angetts i RetailForce Cloud. OBSERVERA: I Frankrike måste SIRET-numret (en utvidgning av SIREN-numret med filialnumret) anges här.	S001, 12345 osv.
terminalNumber	Kassanummer. Måste stämma överens med de uppgifter som angetts i RetailForce Cloud.	0010
cloudApiKey	API-nyckel för att autentisera molnkommunikationen	RFC_4a2abc...
cloudApiSecret	API Secret för autentisering av molnkommunikation	ypts7u5OU...

Svar

Möjliga svar:

Kod	Beskrivning	Exempel
200	Clienten har skapats och konfigurerats. uniqueClientId returneras som svarsobjekt. uniqueClientId måste sparas av POS-systemet och användas av POS-systemet under hela den fortsatta kommunikationsprocessen (avseende klienten).	3fa85f64-5717-4562-b3fc-2c963f66afa6
404	Ingen organisation hittades i RetailForce Cloud för det angivna företags-ID:t. Felsökning: Kontrollera företags-ID i RetailForce Cloud och vid kassan. Skapa företag (organisation eller företag) i RetailForce Cloud	-
406	På grund av den angivna typen (företagskod) är ingen tydlig tilldelning möjlig (t.ex. vid användning av [6] = CommercialRegisterNumberOffice). Felsökning: Använd en annan ID-typ (t.ex. [0] = VatNumber)	-
409	Det finns redan en client med det aktuella uniqueClientId i Fiscal Service (Fiscal Middleware). Felsökning: Använd befintlig client	-

Den här artikeln har översatts automatiskt.