Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoutp/ut-webservicetaf.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.

 

Funcionamento

 A sintaxe para a chamada da API, que deve ser de forma persistente:

run utp/ut-webservicetaf.p persistent set h-handle.

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos 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.
define variable c-porta as character no-undo.
define variable l-conexao as character no-undo.

RUN verificaConexaoTAF in h-handle (input c-url ,
                                                              input  c-porta,
                                                              output l-conexao).                                                                       

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,
output i-cod-retorno,
output c-desc-retorno).                                                                       

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-retornoINTEGERCódigo do retorno da integração com o Web Service
c-desc-retornoCHARACTERDescrição do retorno da integração com o Web Service
Retorno

i-cod-retorno/c-desc-retorno:
"200/201: Integração realizada com sucesso! Número do Ticket: *TAF+DATA+HORAS+SEGUNDOS*" (Ticket de integração no TAF, formado pelos campos tt-tafst2.TAFDATA + tt-tafst2.tafhora)
"401: Nome de usuário ou senha incorretos"
"404: Erro de Conexão, por favor, verifique as parametrizações"
"405: Erro. Conteúdo inválido no campo Resource, por favor, verifique as parametrizações."

Caso a integração retorne um código diferente dos citados acima, o retorno será o seguinte:
"Ocorreu um erro. Gentileza entrar em contato com o canal de atendimento."

 

 

 

Nota
titleNota:

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.
No banco MOVIFIS (EMS2) existe a tabela TAFST1 que atende as informações necessárias para a integração, então, a temp-table tt-tafst2 pode ser like TAFST1.

Envio

Atributo

Tipo

Formato

Descrição

Obrigatório

taffil

CHARACTER

X(10)

Código Identificador da filial do ERP emissor.

Sim

tafseqCHARACTERX(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
taftpregCHARACTERX(10)Chave do Registro.Sim
tafkeyCHARACTERX(100)Array contendo os TAFKEY requisitados.Sim
tafcodmsgCHARACTERX(1)Determina se o arquivo enviado em TAFMSG é .txt  (1)ou .Xml(2)Sim
tafstatusCHARACTERX(1)Fixo "1"Não
tafticketCHARACTERX(1)Fixo ""Não
tafdataCHARACTERString - AAAAMM01Data da Integração.Sim
tafhoraCHARACTERString - HH:MM:SSHora da Integração.Sim
r_e_c_n_oINTEGER9999 Numero do RecNo do ultimo registro retornado na requisição.Sim
tafmsgMemo - Base64X(15000) Arquivo/Evento a ser integrado, a mensagem deve ser enviada com criptografia BASE64.Sim