Índice:


       

Objetivo:


   O objetivo desse documento é esclarecer o uso de conexão destino usando a APIs Rest. Disponível a partir da versão 12.1.29.

Veja mais sobre as APIs do RM: Framework RM para APIs.

Conexão:


    Veja abaixo um exemplo de como criar uma conexão com API Rest.

   Passos para criar a conexão de destino com a API Rest:

  • Endereço base: Baseado nas APIs do RM, o endereço base é o host + porta; 
  • Verbos http: são disponibilizados os verbos PUT e POST.
  • Endpoint envio: Baseado nas APIs do RM, o endpoint pode ser consultado nas documentações de API ou no swagger.  APIs de Framework - Módulo Serviços Globais.
  • Registro por transação: Atualmente as APIs do RM não aceitam envio de registros em array, por este motivo, ao usar APIs do RM, esse campo deve ser preenchido com 0 (zero). Assim serão enviados 1 registro por vez.

Na aba Autenticação, selecione se a autenticação na API será Basic, Oauth, ou sem autenticação; 

Em seguida, preencha os campos necessários.

  • Autenticação Basic:

  • Autenticação Oauth:

Na aba Json schema, informe o json schema da API.

Para as APIs do host podem ser consultadas no swagger o Model Schema para criação do Json Schema, em algum conversor. Veja mais em: APIs de Framework - Módulo Serviços Globais.

Ao utilizar APIs do RM, campos que não são mapeados no conceito na aba "Ligações" devem ser removidos do Json Schema.

Por último, configure as ligações entre a tabela destino e origem.

Arraste primeiro a tabela de destino, depois a de Origem. Em seguida, clique no ícone 3, em destaque na imagem abaixo, para que as associações de campos sejam feitas automaticamente baseando-se no nome. 



Produto: Framework

Versão: 12.1.XX

Processo: Conexões Destino: API Rest

Status: Finalizado

Data: 02/09/2020