Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | ut-webservicetafNetHTTP.p |
Considerações Gerais
Objetivo
O objetivo desta API é realizar a integração das informações do produto Datasul com o TAF, através do Web Service.
Biblioteca OpenEdge.Net.HTTP
A biblioteca OpenEdge.Net.pl é projetada para ser utilizada como uma API para fazer solicitações HTTP e HTTPS.
Tendo como recursos:
- Suporte da maioria dos métodos HTTP, como GET, PUT, POST e DELETE
- Disponibilidade de um cliente com estado para gerenciar cookies
- Suporte para servidores proxy que podem ser usados por solicitação ou por cliente
- Redirecionamento automático de solicitações com base nos códigos de status retornados
- Mecanismo de autenticação extensível, incluindo suporte para autenticação HTTP Basic e Digest
- Está biblioteca é desenvolvida e suportada diretamente pela Progress. Documentação.
Funcionamento
Como utilizar a nova biblioteca OpenEdge.Net.pl do Progress para realizar a integração via Web Service:
**A lib de conexão está disponível a partir da versão 11.5.1 do Progress.
- Verificar se os arquivos abaixo estão disponíveis na instalação do Progress.
- Para ambientes UNIX
<diretório de instalação do Progress>/tty/gui/netlib/OpenEdge.Net.pl
<diretório de instalação do Progress>/tty/gui/OpenEdge.Core.pl - Para ambientes Windows
<diretório de instalação do Progress>/gui/netlib/OpenEdge.Net.pl
<diretório de instalação do Progress>/gui/OpenEdge.Core.pl Adicionar no propath as bibliotecas conforme ambiente:
Caso, os arquivos não estejam disponíveis na instalação do progress, os mesmos poderão ser copiados de outra estação de trabalho com a mesma versão do progress ou solicitados para a equipe de tecnologia da Totvs.
A sintaxe para a chamada da API, que deve ser de forma persistente:
run ut-webservicetafNetHTTP.p persistent set h-handle. |
A variável denominada h-handle irá receber a armazenar a API na memória, permitindo o acesso as procedures internas da API.
Método Negócio
Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
VerificaConexaoTAF | |||
Requisito | Teste de conexão com o Web Service | ||
Sintaxe | define variable c-url as character no-undo. RUN verificaConexaoTAF in h-handle (input c-url , | ||
Descrição | Através dos parâmetros passados para a procedure, ela retorna a variável lógica indicando se foi possível conectar no Web Service do TAF. | ||
Parâmetros | Tipo | Descrição | |
c-url | CHARACTER | Endereço/IP do serviço fornecido pelo Web Service | |
c-porta | CHARACTER | Porta do serviço fornecido pelo Web Service. | |
l-conexao | LOGICAL | Retorna a yes/no para o teste de conexão com o Web Service | |
Retorno | O retorno da variável lógica indica se foi possível ou não conectar com o Web Service. | ||
pi-executa-integracao-taf | |||
Requisito | Permite realizar a integração do extrator Datasul com o TAF através do Web Service. | ||
Sintaxe | RUN pi-executa-integracao-taf in h-handle (input table tt-tafst2, | ||
Descrição | É enviado a temp-table tt-tafst2 com as informações a serem integradas no TAF e o retorno com o código e descrição de erro ou integração realizada com sucesso. | ||
Parâmetros | Tipo | Descrição | |
| i-cod-retorno | INTEGER | Código do retorno da integração com o Web Service | |
| c-desc-retorno | CHARACTER | Descrição do retorno da integração com o Web Service | |
| Retorno | i-cod-retorno/c-desc-retorno: Caso a integração retorne um código diferente dos citados acima, o retorno será do Web Service do TAF. | ||
Nota:
A pi-executa-integração-taf chama a procedure privada setupConnectionTAF, onde realiza as devidas configurações e validação do usuário e senha (se a autenticação estiver ativa) no serviço e demais informações cadastradas no programa CD0101, pasta integração II.
tt-tafst2 | Envio | |||
Temp-table com dados para envio das informações para a integração. | Envio | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
taffil | CHARACTER | X(10) | Código Identificador da filial do ERP emissor. | Sim |
| tafseq | CHARACTER | X(03) | Sequência do arquivo; A Mensagem em TAFMSG pode ser enviada em mais de 1 registro, para isso deve-se repetir as informações dos demais campos e alterar a sequencia de acordo com a ordem das informações enviadas. | Sim |
| taftpreg | CHARACTER | X(10) | Chave do Registro. | Sim |
| tafkey | CHARACTER | X(100) | Array contendo os TAFKEY requisitados. | Sim |
| tafcodmsg | CHARACTER | X(1) | Determina se o arquivo enviado em TAFMSG é .txt (1)ou .Xml(2) | Sim |
| tafstatus | CHARACTER | X(1) | Fixo "1" | Não |
| tafticket | CHARACTER | X(1) | Fixo "" | Não |
| tafdata | CHARACTER | String - AAAAMM01 | Data da Integração. | Sim |
| tafhora | CHARACTER | String - HH:MM:SS | Hora da Integração. | Sim |
| r_e_c_n_o | INTEGER | 9999 | Numero do RecNo do ultimo registro retornado na requisição. | Sim |
| tafmsg | Memo - Base64 | X(15000) | Arquivo/Evento a ser integrado, a mensagem deve ser enviada com criptografia BASE64. | Sim |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas