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

Este ponto de extremidade cria um novo client no Fiscal Middleware e associa-o a um terminal na RetailForce Cloud. Representa o primeiro passo na colocação em funcionamento de uma nova caixa registadora.

Resultados

Uma chamada bem-sucedida ao ponto de extremidade (200)

cria um novo client no middleware, atribui-lhe o uniqueClientId do terminal (Cloud) e
descarrega o objeto de configuração do sistema na Cloud e configura o client em conformidade.

Utilização

Uma única vez, quando uma nova caixa registadora é colocada em funcionamento. Chamar novamente o ponto de extremidade para o mesmo cliente (clientId) resultará num erro!

ATENÇÃO : se um cliente específico já tiver sido ligado uma vez ao terminal criado na nuvem (atribuição do uniqueClientId), a chamada repetida ao ponto de extremidade resultará numa mensagem de erro: «409 - Cliente já existe». Se for necessário criar novamente um cliente (por exemplo, em caso de falha do disco rígido, etc.), deve ser utilizado o ponto de extremidade /api/v1/management/clients/recovery/restoreByCloud.

Pré-requisitos

A estrutura organizacional e o objeto de configuração foram criados na RetailForce Cloud e atribuídos em conformidade
O middleware está instalado

Campos do formulário

Devem ser enviadas as seguintes informações:

Designação	Descrição	Exemplo
Tipo	Tipo de identificação da empresa. O tipo também deve ter sido introduzido e estar presente na RetailForce Cloud. Estão disponíveis os seguintes tipos: [0] = VatNumber, [1] = taxNumber, [2] = GLNNumber, [3] = BusinessIdentificationNumber, [4] = Classificação estatística, [5] = Número de registo comercial, [6] = Repartição de registo comercial, [7] = Número de registo comercial Ver também: Identificação da empresa Recomendamos a utilização do tipo [0] = VatNumber como ID principal em todos os países (UE), mesmo que não seja utilizado como ID obrigatório da empresa no respetivo país.	[0] = VatNumber
Identificação	A própria identificação da empresa. Deve corresponder às informações introduzidas na RetailForce Cloud.	ATU57780814
storeNumber	O número da filial/loja onde se encontra a caixa registadora. Deve corresponder às informações introduzidas no RetailForce Cloud. ATENÇÃO: em França, o SIRET (extensão do SIREN pelo número da filial) deve ser indicado aqui.	S001, 12345 etc.
terminalNumber	Número da caixa registadora. Deve corresponder às informações introduzidas no RetailForce Cloud.	0010
cloudApiKey	Chave API para autenticar a comunicação com a Cloud	RFC_4a2abc...
cloudApiSecret	API Secret para autenticação da comunicação na Cloud	ypts7u5OU...

Resposta

Respostas possíveis:

Código	Descrição	Exemplo
200	The client was created and configured with success. O uniqueClientId é devolvido como objeto de resposta. O uniqueClientId deve ser guardado pelo sistema POS e utilizado pelo mesmo durante todo o processo de comunicação subsequente (relativo ao cliente).	3fa85f64-5717-4562-b3fc-2c963f66afa6
404	Não foi encontrada nenhuma organização na RetailForce Cloud para o ID da empresa especificado. Resolução de problemas: Verifique o ID da empresa na RetailForce Cloud e na caixa registadora. Crie uma empresa (organização ou empresa) no RetailForce Cloud	-
406	Devido ao tipo especificado (código da empresa), não é possível efetuar uma atribuição clara (por exemplo, ao utilizar [6] = Número de Registo Comercial). Resolução de problemas: Utilize um tipo de ID diferente (por exemplo, [0] = VatNumber)	-
409	Já existe um client com o «uniqueClientId» relevante no Serviço Fiscal (Fiscal Middleware). Resolução de problemas: Utilize o client existente	-

Este artigo foi traduzido automaticamente.