PUBLICAÇÃO WEB SERVICE REST DO CADASTRO DE ENTIDADES (APENAS CONSULTA)

Características do Requisito

Pré-requisito

  No que diz respeito ao sistema, a funcionalidade de integração está funcional. Porém, é necessário configurar o AppServer para que o Protheus disponibilize a URL de acesso ao serviço de Web Service REST do sistema. Uma vez configurado o serviço, a integração está pronta para ser utilizada.

  Para isso, segue link para consulta: 1. Configuração do REST do Protheus

Descrição

  Para os usuários que possuem algum aplicativo customizado, e que precisam efetuar a consulta de entidades no produto Gestão Agroindústria (SIGAAGR), foi disponibilizado o método Web Service REST. 

Método Publicado

_{OBS: Para esta rotina, somente a consulta foi disponibilizada, o cadastro não é possível via REST.}

Exemplo de Utilização

Para realizar testes, pode-se utilizar qualquer programa de sua preferência, que teste API Web Service REST. O SoapUI e a extensão Postman do Navegador Chrome são exemplos de bons programas para isso. 

Consultando informações

Abaixo, uma consulta dos dados da tabela NJ0 através do método GET.

Existem várias possibilidades de se restringir quais dados o GET irá retornar. Segue link da documentação relativa a este assunto: http://tdn.totvs.com.br/pages/viewpage.action?pageId=271671548

Campo: NJ0_CGC, Tipo: Caracter, Tamanho: 14, Descrição: CNPJ/CPF da Entidade;

Campo: NJ0_INSCR, Tipo: Caracter, Tamanho: 18, Descrição: Inscrição Estadual;

Campo: NJ0_CODENT, Tipo: Caracter, Tamanho: 6, Descrição: Código da Entidade;

Campo: NJ0_LOJENT, Tipo: Caracter, Tamanho: 2, Descrição: Loja da Entidade;

Campo: NJ0_NOME, Tipo: Caracter, Tamanho: 40, Descrição: Nome da Entidade;

Campo: NJ0_NOMLOJ, Tipo: Caracter, Tamanho: 20, Descrição: Nome da Loja;

Campo: NJ0_CLASSE, Tipo: Caracter, Tamanho: 1, Descrição: Classe da Entidade;

Campo: NJ0_ITVDAP, Tipo: Caracter, Tamanho: 1, Descrição: Possui o Incentivo DAP;

Campo: NJ0_CODCRP, Tipo: Caracter, Tamanho: 8, Descrição: Código da Empresa e Filial;

Campo: NJ0_ATIVO, Tipo: Caracter, Tamanho: 1, Descrição: Cadastro Ativo?;

Campo: NJ0_CODFOR, Tipo: Caracter, Tamanho: 6, Descrição: Código do Fornecedor;

Campo: NJ0_LOJFOR, Tipo: Caracter, Tamanho: 2, Descrição: Loja do Fornecedor;

Campo: NJ0_CODCLI, Tipo: Caracter, Tamanho: 6, Descrição: Código do Cliente;

Campo: NJ0_LOJCLI, Tipo: Caracter, Tamanho: 2, Descrição: Loja do Cliente;

Campo: NJ0_DEPALF, Tipo: Caracter, Tamanho: 1, Descrição: Depósito Alfandegado Cert (1=Sim;2=Não);