Conteúdo

Índice

maxLevel	5
outline	true
indent	8.1.1
exclude	.*ndice
style	none

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

title	Importante

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
GFEA010	Cadastro do Contato do Emitentes	X	X	X	X
GFEA011	Cadastro de Grupo de Emitentes	X	X	X	X
GFEA012	Cadastro de Motorista e Ajudante	X	X	X	X
GFEA013	Cadastro de Alíquota de ICMS	X	X	X	X
GFEA014	Cadastro de Tipos de Itens	X	X	X	X
GFEA015	Cadastro de Emitentes de Transporte	X	X	X	X
GFEA017	Cadastro de Espécie de Documento	X	X	X	X
GFEA018	Cadastro de Praças de Pedágio	X	X	X	X
GFEA019	Cadastro de Tabela de Prazos	X	X	X	X
GFEA020	Cadastro de Cidades	X	X	X	X
GFEA021	Cadastro de Regiões	X	X	X	X
GFEA022	Cadastro de Distância entre Cidades	X	X	X	X
GFEA029	Cadastro de Frete Referência	X	X	X	X
GFEA030	Cadastro de Tipos de Ocorrência de Transporte	X	X	X	X
GFEA031	Cadastro de Motivos de Ocorrência de Transporte	X	X	X	X
GFEA032	Ocorrências de Transporte	X	X	X	X
GFEA033	Cadastro

de Ocorrências

de Tabelas de Prazos	X	X	X	X
GFEA039	Cadastro de Observações do Contrato de Transporte	X	X	X	X
GFEA041	Cadastro de Tipos de Documentos de Carga	X	X	X	X
GFEA042	Cadastro de Classificação de Frete	X	X	X	X
GFEA043	Cadastro de Unitizadores de Carga	X	X	X	X
GFEA044	Documentos de Carga	X	X	X	X
GFEA045	Cadastro de Tipo de Veículo	X	X	X	X
GFEA046	Cadastro de Veículo	X	X	X	X
GFEA047	Cadastro de Tipo de Operação	X	X	X	X
GFEA048	Cadastro de Filtro de Documento de Carga	X	X	X	X
GFEA049	Cadastro de Exceção de Item Embarcador	X	X	X	X
GFEA059	Requisição de Negociação de Frete	X	X	X	X
GFEA060	Cadastro de Componente de Frete	X	X	X	X
GFEA063	Cadastro de Aprovadores de Tabela de Frete	X	X	X	X
GFEA064	Cadastro de Aprovação da Tabela de Frete	X	X	X	X
GFEA068	Cadastro de Tabela de Taxa Suframa	X	X	X	X
GFEA079	Contratos Transporte	X	X	X	X
GFEA080	Cadastro de Conversões de Unidade de Medida	X	X	X	X
GFEA083	Cadastro de Relacionamento da Tabela x Contrato de Transporte	X	X	X	X
GFEA089	Cadastro de Centro de Custo	X	X	X	X
GFEA090	Cadastro de Contas Contábeis	X	X	X	X
GFEA092	Cadastro de Contas Contábeis x Centro de Custo	X	X	X	X
GFEA096	Lotes de Provisão	X	X	X	X
GFEA103	Cadastro de Tabela de IR	X	X	X	X
GFEA120	Cadastro de Tipo de Serviço	X	X	X	X
GFEA510	Cadastro de Operações	X	X	X	X
GFEA511	Cadastro de Visitantes	X	X	X	X
GFEA512	Cadastro de Recorrência	X	X	X	X
GFEA513	Cadastro de Restrições	X	X	X	X
GFEA514	Cadastro de Endereços de Mercadoria	X	X	X	X
GFEA515	Cadastro de Ponto de Controle	X	X	X	X
GFEA516	Cadastro de Perguntas	X	X	X	X
GFEA517	Agendamento de Entradas e Saídas	X	X	X	X
GFEA518	Configuração de Operação	X	X	X	X
GFEX021	Cadastro de Configuração de Tipo de Operação	X	X	X	X
GFEX201	Integração GFE X FreteBras	X	X	X	X
GFEX300	Romaneios e Documentos de Carga	X	X	X	X

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

title	Importante:

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

title	Importante

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

language	delphi
title	GFEA031 REST
linenumbers	true

/* 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

Atualização do Microsiga Protheus com versão igual ou superior a 12.1.17.
Configuração do AppServer para disponibilizar as rotinas publicadas com o Web Service REST.
- No link http://tdn.totvs.com.br/pages/viewpage.action?pageId=185748193 é possível encontrar todas as configurações necessárias.
Documentação do Web Service REST
- No link http://tdn.totvs.com.br/pages/viewpage.action?pageId=271671548 é possível encontrar toda a documentação da API RESTFull do Protheus e como utilizá-la..