Histórico da Página

...

Necessário disponibilizar um endpoint na ChefWebAPI para consulta completa ou parcial dos cadastros de Clientes.

...

Foi criado um novo endpoint na api API de clientes para que seja possível listar os cadastros de Clientes por loja, conforme especificações a seguir.

03.01. AUTENTICAÇÃO NA API

Geração Token

Para realizar qualquer acesso às consultas disponibilizadas é necessário solicitar um Token de autenticação, através da API "Gerar Token".

Nessa chamada devem ser informados o usuário, a senha e o número de série do cliente que deseja consultar.

O método retornará Token de acesso, com duração de 2 minutos.

Este Token será composto de um código aleatório, do tipo string (Exemplo: ZQGL16Q3D43mhSi8nw8s3j2HhZPQ9Ei6), que deverá ser utilizado em uma chamada da API.

Não é possível reutilizar o Token de autenticação, sendo assim para cada chamada, dos métodos da API, deverá ser solicitado um novo.

Caso o Token gerado não seja utilizado em até 2 minutos ele estará automaticamente cancelado. 

URL do Serviço: POST:http://{url_do_servidor}/api/Token/GerarToken

Request

"Usuario": Usuário utilizado para acessar o ambiente no ChefWeb

“Senha”: Senha utilizada do usuário para acessar o ChefWeb

"NumeroSerialLoja": Informar o Diretório Site do ambiente que deseja realizar o cadastro

"Chave": Manter Padrão "Chave"

Response

O serviço retorna um JSON no formato abaixo:
1- Válido

03.02. REQUISIÇÃO PARA CONSULTAR OS CADASTROS DE CLIENTES

Método Salvar

URL do Serviço GET: http://{url_do_servidor}/chefwebapi/api/CadastroCliente/Listar

Request

A requisição deve ser preenchida obedecendo os seguintes critérios:

Token: Token de autenticação - Obrigatório - gerado no item 03.01 deste documento.

...

CodigoLoja: 

...

Numero da loja a ser consultada - Obrigatório

...

Completa: Informar TRUE ou FALSE, onde TRUE: Consulta completa a qual retornará todos os registros de clientes cadastrados para a loja selecionada (limitado a duas consulta diárias), ou FALSE: Consulta parcial a qual retornará somente os registros de clientes atualizados após a ultima consulta (completa ou parcial). 

Payload Request (exemplo):

{
    "Token": "f0191783-caa7-45ae-a725-c087a0e67835",
    "CodigoLoja": 1,
    "Completa": true
}

Obs.: O campo "Completa" é utilizado como identificador para diferenciar o retorno dos cadastros seja a lista de carga inicial dos clientes onde serão retornados todos os registros (neste caso o valor deve ser passado como "True") e entre a listagem dos clientes atualizados após a carga completa (neste caso o valor deve ser passado como "False").

Payload Response (exemplo):

{
    

"Cliente": [

         {
            "Codigo": 52,
            "Nome": "TOTVS TESTE",
            "Endereco": "",
            "Numero": 0,
            "Complemento": "",
            "Bairro": "",
            "Cidade": "ARARAQUARA",
            "Cep": "",
            "Estado": "SP",
            "DDD": "",
            "Telefone": "",
            "Email": "",
            "RG": "",
            "CPF": "",
            "IndicadorIE": "Não Contribuinte",
            "DataNascimento": "0001-01-01T00:00:00",
            "Observacao": "",
            "UltimaVisita": "0001-01-01T00:00:00",
            "NumeroVisitas": 0.0,
            "OperadorCadastro": "USUARIO2"
        },
        {
            "Codigo": 51,
            "Nome": "TESTE ABC",
            "Endereco": "",
            "Numero": 0,
            "Complemento": "",
            "Bairro": "",
            "Cidade": "ARARAQUARA",
            "Cep": "",
            "Estado": "SP",
            "DDD": "11",
            "Telefone": "9999999",
            "Email": "",
            "RG": "11111111",
            "CPF": "00000000191",
            "IndicadorIE": "Não Contribuinte",
            "DataNascimento": "1987-03-02T00:00:00",
            "Observacao": "",
            "UltimaVisita": "2022-08-26T00:00:00",
            "NumeroVisitas": 0.0,
            "OperadorCadastro": "USUARIO"
        }

],
    "Sucesso": true,
    "Erros": [ ]
}

...

04. DEMAIS INFORMAÇÕES

Não se aplica

05. ASSUNTOS RELACIONADOS

        Não se aplica