Árvore de páginas

Versões comparadas

Chave

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


...

Conteúdo

Índice
maxLevel5
outlinetrue
indent8.1.1
exclude.*ndice
stylenone


Objetivo

Para clientes que possuem aplicativos customizados e precisam consultar ou manipular as informações no produto Gestão de Frete Embarcador (SIGAGFE), foram disponibilizados métodos Web Service REST.

Informações
titleImportante

Para utilização, é necessário a atualização do produto e necessária a configuração do Web Service REST, conforme descrito nos pré-requisitos.

Serviços Disponíveis 
Âncora
principaiscampos
principaiscampos

Campo:

Fonte

Descrição

GET
Consulta

POST
Inclusão

POST
PUT
Alteração
DELETE
Exclusão
GFEA010Cadastro do Contato do EmitentesXXXX
GFEA011Cadastro de Grupo de EmitentesXXXX
GFEA012Cadastro de Motorista e AjudanteXXXX
GFEA013Cadastro de Alíquota de ICMSXXXX
GFEA014Cadastro de Tipos de ItensXXXX

GFEA015

Cadastro de Emitentes de TransporteXXXX

GFEA017

Cadastro de Espécie de DocumentoXXXX

GFEA018

Cadastro de Praças de PedágioXXXX

GFEA019

Cadastro de Tabela de PrazosXXXX

GFEA020

Cadastro de CidadesXXXX

GFEA021

Cadastro de RegiõesXXXX

GFEA022

Cadastro de Distância entre CidadesXXXX

GFEA029

Cadastro de Frete ReferênciaXXXX
GFEA030Cadastro de Tipos de Ocorrência de TransporteXXXX
GFEA031Cadastro de Motivos de Ocorrência de TransporteXXXX
GFEA032Ocorrências de TransporteXXXX
GFEA033Cadastro
de Ocorrências
de Tabelas de PrazosXXXX
GFEA039Cadastro de Observações do Contrato de TransporteXXXX
GFEA041Cadastro de Tipos de Documentos de CargaXXXX
GFEA042Cadastro de Classificação de FreteXXXX
GFEA043Cadastro de Unitizadores de CargaXXXX
GFEA044Documentos de CargaXXXX
GFEA045Cadastro de Tipo de VeículoXXXX
GFEA046Cadastro de VeículoXXXX
GFEA047Cadastro de Tipo de OperaçãoXXXX
GFEA048Cadastro de Filtro de Documento de CargaXXXX
GFEA049Cadastro de Exceção de Item EmbarcadorXXXX
GFEA059Requisição de Negociação de FreteXXXX
GFEA060Cadastro de Componente de FreteXXXX
GFEA063Cadastro de Aprovadores de Tabela de FreteXXXX
GFEA064Cadastro de Aprovação da Tabela de FreteXXXX
GFEA068Cadastro de Tabela de Taxa SuframaXXXX
GFEA079Contratos TransporteXXXX
GFEA080Cadastro de Conversões de Unidade de MedidaXXXX
GFEA083Cadastro de Relacionamento da Tabela x Contrato de TransporteXXXX
GFEA089Cadastro de Centro de CustoXXXX
GFEA090Cadastro de Contas ContábeisXXXX
GFEA092Cadastro de Contas Contábeis x Centro de CustoXXXX
GFEA096Lotes de ProvisãoXXXX
GFEA103Cadastro de Tabela de IRXXXX
GFEA120Cadastro de Tipo de ServiçoXXXX
GFEA510Cadastro de OperaçõesXXXX
GFEA511Cadastro de VisitantesXXXX
GFEA512Cadastro de RecorrênciaXXXX
GFEA513Cadastro de RestriçõesXXXX
GFEA514Cadastro de Endereços de MercadoriaXXXX
GFEA515Cadastro de Ponto de ControleXXXX
GFEA516Cadastro de PerguntasXXXX
GFEA517Agendamento de Entradas e SaídasXXXX
GFEA518Configuração de OperaçãoXXXX
GFEX021Cadastro de Configuração de Tipo de OperaçãoXXXX
GFEX201Integração GFE X FreteBrasXXXX
GFEX300Romaneios e Documentos de CargaXXXX


Exemplos de Utilização

Para realizar testes, pode ser utilizado qualquer programa de sua preferência, que teste API Web Service REST.

Como exemplos de programas, podemos citar o SoapUI ou a extensão Postman do Navegador Chrome. Ambos são excelentes aplicativos..


Utilizando Postman

Abaixo uma tela utilizando a extensão Postman, executando a consulta de dados, utilizando dois parâmetros no método GET. Neste exemplo são listados os dados do cadastro de motivos de ocorrência (GFEA031).Image Removedos métodos GET, POST e PUT (alteração).

Informações
titleImportante:

Caso a tabela do cadastro de Motivos seja exclusiva, no Headers deve ser indicado no campo tenantId o grupo de empresas e a filial que deseja localizar as informações. Abaixo um exemplo utilizando o programa Postman.

Exemplos:

Utilizando o método GET para a consulta de dados:

Image Added


Utilizando o método POST para a inclusão de dados.

É utilizado a informação apresentada no GET, removendo os dados acima do id que referencia o nome do modelo de dados e acrescentado as informações a serem incluídas.

Image Added

Utilizando o método PUT para a alteração de dados:

Informações
titleImportante

Para os métodos de modificação (PUT e DELETE), deve ser informada a chave no PATH da linha, conforme o exemplo abaixo.


Image Added

Utilizando Progress Datasul

Código de exemplo:

Bloco de código
languagedelphi
titleGFEA031 REST
linenumberstrue
/* Variaveis da consulta ao webservice */
DEFINE VARIABLE http     AS COM-HANDLE.
DEFINE VARIABLE strURL   AS CHARACTER.
DEFINE VARIABLE strRET   AS CHARACTER.
DEFINE VARIABLE iNumEntries AS INTEGER NO-UNDO.
DEFINE VARIABLE iLoop AS INTEGER NO-UNDO.
assign  strURL  =   'http://localhost:8020/rest/fwmodel/GFEA031?COUNT=3'.
/* Le a informação do Retorno */
CREATE "MSXML2.XMLHTTP.3.0" http NO-ERROR.
http:OPEN("GET", strURL, FALSE).
http:setRequestHeader("Translate", "f").
http:setRequestHeader("Depth", "0").
http:setRequestHeader("tenantId", "T1,D MG 01 ").
http:SEND() NO-ERROR.
/* Armazena o retorno */
strRET = http:responseText.
MESSAGE strRET
    VIEW-AS ALERT-BOX INFO BUTTONS OK.
/* Se tiver erro, retorna o erro */
if strRET begins "Houve erro" then do:
   /* Trata */
end.
else do:
   /* Trata o retorno */
end.


Resultado esperado.:

.

Pré-requisitos para Utilização

Conteúdos Relacionados

Publicação Tipos de Ocorrência WS REST 

Publicação Motivos do Tipo da Ocorrência WS REST 

Publicação Motivos de Ocorrência WS REST

Publicação do Registro da Ocorrência WS REST

Publicação Tipos de Veículo WS REST

Publicação de Serviços WS REST

Publicação Tipo de Operação API REST 

Publicação Classificação de Frete API REST 

Publicação Manutenção de Documentos de Carga WS REST 

DT Ajuste Técnico: Disponibilização das rotinas MVC em APIs REST (GFERESTMVC)

FWRestModel - API RESTful dos modelos de dados do Protheus