TREPORTS

Atalhos

Árvore de páginas

Índice

       

Objetivo

       O objetivo da API de Integração de Conectores do TReports é promover uma forma de criar conectores dentro do ERP TOTVS. 

Informações

As APIs públicas de Conectores estão disponíveis em qualquer instalação do TReports a partir da versão 2.X e suas operações estão documentadas via Swagger.

Criar Conector

A "criação de conector" é uma API que possibilita o cadastro de conectores. Através dessa API é possível criar um conector, desde que o usuário seja Administrador do TReports.

O JSON de envio deve conter as seguintes informações:

  • {type}: O tipo do conector
    • Native: Para o tipo Provedor Nativo
    • Sql: Parao tipo Provedor Sql
  • {displayName}: O nome de exibição do Conector
  • {address}: O endereço do Conector quando é do tipo Native

O cadastro pela API é feito da seguinte forma:

JSON de envio
{
  "type": "Native | Sql",
  "displayName": "nome de exibição do conector",
  "address": "endereço do conector"
}

Detalhes da implementação são encontrados no endpoint abaixo:

Abaixo temos um exemplo de Id do conector retornado pela API:

Response Body
"5de91591-66bb-4615-9e7a-5fe55ccb584d"

Atualmente, o cadastro de Conector do tipo Sql não está disponível.

  • Sem rótulos