Este ponto de extremidade permite a recuperação de um client no RetailForce Middleware, com dados (incluindo informações de configuração) provenientes da RetailForce Cloud.
A recuperação de um client pode ser necessária em caso de alteração do hardware da caixa registadora ou de defeitos de hardware.
A função POST /api/v1/management/clients/recovery/restoreByCloud/ID é essencialmente idêntica à função PUT /api/v1/management/clients/byCloud; no entanto, esta última só pode ser executada uma vez durante a colocação em funcionamento inicial de um client.
Resultado
Uma chamada bem-sucedida ao ponto de extremidade (200):
- Volta a descarregar o objeto de configuração do client em questão a partir do sistema da Cloud e configura o client em conformidade.
- Restaura um cliente que já tenha sido colocado em funcionamento no middleware e atribui-lhe o «uniqueClientId» correspondente do terminal proveniente da RetailForce Cloud.
Utilização
Este ponto de extremidade é utilizado quando um client, que já tenha sido criado anteriormente e cujo clientId seja conhecido, necessita de ser recuperado (por exemplo, no caso de uma alteração de hardware).
Pré-requisitos
- O cliente deve ter sido criado anteriormente e o clientId deve ser conhecido.
- A estrutura organizacional e o objeto de configuração foram criados na RetailForce Cloud e atribuídos em conformidade.
- O middleware deve estar instalado.
- O restoreByCloud só pode ser utilizado se:
- para utilizada uma licença correspondente (pacote de licenças que inclua «Cloud Archive Access»),
- a checkbox «Cloud Archive» estiver ativada na configuração (Cloud),
- o client já tiver transferido dados para o arquivo na Cloud (ANTES da restauração).
- Na Alemanha, deve ter sido registado no client e transferido para o arquivo na Cloud, pelo menos um fecho diário (em qualquer momento no passado).
Nota: O restoreByCloud só funcionará corretamente se
- o middleware tiver sido instalado recentemente no sistema ANTES de executar o restoreByCloud,
- ou (sem reinstalação) o serviço de fiscalização (serviço RetailForce) tiver sido reiniciado antes de executar o restoreByCloud.
Campos do formulário
Devem ser transmitidas as seguintes informações:
| Nome | Descrição | Exemplos |
| Tipo |
Tipo de identificação da empresa. O tipo também deve ser introduzido e existir na RetailForce Cloud. Estão disponíveis os seguintes tipos: [0] = VatNumber, 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 | O próprio identificador da empresa. Deve corresponder às informações introduzidas na RetailForce Cloud. | ATU57780814 |
| storeNumber |
O número da loja onde se encontra a caixa registadora. Deve corresponder às informações introduzidas no RetailForce Cloud.
NOTA:
em França, o SIRET (extensão do SIREN pelo número da loja) deve ser indicado aqui.
|
|
| 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 autenticar a comunicação com a Cloud | ypts7u5OU... |
Resposta
Respostas possíveis:
| Código | Descrição | Exemplo |
| 200 | O cliente foi restaurado e configurado com sucesso. O objeto de resposta devolve o uniqueClientId do cliente restaurado. O uniqueClientId deve ser armazenado pelo sistema de caixa registadora e utilizado em todo o processo de comunicação subsequente (relativo ao cliente). | b7cf6d59-cec4-4cc2-a647-01XXXX |
| 406 |
O tipo do identificador da empresa especificado não é um tipo único. Tratamento de erros: Utilize um dos seguintes identificadores de empresa: [0] = VatNumber, |
- |
Este artigo foi traduzido automaticamente.
Comentários
0 comentários
iniciar sessão para comentar.