Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


CONTEÚDO

  1. Visão Geral
  2. Conceito
  3. Exemplo de utilização
  4. Tela XXX
    1. Outras Ações / Ações relacionadas
  5. Tela XXX
    1. Principais Campos e Parâmetros
  6. Tabelas utilizadas
  7. Utilização
    1. Método Get
    2. Método Post
    3. Método Put
    4. Método Delete
  8. Campos
  9. Demais Informações

Âncora
visao_geral
visao_geral

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. TELA XXXXX

Outras Ações / Ações relacionadas

...

04. TELA XXXXX

Principais Campos e Parâmetros

...

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

Âncora
conceito
conceito

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

Image Added

Âncora
exemplo
exemplo


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_jsonIntegraçã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                     

Âncora
metodo_get
metodo_get


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

Image Added

Exemplo de como consultar um registro específico:

Image Added

Âncora
metodo_post
metodo_post


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

Image Added

Âncora
metodo_put
metodo_put


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

Image Added

Âncora
metodo_delete
metodo_delete


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

Image Added

Âncora
campos
campos


04. CAMPOS

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

CampoModelo de DadosDescrição
EK9_IDPORTEK9MASTERID do registro Portal Unico
EK9_VATUALEK9MASTERVersão Atual do Catálogo de Produto
EK9_STATUSEK9MASTERStatus do Catálogo de Produto no Portal Unico
EK9_RETINTEK9MASTERLog de Integração        

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

CampoModelo de DadosDescrição
EK9_NCMEK9MASTERNCM do Catálogo de produto
EK9_UNIESTEK9MASTERUnidade Estatistica      
Aviso
titleObservação

Para o campo EKC_VALOR do modelo de dados EKCDETAIL, quando o atributo é do escopo numérico, as casas decimais deverão ser separados por vírgula ( , ) e como caractere.

Exemplo:

{
    "id": "EKC_VALOR",
    "value": "1,99"
}

Quando o atributo é multi-valorado, os valores deverão ser separado por ponto e vírgula ( ; )

Exemplo:

{
    "id": "EKC_VALOR",
    "value": "01;02"
}

Âncora
demais
demais


05. DEMAIS INFORMAÇÕES