Conteúdo
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.
Importante
Para utilização, é necessário a atualização do produto e a configuração do Web Service REST, conforme descrito nos pré-requisitos.
Serviços Disponíveis
Fonte | Descrição | GET Consulta | POST | PUT Alteração | DELETE Exclusão |
GFEA014 | Cadastro deTipos de Itens | X | X | X | X |
GFEA015 | Cadastro de Emitentes de Transporte | 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 |
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 |
GFEA047 | Cadastro de Tipo de Operação | X | X | X | X |
GFEA059 | Requisição de Negociação de Frete | X | X | X | X |
GFEA079 | Contratos Transporte | 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 os métodos GET, POST e PUT (alteração).
Importante:
Caso a tabela 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:
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.
Utilizando o método PUT para a alteração de dados:
Importante
Para os métodos de modificação (PUT e DELETE), deve ser informada a chave no PATH da linha, conforme o exemplo abaixo.
Utilizando Progress Datasul
Código de exemplo:
/* 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'. /* 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.
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
FWRestModel - API RESTful dos modelos de dados do Protheus