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

Dette endpoint opretter en ny klient i Fiscal Middleware og knytter den til en terminal i RetailForce Cloud. Det udgør det første trin i idriftsættelsen af en ny kasseapparat.

Resultater

Et vellykket kald til endpointet (200)

opretter en ny klient i middlewareen, tildeler den terminalens (Cloudens) uniqueClientId og
henter konfigurationsobjektet fra Cloud-systemet og konfigurerer clienten i overensstemmelse hermed.

Anvendelse

Én gang, når et nyt kasseapparat tages i brug. Hvis endpointet kaldes igen for den samme klient (clientId), vil det resultere i en fejl!

OBS : Hvis en bestemt klient allerede én gang er blevet forbundet til den terminal, der er oprettet i Cloud (tildeling af uniqueClientId), vil et nyt opkald til endpointet resultere i en fejlmeddelelse: »409 – Klienten findes allerede«. Hvis en klient skal oprettes igen (f.eks. ved harddiskfejl osv.), skal endpointet /api/v1/management/clients/recovery/restoreByCloud anvendes.

Forudsætninger

Organisationsstrukturen og konfigurationsobjektet er oprettet i RetailForce Cloud og tildelt korrekt
Fiscal Middleware er installeret

Formularfelter

Følgende oplysninger skal indsendes:

Betegnelse	Beskrivelse	Eksempel
Type	Type virksomhedsidentifikation. Typen skal også være indtastet og findes i RetailForce Cloud. Følgende typer er tilgængelige: [0] = VatNumber, [1] = taxNumber, [2] = GLN-nummer, [3] = BusinessIdentificationNumber, [4] = Statistisk klassifikation, [5] = Handelsregisternummer, [6] = Handelsregisterkontor, [7] = Erhvervsregisternummer Se også: Virksomhedsidentifikation Vi anbefaler at bruge type [0] = VatNumber som primær ID i alle lande (EU), selvom det ikke anvendes som obligatorisk virksomhedsidentifikator i det pågældende land.	[0] = VatNumber
Identifikation	Selve virksomhedsidentifikationen. Skal stemme overens med de oplysninger, der er indtastet i RetailForce Cloud.	ATU57780814
storeNumber	Nummeret på den filial/butik, hvor kasseapparatet er placeret. Skal stemme overens med de oplysninger, der er indtastet i RetailForce Cloud. OBS: I Frankrig skal SIRET-nummeret (en udvidelse af SIREN-nummeret med filialnummeret) angives her.	S001, 12345 osv.
terminalNumber	Kasseapparatnummer. Skal stemme overens med de oplysninger, der er indtastet i RetailForce Cloud.	0010
cloudApiKey	API-nøgle til godkendelse af cloud-kommunikation	RFC_4a2abc...
cloudApiSecret	API Secret til autentificering af cloud-kommunikation	ypts7u5OU...

Svar

Mulige svar:

Kode	Beskrivelse	Eksempel
200	Clients blev oprettet og konfigureret uden problemer. uniqueClientId returneres som responsobjektet. uniqueClientId skal gemmes af POS-systemet og anvendes af POS-systemet i hele den videre kommunikationsproces (vedrørende clienten).	3fa85f64-5717-4562-b3fc-2c963f66afa6
404	Der blev ikke fundet nogen organisation i RetailForce Cloud for det angivne virksomheds-ID. Fejlfinding: Kontroller virksomheds-ID'et i RetailForce Cloud og ved kasseapparatet. Opret virksomhed (organisation eller firma) i RetailForce Cloud	-
406	På grund af den angivne type (virksomhedskode) er det ikke muligt at foretage en entydig tildeling (f.eks. ved brug af [6] = Handelsregisterkontor). Fejlfinding: Brug en anden ID-type (f.eks. [0] = VatNumber)	-
409	Der findes allerede en client med det pågældende uniqueClientId i Fiscal Service (Fiscal Middleware). Fejlfinding: Brug den eksisterende client	-

Denne artikel er oversat automatisk.