Skip to main content

Especificação da API Interna

Esta página resume as convenções que fundamentam as rotas atuais da API.

Autenticação

  • os endpoints internos de operador são uma superfície de staging e devem, no futuro, ficar atrás da imposição de sessão do Supabase ou de autenticação por bearer token assinado
  • os endpoints de webhook validam as assinaturas do provider antes de aceitar as entregas
  • espera-se que os endpoints de compatibilidade usem API keys com escopo por chamador

Convenções de resposta

  • as respostas de compatibilidade devem permanecer simples e legíveis por máquina
  • falhas de validação devem retornar detalhes de erro estruturados
  • endpoints de replay e de operador devem incluir identificadores estáveis para auditoria e rastreamento de retries
  • a correlação de requisições pertence aos logs e aos payloads de resposta, quando útil

Famílias de endpoints

Ingestão de provider

  • /webhooks/meta
  • /webhooks/whatsapp

Compatibilidade

  • /compat/contact
  • /compat/journey-trigger/{legacyPath}

Operador e runtime

  • /internal/runtime
  • /internal/operations
  • /internal/conversations
  • /internal/webhooks
  • /internal/webhook-events
  • /internal/webhook-rejections
  • /internal/outbox
  • /internal/audit-logs

Modelo de replay

  • o replay cria uma nova tentativa de processamento em vez de alterar a entrega original
  • as chaves de deduplicação permanecem explícitas
  • os logs de auditoria devem mostrar quem repetiu (replayed) o quê e por quê

Leia a seguir