Skip to main content
Este guia reúne as melhores práticas para usar o Triglit de forma eficiente e segura.

Segurança

  • Nunca commite chaves em repositórios Git
  • Use variáveis de ambiente
  • Use chave pública (pk_) no frontend
  • Use chave secreta (sk_) apenas no backend
  • Rotacione chaves regularmente
  • Sempre valide dados de entrada
  • Use validação no frontend e backend
  • Sanitize dados antes de processar
  • Sempre valide assinaturas de webhooks
  • Use HTTPS em produção
  • Implemente rate limiting no seu endpoint

Performance

  • Monitore rate limits
  • Implemente retry com backoff exponencial
  • Use cache quando apropriado
  • Use paginação para listagens grandes
  • Configure limites apropriados
  • Evite buscar todos os dados de uma vez
  • Mantenha workflows simples e focados
  • Evite workflows muito longos
  • Use custom nodes para operações pesadas

Design de Workflows

  • Use nomes descritivos
  • Documente propósito de cada workflow
  • Use convenções consistentes
  • Mantenha workflows simples
  • Divida workflows complexos em menores
  • Use sub-workflows quando apropriado
  • Crie novas versões para mudanças significativas
  • Mantenha versões antigas para rollback
  • Teste versões antes de publicar

Tratamento de Erros

  • Valide dados antes de enviar
  • Trate erros de validação adequadamente
  • Forneça mensagens de erro claras
  • Implemente retry para erros transitórios
  • Use backoff exponencial
  • Não retry para erros 4xx (exceto 429)
  • Logue todos os erros
  • Inclua contexto relevante
  • Monitore logs regularmente

Integração

  • Crie um cliente reutilizável
  • Centralize lógica de autenticação
  • Implemente tratamento de erros consistente
  • Use idempotency keys para operações críticas
  • Torne workflows idempotentes
  • Implemente idempotência em custom nodes
  • Monitore chamadas à API
  • Configure alertas para erros
  • Acompanhe métricas de uso

Sub-Tenants e Multi-Tenancy

  • Use chaves de API corretas para identificar o tenant
  • O tenant é identificado automaticamente pela chave de API
  • Não é necessário enviar tenantId explicitamente
  • Use sub-tenants para oferecer multi-tenancy aos seus clientes
  • Cada cliente final pode ser um sub-tenant
  • Mantenha hierarquia lógica e documente o propósito de cada sub-tenant
  • Dados são isolados automaticamente por tenant e sub-tenant
  • Monitore logs e métricas para garantir isolamento correto
  • Use sub-tenants quando precisar segmentar por cliente final ou departamento

Checklist

Antes de ir para produção:
  • Chaves de API em variáveis de ambiente
  • Tratamento de erros implementado
  • Retry com backoff implementado
  • Validação de dados implementada
  • Webhooks validando assinaturas
  • Logging configurado
  • Monitoramento configurado
  • Testes implementados
  • Documentação atualizada
Revise este guia regularmente e atualize suas práticas conforme necessário.