Introdução
Bem-vindo à documentação da API Sonar. Integre gestão de campanhas, clientes e automação de marketing digital em sua aplicação.
Documentação da API Sonar
Integre a gestão de marketing digital diretamente em suas aplicações. Acesse campanhas, clientes, atividades e oportunidades de forma programática.
API RESTful
A API Sonar é RESTful, utiliza JSON para requests/responses e autenticação via API Key no header Authorization.
O que a API oferece
┌─────────────────────────────────────────────────────────────┐
│ Sua Aplicação │
└─────────────────────────┬───────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ API Sonar │
│ ┌───────────────────────────────────────────────────────┐ │
│ │ • Autenticação por API Key │ │
│ │ • CRM de Clientes (PF/PJ) │ │
│ │ • Pipeline de Negócios (Deals) │ │
│ │ • Gestão de Campanhas e Projetos │ │
│ │ • Atividades e Interações │ │
│ │ • Webhooks para eventos em tempo real │ │
│ └───────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘Por que usar a API Sonar?
| Benefício | Descrição |
|---|---|
| Integração Completa | Conecte seu sistema ao Sonar sem precisar acessar a interface web |
| Automação | Crie campanhas, clientes e atividades automaticamente |
| Sincronização | Mantenha seus sistemas sincronizados via webhooks |
| Escalabilidade | API otimizada para alto volume de requisições |
| Segurança | Autenticação via API Key com escopo por time |
Primeiros Passos
Obtenha suas credenciais
Acesse Configurações → API Keys no painel do Sonar e gere suas chaves de API.
Cada chave está vinculada ao seu time e tem acesso completo aos recursos do time.
Configure a autenticação
Todas as requisições devem incluir o header Authorization com sua API Key.
Authorization: Bearer snr_live_sua_chave_aquiFaça sua primeira requisição
Teste a conexão listando suas campanhas:
curl -X GET https://app.sonar.marketing/api/v1/campaigns \
-H "Authorization: Bearer snr_live_sua_chave_aqui" \
-H "Content-Type: application/json"Base URL
Todas as requisições devem ser feitas para:
https://app.sonar.marketing/api/v1Fluxo Típico de Integração
1. Criar Cliente → POST /v1/clients
↓
2. Criar Campanha → POST /v1/campaigns
↓
3. Adicionar Atividades → POST /v1/activities
↓
4. Acompanhar Eventos → Webhooks configuradosRecursos Disponíveis
Autenticação
Como autenticar suas requisições e gerenciar API Keys
Clientes
Gerenciar clientes (Pessoa Física e Jurídica)
Negócios
Gerenciar pipeline de vendas
Campanhas
Gerenciar campanhas de marketing vinculadas a projetos
Atividades
Registrar e acompanhar atividades e interações
Webhooks
Configurar endpoints para receber eventos
Conceitos Importantes
Times (Teams)
Todos os recursos pertencem a um time. Sua API Key está vinculada a um time específico e só pode acessar recursos desse time.
Campanhas vs Negócios
- Campanha (Campaign): Um projeto de marketing em execução (campanha de mídia paga, produção de conteúdo, gestão de redes sociais, etc.)
- Negócio (Deal): Uma oportunidade comercial no pipeline (potencial cliente interessado nos serviços da agência)
Clientes
Clientes podem ser:
- Pessoa Física (PF): CPF, RG, dados pessoais
- Pessoa Jurídica (PJ): CNPJ, razão social, dados empresariais
Fases e Status
- Campanhas: Fases configuráveis no kanban (briefing → planejamento → execução → análise → concluída)
- Negócios: Pipeline comercial (lead → qualificado → proposta → negociação → ganho/perdido)
Limites de Uso
| Plano | Requisições/Minuto | Requisições/Dia |
|---|---|---|
| Starter | 60 | 1.000 |
| Professional | 300 | 10.000 |
| Enterprise | 1.000 | Ilimitado |
Exceder os limites resultará em resposta 429 Too Many Requests. Implemente retry com backoff exponencial.
Suporte
Precisa de ajuda com sua integração?
- Email: suporte@sonar.marketing
- Documentação: Você está aqui!