Visão geral para desenvolvedores
Como integrar seus sistemas ao Ailove CRM.
A API pública e os webhooks estão planejados para a versão 1. Esta seção descreve o padrão já decidido; os endpoints entram aqui conforme forem lançados.
Padrões da API
| Tema | Padrão |
|---|---|
| Estilo | REST, versionada na URL (/v1) |
| Especificação | OpenAPI gerada dos mesmos esquemas que validam as requisições: documentação e código nunca divergem |
| Autenticação | Chave de API por empresa, com escopos, revogável e exibida uma única vez; OAuth 2.0 para apps de terceiros (v2) |
| Escrita segura | Cabeçalho Idempotency-Key em toda criação |
| Listas | Paginação por cursor |
| Limites | Requisições por minuto por chave, informadas nos cabeçalhos |
| Erros | Formato único, com código estável e mensagem em português |
| Testes | Modo de teste com dados de mentira e nenhum e-mail real |
| Webhooks | Assinados com HMAC, com novas tentativas e tela de entregas |
Compatibilidade
Nada é removido de uma versão publicada. Mudança incompatível vira versão nova, anunciada em Novidades com no mínimo 6 meses de antecedência.
Modelo de dados
Os objetos e campos estão em Modelo de dados, gerado direto do código.