DVARHAN-9856 DT API para consulta do cadastro de produtos

01. DADOS GERAIS

Produto:	TOTVS Varejo Food Service
Linha de Produto:
Segmento:	Fly01
Módulo:	CHEF WEB
Função:	API CAPA VENDA
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :	DVARHAN-9856

02. SITUAÇÃO/REQUISITO

Disponibilizar um endpoint na ChefWebAPI para consulta de produtos.

03. SOLUÇÃO

Foi desenvolvido um novo endpoint na API de produtos para que seja possível listar os cadastros de Produto 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

{

"Token": "69e9dde6-c91c-4c50-af1c-fc2dbe7875ba"

"DataExpiração": "2017-12-22T10:41:53.4976772-02:00",

"Sucesso": : true

"Erro":: []

}

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

Método Salvar

URL do Serviço GET: http://{url_do_servidor}/chefwebapi/api/Produto/listarProdutos

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 produtos cadastrados para a loja selecionada (limitado a duas consulta diárias), ou FALSE: Consulta parcial a qual retornará somente os registros de produtos atualizados após a ultima consulta (completa ou parcial).

Payload Request (exemplo):

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

Payload Response (exemplo):

{
    "Sucesso": true,
    "Mensagens": [],
    "Dados": [
        {
            "CodigoProduto": 1,
            "DescricaoProduto": "A FRANCESA",
            "UnidadeVenda": "UN",
            "UnidadeCompra": "UN",
            "Grupo": "BOLOS",
            "SubGrupo": "TRADICIONAIS",
            "ProdutoComposto": false,
            "Composicoes": [],
            "Adicionais": [
                {
                    "CodigoProduto": 2,
                    "NomeProduto": "A FRANCESA",
                    "QuantidadeAdicionais": 5.0
                }
            ],
            "NaoExibirNoCardapio": false,
            "PrecoVenda": 99.00,
            "PrecoVenda2": 99.00,
            "PrecoCompra": 10.0000,
            "PontoProducao": "NENHUM",
            "OrdemTouch": 37,
            "FatorCompra": "",
            "Pesavel": true,
            "Processado": true,
            "PermiteVendaFracionada": true,
            "EstoqueOnline": true,
            "TributoCompra": "I",
            "CFOPCompra": "",
            "CSTCompra": "300",
            "IPI": 0.0000,
            "ReducaoBCICMS": 58.82,
            "PlanoDeContas1": "",
            "PlanoDeContas2": "",
            "NCM": "21069090",
            "CSTPisTipo": "",
            "CSTPisCodigo": "",
            "CSTPisValor": 0.0000,
            "CSTCofinsTipo": "",
            "CSTCofinsCodigo": "",
            "CSTCofinsValor": 0.0000,
            "AliquotaVenda": 17.1000,
            "TributoVenda": "T",
            "CFOPVenda": "5102",
            "CSTVenda": "020",
            "CSOSNVenda": "",
            "FCPValor": 0.0000,
            "ReducaoBCICMSEfetivo": 0.00,
            "AliquotaICMSEfetivo": 0.0000,
            "AliquotaFCPDesoneracao": 0.0000
        }
    ]
}

04. DEMAIS INFORMAÇÕES

Não se aplica

05. ASSUNTOS RELACIONADOS