O que é a API?
A API (Application Programming Interface) do Sirius CRM permite que você integre o CRM com outros sistemas, automatize tarefas e crie aplicações customizadas. É uma forma de fazer o Sirius conversar com suas outras ferramentas programaticamente.
Gerando uma API Key
Para começar a usar a API:
Vá em Configurações > API
Clique em 'Gerar Nova Chave'
Dê um nome descritivo (ex: 'Integração Zapier', 'Script de relatórios')
Copie a chave gerada - ela só será mostrada uma vez!
Guarde a chave em local seguro (não comite no Git!)
Atenção
Trate sua API key como uma senha. Quem tiver acesso a ela pode fazer ações em nome da sua conta. Revogue chaves comprometidas imediatamente.
Endpoints principais
A API REST do Sirius oferece endpoints para:
GET /api/deals - Listar todos os deals
POST /api/deals - Criar um novo deal
PATCH /api/deals/:id - Atualizar um deal
GET /api/contacts - Listar contatos
POST /api/contacts - Criar novo contato
GET /api/pipelines - Listar pipelines
Dicas Importantes
- Toda requisição precisa incluir o header: Authorization: Bearer {sua-api-key}
- Respeite rate limits: 100 requisições por minuto
- Use pagination para listar grandes volumes de dados
- Veja a documentação completa em /docs/api
Casos de uso comuns
O que você pode fazer com a API:
Dicas Importantes
- Criar deals automaticamente quando alguém preenche formulário no site
- Sincronizar contatos com sua ferramenta de email marketing
- Exportar deals para análise em Business Intelligence
- Integrar com Zapier, Make (Integromat) ou N8N
- Construir dashboards customizados