# Docs - Visão geral: Instalação, ambiente e credenciais - [Início rápido](/docs/comecar): Instale o termo_core, defina o ambiente e faça sua primeira chamada a um serviço da Termotubos em menos de 5 minutos. - [Instalação](/docs/comecar/instalacao): Como adicionar o termo_core em projetos TypeScript e Rust, fixar a versão e escolher só os serviços que você usa. - **Fundamentos** - [Ambiente](/docs/comecar/ambiente): A variável AMBIENTE é a única configuração do SDK. Ela decide para qual endereço cada serviço aponta. - [Credencial e token do aplicativo](/docs/comecar/credencial): Como o SDK se autentica. Token do usuário logado para o painel, token do aplicativo para a conversa entre back-ends. - [Erros](/docs/comecar/erros): Toda função de rota falha com ErroAoChamarServico, com o status HTTP e o campo erro da resposta. - [Convenções](/docs/comecar/convencoes): Como os nomes das funções são formados, a ordem dos argumentos e o que cada função devolve. - **Referência** - [Funções da base](/docs/comecar/funcoes_da_base): Referência das funções feitas à mão que todo serviço usa. Ambiente, credencial, token do aplicativo, endereços e erros. - [Arquitetura](/docs/comecar/arquitetura): Como o termo_core é gerado dos contratos OpenAPI e como esta documentação acompanha o código. - Serviços: Funções por aplicativo e entidade - [Serviços](/docs/servicos): Todas as 644 funções do termo_core, por aplicativo e por entidade, em TypeScript e em Rust. - **Aplicativos** - TermoAI - [TermoAI](/docs/servicos/ai): Gateway de IA da Termotubos. POST /gateway atende pedidos de texto, imagem, áudio e vídeo com as chaves de IA cadastradas, trocando de chave e de IA quando uma falha, e grava cada pedido numa convers… - **Entidades** - [Chave IA](/docs/servicos/ai/chave_ia): 8 funções do TermoAI para chave ia. - [Chave IA uso](/docs/servicos/ai/chave_ia_uso): 2 funções do TermoAI para chave ia uso. - [Conversa](/docs/servicos/ai/conversa): 7 funções do TermoAI para conversa. - [Gateway](/docs/servicos/ai/gateway): 3 funções do TermoAI para gateway. - [Preço modelo](/docs/servicos/ai/preco_modelo): 7 funções do TermoAI para preço modelo. - **Painel e administração** - [Auth](/docs/servicos/ai/auth): 1 função do TermoAI para auth. - [Colaborador](/docs/servicos/ai/colaborador): 5 funções do TermoAI para colaborador. - [Config system gateway](/docs/servicos/ai/config_system_gateway): 7 funções do TermoAI para config system gateway. - [Configuração](/docs/servicos/ai/configuracao): 2 funções do TermoAI para configuração. - [Perfil acesso](/docs/servicos/ai/perfil_acesso): 7 funções do TermoAI para perfil acesso. - [Teste](/docs/servicos/ai/test): 2 funções do TermoAI para teste. - TermoAuth - [TermoAuth](/docs/servicos/auth): Consulta de usuários, apps, setores, cargos e funções do serviço central de login da Termotubos. Toda chamada usa o token do usuário logado, e as permissões são as dele: quem não é master só enxerga… - **Entidades** - [App](/docs/servicos/auth/app): 6 funções do TermoAuth para app. - [Cargo](/docs/servicos/auth/cargo): 6 funções do TermoAuth para cargo. - [Função](/docs/servicos/auth/funcao): 6 funções do TermoAuth para função. - [Setor](/docs/servicos/auth/setor): 6 funções do TermoAuth para setor. - [Token de app](/docs/servicos/auth/token_de_app): 1 função do TermoAuth para token de app. - [Usuário](/docs/servicos/auth/usuario): 4 funções do TermoAuth para usuário. - TermoBucket - [TermoBucket](/docs/servicos/bucket): Microserviço de arquivos da Termotubos, sobre o Cloudflare R2. Os apps enviam, listam, baixam e apagam os próprios arquivos na API de arquivos (/public/{app} e /private/{app}) com o token de aplicati… - **Entidades** - [Aplicativo](/docs/servicos/bucket/aplicativo): 7 funções do TermoBucket para aplicativo. - [Arquivo](/docs/servicos/bucket/arquivo): 13 funções do TermoBucket para arquivo. - [Log](/docs/servicos/bucket/log): 1 função do TermoBucket para log. - **Painel e administração** - [Auth](/docs/servicos/bucket/auth): 8 funções do TermoBucket para auth. - [Colaborador](/docs/servicos/bucket/colaborador): 5 funções do TermoBucket para colaborador. - [Perfil acesso](/docs/servicos/bucket/perfil_acesso): 7 funções do TermoBucket para perfil acesso. - [Teste](/docs/servicos/bucket/test): 2 funções do TermoBucket para teste. - TermoIntranetAPI - [TermoIntranetAPI](/docs/servicos/intranet): Consulta, só leitura, de clientes, faturas e funcionários vindos do banco da intranet da Termotubos, mais a administração de quem pode entrar (acessos, perfis de acesso com as permissões por área e c… - **Entidades** - [Cliente](/docs/servicos/intranet/cliente): 5 funções do TermoIntranetAPI para cliente. - [Fatura](/docs/servicos/intranet/fatura): 5 funções do TermoIntranetAPI para fatura. - [Funcionário](/docs/servicos/intranet/funcionario): 5 funções do TermoIntranetAPI para funcionário. - **Painel e administração** - [Auth](/docs/servicos/intranet/auth): 9 funções do TermoIntranetAPI para auth. - [Colaborador](/docs/servicos/intranet/colaborador): 6 funções do TermoIntranetAPI para colaborador. - [Configuração](/docs/servicos/intranet/configuracao): 2 funções do TermoIntranetAPI para configuração. - [Perfil acesso](/docs/servicos/intranet/perfil_acesso): 8 funções do TermoIntranetAPI para perfil acesso. - [Teste](/docs/servicos/intranet/test): 2 funções do TermoIntranetAPI para teste. - [Webhooks](/docs/servicos/intranet/webhooks): 1 função do TermoIntranetAPI para webhooks. - TermoLeads - [TermoLeads](/docs/servicos/leads): Consulta da base CNPJ da Receita Federal. GET /api/cnpj/{cnpj} é pública; a listagem de empresas, os colaboradores e os perfis de acesso exigem o token do usuário logado no TermoAuth e a permissão da… - **Entidades** - [CNPJ](/docs/servicos/leads/cnpj): 2 funções do TermoLeads para cnpj. - [Importar](/docs/servicos/leads/importar): 8 funções do TermoLeads para importar. - [Micro serviço](/docs/servicos/leads/micro_servico): 1 função do TermoLeads para micro serviço. - **Painel e administração** - [Auth](/docs/servicos/leads/auth): 1 função do TermoLeads para auth. - [Colaborador](/docs/servicos/leads/colaborador): 5 funções do TermoLeads para colaborador. - [Configuração](/docs/servicos/leads/configuracao): 2 funções do TermoLeads para configuração. - [Perfil acesso](/docs/servicos/leads/perfil_acesso): 7 funções do TermoLeads para perfil acesso. - [Saúde](/docs/servicos/leads/saude): 1 função do TermoLeads para saúde. - [Teste](/docs/servicos/leads/test): 2 funções do TermoLeads para teste. - TermoPortal - [TermoPortal](/docs/servicos/portal): API do Portal B2B da Termotubos: catálogo (produtos), unidades clientes, pessoas e perfis, cotações, pedidos, faturas e notas fiscais, entregas e pedidos de venda do ERP, indicadores e configurações.… - **Entidades** - [Arquivo](/docs/servicos/portal/arquivo): 3 funções do TermoPortal para arquivo. - [Boletim técnico](/docs/servicos/portal/boletim_tecnico): 8 funções do TermoPortal para boletim técnico. - [Boletim técnico medida](/docs/servicos/portal/boletim_tecnico_medida): 8 funções do TermoPortal para boletim técnico medida. - [Catálogo atributo](/docs/servicos/portal/catalogo_atributo): 7 funções do TermoPortal para catálogo atributo. - [Cliente](/docs/servicos/portal/cliente): 9 funções do TermoPortal para cliente. - [Contato](/docs/servicos/portal/contato): 7 funções do TermoPortal para contato. - [Cotação](/docs/servicos/portal/cotacao): 7 funções do TermoPortal para cotação. - [Dashboards](/docs/servicos/portal/dashboards): 1 função do TermoPortal para dashboards. - [Endereço](/docs/servicos/portal/endereco): 7 funções do TermoPortal para endereço. - [Expedição](/docs/servicos/portal/expedicao): 3 funções do TermoPortal para expedição. - [Fatura](/docs/servicos/portal/fatura): 7 funções do TermoPortal para fatura. - [Indicador compra](/docs/servicos/portal/indicador_compra): 1 função do TermoPortal para indicador compra. - [Indicador venda](/docs/servicos/portal/indicador_venda): 1 função do TermoPortal para indicador venda. - [Nota fiscal](/docs/servicos/portal/nota_fiscal): 6 funções do TermoPortal para nota fiscal. - [Painel produto](/docs/servicos/portal/painel_produto): 2 funções do TermoPortal para painel produto. - [Pedido](/docs/servicos/portal/pedido): 7 funções do TermoPortal para pedido. - [Pedido venda](/docs/servicos/portal/pedido_venda): 3 funções do TermoPortal para pedido venda. - [Pedido venda Tiny](/docs/servicos/portal/pedido_venda_tiny): 5 funções do TermoPortal para pedido venda tiny. - [Perfil](/docs/servicos/portal/perfil): 7 funções do TermoPortal para perfil. - [Produto](/docs/servicos/portal/produto): 7 funções do TermoPortal para produto. - [Produto conflito sincronização](/docs/servicos/portal/produto_conflito_sincronizacao): 7 funções do TermoPortal para produto conflito sincronização. - [Produto estrutura](/docs/servicos/portal/produto_estrutura): 1 função do TermoPortal para produto estrutura. - [Produto Termotubos](/docs/servicos/portal/produto_termotubos): 5 funções do TermoPortal para produto termotubos. - [Produto Tiny](/docs/servicos/portal/produto_tiny): 1 função do TermoPortal para produto tiny. - [Rastreamento](/docs/servicos/portal/rastreamento): 7 funções do TermoPortal para rastreamento. - [Tabela auxiliar](/docs/servicos/portal/tabela_auxiliar): 7 funções do TermoPortal para tabela auxiliar. - [Unidade](/docs/servicos/portal/unidade): 7 funções do TermoPortal para unidade. - **Painel e administração** - [Colaborador](/docs/servicos/portal/colaborador): 7 funções do TermoPortal para colaborador. - [Configuração](/docs/servicos/portal/configuracao): 7 funções do TermoPortal para configuração. - [Configuração provedor](/docs/servicos/portal/configuracao_provedor): 2 funções do TermoPortal para configuração provedor. - [Versão](/docs/servicos/portal/versao): 1 função do TermoPortal para versão. - TermoSell - [TermoSell](/docs/servicos/sell): Atendimento comercial da Termotubos pelo WhatsApp: cadastro de clientes, robôs de atendimento com IA (fluxo em etapas e ferramentas), conexão com o Chatwoot e com os números da Z-API, modelos de IA e… - **Entidades** - [Cliente](/docs/servicos/sell/cliente): 10 funções do TermoSell para cliente. - [Conversa](/docs/servicos/sell/conversa): 8 funções do TermoSell para conversa. - [Dashboard](/docs/servicos/sell/dashboard): 1 função do TermoSell para dashboard. - [Robô](/docs/servicos/sell/robo): 9 funções do TermoSell para robô. - [Robô ferramenta](/docs/servicos/sell/robo_ferramenta): 7 funções do TermoSell para robô ferramenta. - **Painel e administração** - [Auth](/docs/servicos/sell/auth): 8 funções do TermoSell para auth. - [Colaborador](/docs/servicos/sell/colaborador): 5 funções do TermoSell para colaborador. - [Config system Chatwoot](/docs/servicos/sell/config_system_chatwoot): 7 funções do TermoSell para config system chatwoot. - [Config system WhatsApp](/docs/servicos/sell/config_system_whatsapp): 2 funções do TermoSell para config system whatsapp. - [Config system Z-API](/docs/servicos/sell/config_system_z_api): 2 funções do TermoSell para config system z-api. - [Configuração](/docs/servicos/sell/configuracao): 2 funções do TermoSell para configuração. - [Perfil acesso](/docs/servicos/sell/perfil_acesso): 7 funções do TermoSell para perfil acesso. - [Teste](/docs/servicos/sell/test): 2 funções do TermoSell para teste. - [Webhooks](/docs/servicos/sell/webhooks): 3 funções do TermoSell para webhooks. - TermoSupport - [TermoSupport](/docs/servicos/support): Suporte e gestão de projetos da Termotubos. A API é o painel: cadastro dos aplicativos atendidos e dos documentos da base de conhecimento de cada um (área aplicativos); projetos ligados aos aplicativ… - **Entidades** - [Anexo](/docs/servicos/support/anexo): 5 funções do TermoSupport para anexo. - [Aplicativo](/docs/servicos/support/aplicativo): 4 funções do TermoSupport para aplicativo. - [Comentário](/docs/servicos/support/comentario): 6 funções do TermoSupport para comentário. - [Documento](/docs/servicos/support/documento): 7 funções do TermoSupport para documento. - [Etiqueta](/docs/servicos/support/etiqueta): 7 funções do TermoSupport para etiqueta. - [Histórico](/docs/servicos/support/historico): 1 função do TermoSupport para histórico. - [Notificação](/docs/servicos/support/notificacao): 6 funções do TermoSupport para notificação. - [Projeto](/docs/servicos/support/projeto): 7 funções do TermoSupport para projeto. - [Seção](/docs/servicos/support/secao): 7 funções do TermoSupport para seção. - [Tarefa](/docs/servicos/support/tarefa): 7 funções do TermoSupport para tarefa. - [Ticket](/docs/servicos/support/ticket): 8 funções do TermoSupport para ticket. - **Painel e administração** - [Auth](/docs/servicos/support/auth): 8 funções do TermoSupport para auth. - [Colaborador](/docs/servicos/support/colaborador): 5 funções do TermoSupport para colaborador. - [Configuração](/docs/servicos/support/configuracao): 2 funções do TermoSupport para configuração. - [Perfil acesso](/docs/servicos/support/perfil_acesso): 7 funções do TermoSupport para perfil acesso. - [Teste](/docs/servicos/support/test): 2 funções do TermoSupport para teste. - [Webhooks](/docs/servicos/support/webhooks): 1 função do TermoSupport para webhooks. - TermoTracing - [TermoTracing](/docs/servicos/tracing): Rastreamento de navegação e erros dos sites e sistemas da Termotubos. O script instalado em cada site envia lotes de eventos para POST /evento/ingestao com a chave pública do aplicativo, sem token; o… - **Entidades** - [Aplicativo](/docs/servicos/tracing/aplicativo): 7 funções do TermoTracing para aplicativo. - [Erro](/docs/servicos/tracing/erro): 7 funções do TermoTracing para erro. - [Evento](/docs/servicos/tracing/evento): 7 funções do TermoTracing para evento. - [Sessão](/docs/servicos/tracing/sessao): 7 funções do TermoTracing para sessão. - [Uso](/docs/servicos/tracing/uso): 7 funções do TermoTracing para uso. - **Painel e administração** - [Auth](/docs/servicos/tracing/auth): 8 funções do TermoTracing para auth. - [Colaborador](/docs/servicos/tracing/colaborador): 5 funções do TermoTracing para colaborador. - [Configuração](/docs/servicos/tracing/configuracao): 2 funções do TermoTracing para configuração. - [Perfil acesso](/docs/servicos/tracing/perfil_acesso): 7 funções do TermoTracing para perfil acesso. - [Teste](/docs/servicos/tracing/test): 1 função do TermoTracing para teste. - [Webhooks](/docs/servicos/tracing/webhooks): 1 função do TermoTracing para webhooks. - TermoWebhook - [TermoWebhook](/docs/servicos/webhook): Hub central de eventos da Termotubos. Os apps publicam em POST /eventos com o token de aplicativo do TermoAuth e recebem as entregas assinadas com a chave Ed25519 do hub (chaves públicas em GET /.wel… - **Entidades** - [Aplicativo](/docs/servicos/webhook/aplicativo): 4 funções do TermoWebhook para aplicativo. - [Assinatura](/docs/servicos/webhook/assinatura): 7 funções do TermoWebhook para assinatura. - [Chave de assinatura](/docs/servicos/webhook/chave_de_assinatura): 1 função do TermoWebhook para chave de assinatura. - [Entrega](/docs/servicos/webhook/entrega): 4 funções do TermoWebhook para entrega. - [Esquema](/docs/servicos/webhook/esquema): 1 função do TermoWebhook para esquema. - [Evento](/docs/servicos/webhook/evento): 5 funções do TermoWebhook para evento. - [Evento recusado](/docs/servicos/webhook/evento_recusado): 3 funções do TermoWebhook para evento recusado. - [Eventos](/docs/servicos/webhook/eventos): 2 funções do TermoWebhook para eventos. - [Solicitação de reprocessamento](/docs/servicos/webhook/solicitacao_de_reprocessamento): 4 funções do TermoWebhook para solicitação de reprocessamento. - [Tipo de evento](/docs/servicos/webhook/tipo_de_evento): 7 funções do TermoWebhook para tipo de evento. - [Versão de esquema](/docs/servicos/webhook/versao_de_esquema): 7 funções do TermoWebhook para versão de esquema. - **Painel e administração** - [Auth](/docs/servicos/webhook/auth): 8 funções do TermoWebhook para auth. - [Colaborador](/docs/servicos/webhook/colaborador): 5 funções do TermoWebhook para colaborador. - [Configuração](/docs/servicos/webhook/configuracao): 2 funções do TermoWebhook para configuração. - [Perfil acesso](/docs/servicos/webhook/perfil_acesso): 7 funções do TermoWebhook para perfil acesso. - [Teste](/docs/servicos/webhook/test): 2 funções do TermoWebhook para teste. - **Em breve** - TermoMCP - [TermoMCP](/docs/servicos/mcp): Cliente do TermoMCP no termo_core. - TermoQuality - [TermoQuality](/docs/servicos/quality): Cliente do TermoQuality no termo_core. - TermoStatus - [TermoStatus](/docs/servicos/status): Cliente do TermoStatus no termo_core. - TermoStudio - [TermoStudio](/docs/servicos/studio): Cliente do TermoStudio no termo_core. - TermoWMS - [TermoWMS](/docs/servicos/wms): Cliente do TermoWMS no termo_core. - Eventos: Publicar e receber eventos do TermoWebhook - [Eventos do TermoWebhook](/docs/eventos): Como os apps da Termotubos publicam e recebem eventos pelo hub, com contratos tipados gerados dos esquemas cadastrados. - **Rust** - [Publicar](/docs/eventos/publicar): Publicar um evento no TermoWebhook na hora, com o token do aplicativo. Feature webhook_publicar. - [Fila no Postgres](/docs/eventos/fila_postgres): Guardar o evento na mesma transação que grava a mudança e enviar em background, com novas tentativas. Feature webhook_postgres. - [Receber](/docs/eventos/receber): Conferir a assinatura Ed25519 de uma entrega do hub e ler o evento tipado. Feature webhook_receber. - **Contratos** - Catálogo de eventos - [TermoAuth](/docs/eventos/catalogo/termo_auth): Eventos publicados pelo TermoAuth: colaborador.atualizado, colaborador.criado. - Recursos: IA, glossário e esta documentação - [Usar com IA](/docs/recursos): Esta documentação foi feita para ser lida por pessoas e por agentes de IA. Veja como entregar o SDK inteiro ao seu assistente. - [Glossário](/docs/recursos/glossario): Os termos usados no termo_core e nesta documentação. - [Sobre esta documentação](/docs/recursos/documentacao): Como rodar, editar e publicar esta documentação, feita com Fumadocs e publicada no Cloudflare Pages.