Histórico da Página
PUBLICAÇÃO WEB SERVICE REST DO TIPO DE OCORRÊNCIA DE TRANSPORTE
Características do Requisito
Linha de Produto: | Microsiga Protheus | ||||
Segmento: | Supply Chain - Logística | ||||
Módulo: | SIGAGFE | ||||
Rotinas: |
| ||||
Requisito/Story/Issue (informe o requisito relacionado): | DLOGGFE-27 | ||||
País: | Brasil | ||||
Bancos de Dados: | Todos | ||||
Tabelas Utilizadas: | GU5, GU4 | ||||
Sistemas Operacionais: | Todos |
Descrição
Para os usuários que possuem algum aplicativo customizado, e que precisam de informações do cadastro de tipo de ocorrência do produto Gestão de Frete Embarcador (SIGAGFE), foi disponibilizado o método Web Service REST.
Para utilização, é necessário a atualização do produto e a configuração do Web Service REST, conforme descrito nos pré-requisitos.
Método Publicado
Fonte | GFEA030 |
---|---|
Nome do Serviço | GFEA030 |
Exemplo 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 o Postman
Abaixo uma tela utilizando a extensão Postman, executando a consulta de dados, utilizando dois parâmetros no método GET. Neste exemplo os dados da tabela GU5 e os detalhes da tabela GU4 são listados.
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.
Utilizando o Progress Datasul
Código de exemplo.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
/* 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/GFEA030?COUNT=1&FIRSTLEVEL=FALSE'.
/* 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.