For the complete documentation index, see llms.txt. This page is also available as Markdown.

Conceitos principais

Esta página resume as entidades mais importantes do TunnelHub e como elas se relacionam.

Estrutura base

  • Tenant/empresa: unidade principal de conta e isolamento de dados.

  • Usuário: pessoa com acesso ao portal, à CLI ou a fluxos relacionados à autenticação.

  • Ambiente: recorte operacional dentro da empresa. É comum existir DEV, QAS e PRD.

  • Pacote: agrupador funcional usado para organizar automações, systems e outros recursos.

Recursos de integração

  • System: conexão reutilizável com banco, HTTP, FTP/SFTP, LDAP, mail, SOAP, SAP RFC, SMB e outros tipos suportados.

  • Automação: integração executável criada no produto e implementada com o SDK.

  • Deploy: versão publicada da automação, com histórico e opção de transporte entre ambientes.

  • Trigger: forma de disparo de uma automação, como webhook, agenda ou inbound email.

Recursos de dados

  • Tabela De/Para: conjunto de dados configurável no produto, usado para mapeamentos e regras de negócio.

  • Tabela de conversão: caso comum de uma Tabela De/Para com pares fromValue e toValue.

  • Sequência: gerador sequencial usado para números de negócio ou identificadores.

  • Parâmetro: valor configurável associado a automações e systems, evitando valores fixos no código.

Recursos operacionais

  • Execução: uma execução de automação com status, período, logs e traces.

  • Processing logs: resultado por item processado, baseado nos metadados definidos pelo SDK.

  • Traces: logs técnicos e eventos auxiliares da execução.

  • Notificações: alertas enviados quando a automação falha ou requer atenção.

  • Transport: fluxo para promover configurações e versões entre ambientes quando aplicável.

Gestão de APIs

  • API: definição publicada via API Gateway.

  • Plano de uso: política de consumo aplicada a clientes e chaves de API.

  • Chave de API: credencial de consumo para cenários controlados por plano.

  • Servidor de recursos: conjunto de escopos OAuth usados para proteger endpoints.

  • Cliente: aplicação consumidora autenticada para fluxos OAuth e machine-to-machine.

Ferramentas de desenvolvimento

  • CLI: usada para login, listagem de recursos, bootstrap de automações e deploy.

  • SDK: base de desenvolvimento das automações.

  • MCP: interface operacional orientada à leitura para suporte, análise e investigação.

Fluxo típico

  1. criar ou selecionar um ambiente;

  2. criar um pacote;

  3. cadastrar systems e parâmetros necessários;

  4. criar Tabelas De/Para e Sequências quando fizer sentido;

  5. criar uma automação a partir de um template;

  6. implementar a integração com o SDK;

  7. gerar artefato, fazer deploy e executar;

  8. monitorar logs, traces, consumo e falhas.

Last updated