Pular para o conteúdo

Conexões

A área de Conexões centraliza e gerencia todos os pontos de integração da Wisedit com fontes de dados internas ou externas. Cada conexão pode ter múltiplas integrações associadas, desde que sejam do mesmo tipo (CSV, NoSQL, REST, SOAP ou SQL).

[TELA: Listagem de Conexões e Filtros] 1. Navegação: Acesso pelo menu 'Conexões'. 2. Topologia do Topo: Contém a barra de busca, o filtro 'Últ. Execução' (calendário), 'Situação' (Ativo/Inativo), 'Tipo' (busca por CSV, REST, SOAP, NOSQL, SQL) e o botão principal 'Adicionar'. 3. Tabela: Exibe Situação, Nome Conexão, Tipo Conexão, Tempo Médio e Últ. Execução. 4. Ações da Linha: À direita, o ícone de lápis aciona a ação de 'Editar'. O ícone de três pontos abre o menu 'Mais Opções', revelando as ações 'Duplicar' e 'Apagar'.

A listagem de conexões pode ser acessada no menu lateral (Sidebar).

Nesta tela você pode:

  • 🔍 Filtrar conexões - Por nome, última execução, tipo de conexão, tipo de dado ou situação
  • Adicionar nova conexão - Criar uma nova conexão no sistema
  • ✏️ Editar conexão - Modificar configurações de conexões existentes
  • 📋 Duplicar conexão - Criar cópia de uma conexão existente

Campos marcados com * são obrigatórios.

[FLUXO: Criar Nova Conexão - Etapa Geral] 1. Ação: O usuário clica em 'Adicionar'. 2. Interação: O modal 'Nova conexão' é aberto. 3. Topologia: Contém os campos de texto 'Nome da conexão *', 'Descrição' e os seletores obrigatórios 'Tipo da conexão *' (CSV, REST, SOAP, NOSQL, SQL), 'Situação *' (Ativo/Inativo) e 'Alerta *' (Sim/Não). 4. Conclusão: Após preencher, clica em 'Salvar'. O tipo de conexão escolhido aqui não poderá ser alterado depois.

Campos comuns a todos os tipos de conexão.

Descrição: Nome amigável e único para identificar esta conexão.

Exemplos: Banco de Dados de Clientes, MongoDB Produção.

Descrição: Campo opcional para adicionar informações relacionadas à conexão que está sendo cadastrada.

Exemplo: Conexão com o banco de dados principal que armazena informações de usuários e logs.

Descrição: Define a tecnologia principal da conexão.

Tipos disponíveis:

  • CSV - Arquivos de valores separados por vírgula
  • NoSQL - Bancos de dados não relacionais (MongoDB)
  • REST - APIs RESTful
  • SOAP - Web Services SOAP
  • SQL - Bancos de dados relacionais

Descrição: Indica se a conexão está operacional ou desativada.

Tipos:

  • Ativo: a conexão poderá ser utilizada nas execuções.
  • Inativo: a conexão ficará salva, mas não será utilizada.

Descrição: Define se o sistema deve emitir notificações em caso de falha ou indisponibilidade.

Tipos:

  • Sim: o usuário recebe uma notificação no e-mail informando.
  • Não: não será notificado sobre indisponibilidades.

Dependendo do tipo de conexão selecionado na ETAPA 1, você deverá preencher campos específicos conforme as seções abaixo.

Navegação rápida:

  • CSV - Arquivos CSV como fonte de dados
  • NoSQL - Bancos de dados não relacionais
  • REST - APIs RESTful com autenticação
  • SOAP - Web Services SOAP
  • SQL - Bancos de dados relacionais

Conexão CSV

Descrição: Utiliza arquivos .csv como fonte de dados.


[FLUXO: Configurar Conexão NoSQL] 1. Topologia: No modal de configuração, ao definir o 'Tipo Conexão' como NO SQL, o formulário se adapta. 2. Campos Específicos: O sistema exige apenas a seleção do 'Tipo de Banco' (ex: Mongo DB) e o preenchimento do campo 'String de Conexão (URI)'. 3. Regra de Edição: O campo 'Tipo Conexão' fica desabilitado (fundo cinza) após a criação. 4. Conclusão: O usuário insere a URI e clica em 'Salvar'.

Descrição: Especifica o sistema de gerenciamento de banco de dados NoSQL que será utilizado.

Tipos disponíveis: MongoDB

Descrição: O nome exato do database dentro da sua instância MongoDB à qual você deseja se conectar.

Exemplos: wisedit_app, clientes_db.

Descrição: O endereço do servidor onde o banco de dados MongoDB está hospedado. Pode ser um endereço IP ou um nome de domínio. A porta padrão do MongoDB (27017) pode ser adicionada se for diferente, no formato host:porta.

Exemplos: localhost, 127.0.0.1, cluster0.abcde.mongodb.net.

Descrição: O nome de usuário (username) utilizado para autenticar a conexão com o banco de dados.

Exemplos: admin, user_wisedit.

Descrição: A senha (password) associada ao usuário (login) informado. Por segurança, o campo exibirá os caracteres como pontos. Você pode clicar no ícone de “olho” para visualizar a senha digitada.


1. Base URL*

Descrição: O endereço principal da API. É a parte da URL que não muda entre as requisições.

Exemplo: https://viacep.com.br/ws/

2. Mapeamento de retorno

Descrição: Após a autenticação e a chamada à API, esta seção serve para conectar os dados recebidos da resposta com os campos internos do Wisedit.

Campos:

  • Campo retorno (key): O nome da chave no JSON de resposta da API (ex: logradouro)
  • Campo destino: O campo no seu sistema onde o valor será salvo

Clique em Adicionar para cada campo que deseja mapear.


Dependendo do tipo de autenticação que a API REST exige, preencha conforme abaixo:

Navegação rápida:

[FLUXO: Configurar Conexão REST - Sem Autenticação] 1. Topologia: Selecionando 'NO AUTHENTICATION', o sistema exige o preenchimento apenas da 'Base URL *'. 2. Ação: O usuário preenche a URL, configura o 'Mapeamento de retorno' na parte inferior (vinculando Campo retorno ao Campo destino) e clica em 'Salvar'.

Quando usar: Para APIs públicas que não exigem nenhum tipo de login, chave ou token.

Como preencher:

  1. Selecione NO AUTHENTICATION no campo “Tipo de autenticação”
  2. Configure o Mapeamento de retorno conforme necessário

[FLUXO: Configurar Conexão REST - Auth Body] 1. Topologia: Selecionando 'AUTH BODY', o modal exibe 'Base URL *', 'Path URL' e a seção 'Objeto Json de envio'. 2. Interação: O usuário adiciona credenciais preenchendo 'JSON Key' e 'JSON Value' e clicando em 'Adicionar'. 3. Conclusão: Configura o mapeamento de retorno e clica em 'Salvar'.

Quando usar: Quando a API exige que as credenciais sejam enviadas diretamente no corpo (body) da requisição, em formato JSON.

Como preencher:

1. Path URL*

Digite o caminho do recurso (ex: login, authenticate).

2. Objeto JSON de envio

Adicione as chaves e valores que a API espera receber para autenticação:

  • JSON Key: O nome do campo (ex: username, apiKey)
  • JSON Value: O valor correspondente (ex: meu_usuario, chave_secreta_123)

Clique em Adicionar para cada par de chave/valor necessário.

[FLUXO: Configurar Conexão REST - Basic Auth] 1. Topologia: Selecionando 'BASIC AUTH', são exigidos os campos 'Base URL *', 'Path URL', 'Login *' e 'Senha *' (com visualizador de caracteres). 2. Conclusão: O usuário preenche as credenciais, adiciona os campos no mapeamento de retorno e salva. Quando usar: Quando a autenticação é feita enviando um nome de usuário e uma senha, codificados no padrão “Basic Authentication”.

Como preencher:

1. Path URL*

Digite o caminho do recurso (ex: login, authenticate).

2. Login*

Insira o nome de usuário fornecido pela API.

3. Senha*

Insira a senha correspondente ao usuário. A Wisedit se encarregará de formatar e enviar esses dados no cabeçalho da requisição de forma segura.

[FLUXO: Configurar Conexão REST - API Key] 1. Topologia: Selecionando 'API KEY', o formulário adapta para exibir 'Base URL *', 'Path URL', 'Token key *' (ex: Authorization) e 'Token value *' (o token real). 2. Conclusão: O usuário preenche as chaves, faz o mapeamento e salva.

Quando usar: Usado quando a API fornece uma “chave de API” (API Key) que deve ser enviada para autorizar as requisições. Geralmente, essa chave é enviada nos cabeçalhos (headers).

Como preencher:

1. Path URL*

Digite o caminho do recurso (ex: login, authenticate).

2. Token key*

O nome do campo da chave que a API espera. Verifique na documentação da API qual é o nome correto.

Exemplos comuns: Authorization, x-api-key, api_key.

3. Token value*

O valor da sua chave de API (o token em si).

Exemplo: Bearer sk_live_123abc..., abc123xyz456....


1. URL do WSDL*

Descrição: Este é o campo mais importante. WSDL (Web Services Description Language) é um arquivo que descreve o que o serviço faz. Você deve inserir aqui o endereço completo do WSDL fornecido pela documentação do serviço.

Formato Comum: Geralmente, a URL termina com ?wsdl, ?WSDL, ou .wsdl.

Exemplo: http://ws.correios.com.br/calculador/CalcPrecoPrazo.asmx?wsdl.

2. Mapeamento de retorno

Descrição: Após a autenticação e a chamada à API, esta seção serve para conectar os dados recebidos da resposta com os campos internos do Wisedit.

Campos:

  • Campo retorno (key): O nome da chave no JSON de resposta da API (ex: logradouro)
  • Campo destino: O campo no seu sistema onde o valor será salvo

Clique em Adicionar para cada campo que deseja mapear.


Dependendo do tipo de autenticação que o serviço SOAP exige, preencha conforme abaixo:

Navegação rápida:

Conexão SOAP - No Authentication

Quando usar: Para serviços públicos que não exigem nenhum tipo de login, chave ou token.

Como preencher:

  1. Selecione NO AUTHENTICATION no campo “Tipo de autenticação”
  2. Configure o Mapeamento de retorno conforme necessário

Conexão SOAP - Auth Body

Quando usar: Quando o serviço exige que as credenciais sejam enviadas diretamente no corpo (body) da requisição, em formato JSON.

Como preencher:

1. Path URL*

Digite o caminho do recurso (ex: login, authenticate).

2. Objeto JSON de envio

Adicione as chaves e valores que o serviço espera receber para autenticação:

  • JSON Key: O nome do campo (ex: username, apiKey)
  • JSON Value: O valor correspondente (ex: meu_usuario, chave_secreta_123)

Clique em Adicionar para cada par de chave/valor necessário.

Conexão SOAP - Basic Auth

Quando usar: Quando a autenticação é feita enviando um nome de usuário e uma senha, codificados no padrão “Basic Authentication”.

Como preencher:

1. Path URL*

Digite o caminho do recurso (ex: login, authenticate).

2. Login*

Insira o nome de usuário fornecido pelo serviço.

3. Senha*

Insira a senha correspondente ao usuário. A Wisedit se encarregará de formatar e enviar esses dados no cabeçalho da requisição de forma segura.

Conexão SOAP - API Key

Quando usar: Usado quando o serviço fornece uma “chave de API” (API Key) que deve ser enviada para autorizar as requisições.

Como preencher:

1. Path URL*

Digite o caminho do recurso (ex: login, authenticate).

2. Token key*

O nome do campo da chave que o serviço espera. Verifique na documentação do serviço qual é o nome correto.

Exemplos comuns: Authorization, x-api-key, api_key.

3. Token value*

O valor da sua chave de API (o token em si).

Exemplo: Bearer sk_live_123abc..., abc123xyz456....


[FLUXO: Configurar Conexão SQL] 1. Topologia: No modal de configuração, ao definir o 'Tipo Conexão' como SQL, o sistema exibe parâmetros de banco relacional. 2. Campos Específicos: O usuário deve selecionar o 'Tipo de banco' (ex: SQL Server) e preencher diretamente a 'String de Conexão (URI)'. 3. Regra de Edição: O campo 'Tipo Conexão' é inalterável após a criação. 4. Conclusão: O usuário finaliza clicando em 'Salvar'.

Descrição: O passo mais importante. Aqui você deve especificar qual sistema de gerenciamento de banco de dados SQL está sendo usado.

Tipos disponíveis: MySQL, PostgreSQL, SQL Server, Oracle, etc.

Descrição: O nome exato do database (ou schema) que você deseja acessar dentro do servidor.

Exemplos: db_vendas, sistema_erp.

Descrição: O endereço de rede do servidor onde o banco de dados está hospedado. Geralmente é um endereço IP ou um domínio. Você também pode precisar especificar a porta, caso não seja a padrão (ex: meuservidor.com:5432).

Exemplos: localhost, 192.168.0.50, banco.minhaempresa.com.

Descrição: O nome de usuário (username) com permissão para acessar o banco de dados especificado.

Exemplos: usuario_leitura, wisedit_user.

Descrição: A senha associada ao usuário de login. O campo irá mascarar a senha por segurança. Use o ícone de “olho” para conferir o que foi digitado.


[FLUXO: Editar Conexão Existente] 1. Navegação: Na listagem, o usuário clica no ícone de lápis. 2. Regra de Negócio: No modal 'Edição da Conexão', o campo 'Tipo Conexão' fica com fundo cinza (desabilitado), impedindo a mudança da natureza da integração após criada. 3. Conclusão: O usuário altera credenciais ou parâmetros permitidos e clica em 'Salvar'.

Após configurar suas conexões, você pode precisar atualizar informações como credenciais de acesso (usuário e senha), endereços de servidor (Host, URL Base), nomes ou mapeamentos de retorno.

  1. Acesse a tela de Conexões
  2. Localize na lista a conexão que deseja modificar
  3. Clique no ícone de edição (formato de lápis)
  4. Altere os campos desejados
  5. Clique em Salvar

Em caso de dúvida sobre o preenchimento: Consulte o tópico de Adicionar Conexão correspondente ao tipo da sua conexão. Os campos e suas regras de preenchimento são os mesmos do cadastro.


[FLUXO: Duplicar Conexão Existente] 1. Navegação: Na tabela de listagem, o utilizador clica no ícone de três pontos (Mais Opções) na linha da conexão desejada e seleciona a ação 'Duplicar'. 2. Interação: O modal 'Duplicação da conexão' é aberto sobre o ecrã. 3. Comportamento do Sistema: O formulário é exibido com todos os dados técnicos da conexão original previamente preenchidos (Nome, Descrição, Tipo da conexão, Credenciais e URLs). 4. Ação: O utilizador ajusta o 'Nome da conexão' (para evitar duplicidade de nomes) e outros parâmetros que desejar. 5. Conclusão: O utilizador clica no botão escuro 'Salvar' para criar uma nova integração baseada no clone, economizando tempo de configuração.

Para agilizar a criação de configurações semelhantes, a plataforma Wisedit oferece a funcionalidade de duplicar uma conexão existente. Este recurso economiza tempo ao evitar que você precise preencher novamente todas as informações de uma conexão.

  1. No menu, acesse a listagem de Conexões na barra lateral
  2. Na lista, localize a conexão desejada que servirá como modelo
  3. Clique no ícone de cópia, localizado ao lado do ícone de edição (lápis)
  4. O modal “Duplicação da conexão” será aberto com todas as informações já preenchidas
  5. Defina um novo Nome da conexão (único campo obrigatório que virá em branco)
  6. Clique em Salvar

Para dúvidas ou problemas com gestão de usuários, entre em contato com nosso time:

📧 ajuda@wisedit.com