Conectar uma fonte de dados (API)

Dê ao Reporter um banco de dados para ler e confirme que o Reporter alcança as tabelas que seus templates usam.

Participantes

Sua instituição. O seu sistema que chama a API do Reporter.
Reporter. Guarda a fonte de dados, testa a conexão e lê a estrutura do seu banco de dados.
Seu banco de dados. O banco de dados PostgreSQL ou MongoDB que guarda os dados dos seus relatórios.

Você tem um bearer token que o Access Manager emite para o Reporter.
O Reporter alcança seu banco de dados pela rede.
Você tem um usuário de banco de dados para o Reporter. Dê a esse usuário apenas acesso de leitura.

#	Origem	Destino	Mensagem	API da Lerian	O que acontece
1	Sua instituição	Reporter	API da Lerian	`GET /v1/data-sources`	Liste as fontes de dados que o Reporter conhece.
2	Reporter	Sua instituição	Resposta		O Reporter devolve uma página de fontes de dados. A página também pode mostrar fontes de dados somente leitura que a plataforma fornece para os bancos de dados dos seus produtos Lerian.
3	Sua instituição	Reporter	API da Lerian	`POST /v1/data-sources`	Envie `configName`, `type`, `host`, `port`, `databaseName`, `username` e `password`. Adicione `sslMode` para escolher o modo TLS.
4	Reporter	Sua instituição	Resposta		O Reporter devolve a fonte de dados com seu `id`. A resposta não mostra a senha.
5	Sua instituição	Reporter	API da Lerian	`POST /v1/data-sources/{dataSourceId}/test-connection`	Peça ao Reporter para testar a conexão.
6	Reporter	Seu banco de dados	Conexão		O Reporter abre uma conexão curta com seu banco de dados e verifica se o banco responde.
7	Reporter	Sua instituição	Resposta		O Reporter devolve `status` `connected` ou `failed`, uma mensagem e `latencyMs`.
8	Sua instituição	Reporter	API da Lerian	`GET /v1/data-sources/{dataSourceId}/schema`	Peça as tabelas e os campos da fonte de dados.
9	Reporter	Seu banco de dados	Conexão		O Reporter lê as tabelas ou coleções e seus campos.
10	Reporter	Sua instituição	Resposta		O Reporter devolve cada tabela com seus campos e os tipos deles. Use esses nomes nos seus templates e filtros.

O configName é o nome que seus templates e filtros usam. Ele tem de 1 a 100 letras, dígitos, sublinhados ou hifens. Ele é único entre as suas fontes de dados.
Quando você não envia sslMode nem sslCaBase64, o Reporter usa require.
Quando você altera host, port, username, databaseName, type, sslMode, options ou sslCaBase64, envie o password de novo.
O Reporter recusa alterar, excluir ou testar uma fonte de dados somente leitura da plataforma. Você pode ler o esquema dela.

O teste de conexão devolve connected, e o esquema lista as tabelas e os campos que seus templates leem.

Situação	O que você vê	O que fazer
O `configName` já está em uso ou é reservado	`409` ou `400`, com um código e uma mensagem	Escolha outro nome.
Um campo viola uma regra	`400` com `RPT-0017` e uma mensagem que nomeia o campo	Corrija o campo e envie a requisição de novo.
O teste falha	`200` com `status` `failed` e uma mensagem	Confira o caminho de rede, as configurações de TLS e as credenciais. Depois teste de novo.