Cadastrar conexões — todos os tipos
Manual completo da tela Conexões: como criar, testar e configurar cada um dos 17 tipos suportados.
Visão geral
Uma conexão guarda os dados de acesso a uma origem ou destino (banco, API, storage, data lake etc.). Consultas, armazenamentos, conectores, assistentes e agendamentos reutilizam essas conexões.
Como acessar
- Faça login na EasyAPI.
- No menu, abra Conexões (rota
/conexoes). - Use Novo para criar ou o ícone de editar na linha.
Ações da lista
| Ação | Resultado |
|---|---|
| Novo / Editar | Abre o formulário |
| Testar (quando disponível na edição) | Valida acesso e grava status |
| Tokens | Gera API keys da conexão |
| Excluir | Remove a conexão (se não houver vínculos bloqueantes) |
Status na grade
| Status | Significado |
|---|---|
| Conectado | Último teste OK |
| Erro | Último teste falhou |
| Não testado | Ainda sem teste gravado |
Passo a passo geral
- Informe o nome em Conexão.
- Selecione o Tipo — a tela mostra só os campos daquele tipo.
- Preencha credenciais e endpoints.
- Clique em Salvar.
- Clique em Testar Conexão (quando o tipo permitir).
- Se for integrar por API, abra Tokens e gere uma chave com expiração.
Lista completa dos tipos
| # | Tipo | Família | Teste na tela |
|---|---|---|---|
| 1 | SQL Server | Banco | Sim |
| 2 | Oracle | Banco | Sim |
| 3 | API SAP | Sistema | Sim |
| 4 | MySQL | Banco | Sim |
| 5 | API Authorization | Auth HTTP | Sim |
| 6 | PostgreSQL | Banco | Sim |
| 7 | SOAP | Serviço | Não (valide via consulta SOAP) |
| 8 | MongoDB | NoSQL | Sim |
| 9 | API OAuth2 | Auth HTTP | Sim (salve antes no cadastro novo) |
| 10 | Basic Auth | Auth HTTP | Não |
| 11 | AWS Athena | Analytics | Sim |
| 12 | Conexão Local | Gateway | Sim |
| 13 | Azure Blob | Storage | Sim |
| 14 | S3 | Storage | Sim |
| 15 | Azure Data Lake Gen2 | Storage | Sim |
| 16 | Databricks | Engine | Sim |
| 17 | Fabric | Engine | Sim (criação pelo select filtrada; use Conectores) |
Cadastro por tipo
SQL Server (1)
| Campo | Obrigatório | Descrição |
|---|---|---|
| Conexão | Sim | Nome |
| Rota API | Sim | Bridge/API da conexão |
| Host | IP | Sim | Servidor |
| Porta | Recomendado | Porta do SQL |
| Catalog | Não | Catálogo/banco |
| Usuário / Senha | Sim | Credenciais |
Oracle (2)
Mesmos campos de banco + Service Name no lugar de Catalog.
API SAP (3)
Além de Rota API, Host, Porta, Usuário e Senha:
| Campo | Descrição |
|---|---|
| Client SAP | Cliente SAP |
| Name SAP | Nome da conexão SAP |
| System ID SAP | SID |
| System Number SAP | Número do sistema |
| Language SAP | Idioma |
| Pool Size / Max Pool Size SAP | Pool de conexões |
MySQL (4) e PostgreSQL (6)
Rota API, Host, Porta, Database, Usuário, Senha.
API Authorization (5) e API OAuth2 (9)
| Campo | Descrição |
|---|---|
| Host | Endpoint de autenticação |
| Usuário / Senha | Credenciais do provedor |
| Retorno Token | Caminho do token na resposta (padrão efetivo accessToken) |
| Método Http | GET ou POST |
| Header | Cabeçalhos extras |
| Tipo Body Http / Body | Corpo da requisição de token |
No OAuth2 novo, salve antes de testar.
Basic Auth (10)
Preencha as credenciais exibidas e salve. O botão Testar Conexão fica desabilitado.
SOAP (7)
Cadastre host/credenciais. Não há teste dedicado — valide criando uma consulta SOAP.
MongoDB (8)
Host, Porta (se exibida), Database, Usuário, Senha → Testar.
AWS Athena (11)
| Campo na tela | Uso |
|---|---|
| Output Location S3 | Ex.: s3://meu-bucket/resultados/ |
| AWS Region | Ex.: us-east-1 |
| Database | Banco Athena |
| Workgroup | Workgroup |
| AWS Access Key ID / Secret | Credenciais |
Conexão Local — API Gateway Local (12)
| Campo | Descrição |
|---|---|
| Rota API | Endpoint da bridge |
| Nome conexão | Identificação no gateway |
Detalhes e diferença para VPN: Gateway Local e VPN.
Azure Blob (13), S3 (14), Azure Data Lake Gen2 (15)
| Campo | Descrição |
|---|---|
| Rota API | Endpoint da integração |
| Connection String | Host/Service URL | URL ou connection string |
| Access Key / Account Name | Conta |
| Secret/Account Key Storage | Segredo |
Databricks (16) e Fabric (17)
Seção Dados Conexão:
| Campo | Descrição |
|---|---|
| URL Workspace / SQL Endpoint | Endpoint SQL |
| Warehouse ID | Warehouse |
| Catalog / Schema | Catálogo e schema |
| Usuário / Token ou Senha | Autenticação |
Seções Armazenamento Raw e Parquet: nome e path dos volumes (abfss://...).
Para provisionar estrutura Fabric (workspaces/itens), use Conectores Fabric. Novas conexões Fabric pelo select de Conexões são filtradas na criação.
Tokens da conexão
- Na grade, clique em Tokens.
- Informe Data de expiração.
- Salve. Bloqueie a chave se precisar invalidar.
Escopos de token no produto: Usuário, Empresa, Sistema e Conexão — ver API e tokens.
Regras e validações
- Campos mudam conforme o tipo; o que não aparece não precisa ser preenchido.
- Senhas são armazenadas de forma segura no backend.
- Alterar a Rota API pode atualizar a rota das consultas vinculadas.
- Conexões Fabric na lista não exibem as mesmas ações padrão de editar/excluir/tokens dos demais tipos.
Erros comuns
| Problema | O que verificar |
|---|---|
| Teste falha | Host, porta, VPN/Gateway, usuário/senha |
| OAuth2 não testa | Salvar a conexão antes |
| Sem botão Testar | Basic Auth (e SOAP sem handler) |
| Fabric não aparece em Novo | Use o módulo Conectores |
Boas práticas
- Crie uma conexão de homologação antes da produção.
- Sempre teste após rotacionar senha ou token.
- Prefira tokens com expiração para consumo externo.
- Documente internamente qual sistema cada conexão representa (nome claro).