Catálogo de Produtos via API REST

CONTEÚDO

1. Visão Geral
2. Conceito
3. Exemplo de Utilização
   1. Método Get
      
   2. Método Post
   3. Método Put
   4. Método Delete
4. Campos
5. Demais Informações

01. VISÃO GERAL

Disponibilizar uma APIs REST para realizar a manutenção da rotina de Catálogo de Produtos - EICCP400 do módulo Easy Import Control.

02. CONCEITO

Devido a rotina de Catálogo de Produtos - EICCP400 do módulo Easy Import Control ser baseada na arquitetura MVC (Model View Controller), conseguimos através do serviço FWModel (disponibilizado pelo framework), criar a APIs REST para a rotina de catálogo de produto.

Dessa forma, mantemos quase as mesmas modelagens de dados e validações que a rotina apresenta atualmente, consistindo nas informações dos registros e regras de negócio. Somente não realizamos o carregamento automático dos atributos assim que informado a NCM, como também, não carregamos os fabricantes/fornecedores que foram vinculados ao produto, ambas funcionalidades são realizadas somente através da rotina quando acessado via interface. Com isso, quem for realizar o consumo da API será necessário que seja enviado os atributos e seus valores que são vinculados a NCM e também, pelo menos, o país de origem do produto.

A API REST da rotina de Catálogo de Produtos - EICCP400 possui os métodos GET, POST, PUT e DELETE (Integração do Easy Import Control via API REST#conceito)

Com o serviço REST configurado corretamente (Integração do Easy Import Control via API REST#configuracao), podemos ter acesso a modelagem de negócio disponibilizada através do endereço: http://localhost:8080/rest/index/fwmodel/EICCP400.

Onde:

http://localhost:8080/rest é o endereço configurado do REST

/index/fwmodel/ é fixo (framework)

/EICCPP400 é nome da API do catálogo de produto

03. EXEMPLO DE UTILIZAÇÃO

Segue abaixo alguns exemplos de como realizar os consumos de cada método disponibilizado:

Para mais informações: Integração do Easy Import Control via API REST#envio_json e Integração do Easy Import Control via API REST#respostas_json

Os modelos de dados definidos para o catálogo de produtos são:

EK9MASTER: tabela EK9 - Catálogode Produtos(Capa)    

EKADETAIL: tabela EKA - Catálogo de Produtos(Item)

EKBDETAIL: tabela EKB - Cadastro de Fabricantes       

EKCDETAIL: tabela EKC - Atributos                     

• Método Get: é responsável por consultar os catálogos de produtos registrados no sistema.

Exemplo de como consultar um registro específico:

• Método Post: é responsável por incluir os catálogos de produtos no sistema.

• Método Put: é responsável por alterar o catálogo de produtos no sistema.

• Método Delete: é responsável por excluir um catálogo de produto

04. CAMPOS

Alguns campos não são possíveis preencher, mesmo sendo apresentados na estruturas das requisições, tais como:

Alguns campos são possíveis somente de serem informados na inclusão, tais como:

05. DEMAIS INFORMAÇÕES

• Catálogo de Produtos - EICCP400
• Integração do Easy Import Control via API REST