SOFIA Docs
Versão: 1.0
Owner: Engenharia SOFIA
Atualizado em: 2026
Este portal documenta os contratos técnicos oficiais para integrar com a SOFIA.
Destinado a:
- Desenvolvedores Backend
- Desenvolvedores Frontend
- Arquitetos de Integração
- Times de Produto e Engenharia
O que você encontra aqui
A documentação cobre:
- Modelos de integração (Iframe, postMessage, Webhook, API Pull)
- Especificação técnica (headers, erros, timeouts, payloads)
- Segurança (HMAC, origin validation, rate limit)
- Versionamento e compatibilidade
- Testes e troubleshooting
Ordem Recomendada
Se você está começando agora, siga esta sequência:
-
Primeiros Passos Criação de parceiro, token e contexto (
partner_slug). -
Modelos de Integração Escolha entre Iframe, postMessage, Webhook ou API Pull.
-
Segurança Assinatura HMAC, validação de origin, política de retry.
-
Testes e Debug Simulação de eventos e resolução de erros comuns.
Escolhendo o Modelo Correto
| Cenário | Modelo |
|---|---|
| Embed rápido na UI | Iframe |
| Tempo real no navegador | postMessage |
| Backend robusto (produção) | Webhook |
| Polling controlado (enterprise) | API Pull |
👉 Detalhes completos: Modelos de Integração
Índice Completo
- Introdução
- Primeiros Passos
- Modelos de Integração
- Eventos
- Segurança
- Especificação Técnica
- Testes e Debug
- Versionamento da API
- SDK (Futuro)
- Governança & Compliance Técnico
Princípio Central
Integração com a SOFIA deve ser:
- Determinística
- Idempotente
- Segura
- Versionável
Se você seguir os contratos documentados aqui, sua integração será previsível em produção.
Last updated on