DVARHAN-9105 DT API Fornecedores

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

Disponibilizar um endpoint na ChefWebAPI para que seja possível cadastrar fornecedores.

03. SOLUÇÃO

Foi criado um endpoint na ChefWebAPI para que seja possível realizar o cadastro de fornecedores conforme especificações abaixo:

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 CADASTRO DE FORNECEDOR

Método Salvar

URL do Serviço POST: http://{url_do_servidor}/chefwebapi/api/Fornecedor/Salvar

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.

DiretorioSite: Número serial de identificação da base da loja - Obrigatório

Fornecedor: Dados do fornecedor conforme disponibilizado no cadastro de fornecedores da Retaguarda.

Payload Request (exemplo):

{
    "Token": "f0191783-caa7-45ae-a725-c087a0e67835",
    "DiretorioSite": 96721234,
    "Fornecedor": {
            "Codigo": 0,            
            "Nome": "Testando novo cadastro via api",
            "Contato": "Testando novo cadastro via api",
            "Ddi": "55",
            "Ddd": "11",
            "Telefone": "12345-6789",
            "Fax": "1234-5678",
            "Endereco": "Avenida Braz Leme",
            "Complemento": "TOTVS Matriz",
            "Bairro": "Santana",
            "Numero": "1000",
            "CEP": "02511-000",
            "UF": "SP",
            "Cidade": "Sao Paulo",
            "Pais": "Brasil",
            "TipoDocumento": "cpf",            
            "CpfCnpj": "000.000.001-91",
            "Email": "teste@totvs.com.br",
            "MalaDireta": true, 
            "Home": "https://www.totvs.com/",
            "Observacao": "Campo observação",
            "TipoResponsavelIcms": "REMETENTE DIRETO",
            "IndicadorIE": "não contribuinte",
            "InscricaoEstadual" : "isento",
            "PlanoContas" : "05 - ENTRADAS",
            "PlanoContas2" : "ENT. 51 APORTE SOCIOS",
            "Loja": 1
        }
}

O campo Codigo é utilizado como identificador para diferenciar entre inclusão e alteração de registro. Se não for informado é assumido como padrão 0.

Payload Response (exemplo):

{
    "Fornecedor": null,
    "Sucesso": true,
    "Erros": [ ]
}