Skip to main content
A API SocialSell permite que desenvolvedores integrem qualquer sistema ao CRM, inbox multi-canal, funis de venda e automações de IA da SocialSell. Sincronize contatos, dispare mensagens, monitore negócios e reaja a eventos em tempo real.

Como a API funciona

REST sobre HTTPS

Todos os endpoints seguem o padrão REST. Verbos HTTP representam ações: GET lê, POST cria, PATCH atualiza, DELETE remove.

JSON em tudo

Corpo das requisições e respostas sempre em application/json. Timestamps em ISO 8601 (UTC). Valores monetários em reais.

Paginação por cursor

Listas retornam data[] + meta.next_cursor. Passe o cursor na próxima requisição para avançar páginas — sem offset, sem saltos.

Eventos em tempo real

Configure webhooks para receber notificações instantâneas de criação de contatos, movimentação de negócios, mensagens recebidas e mais.

Retentativa segura

Criação de contatos, negócios e envio de mensagens aceitam Idempotency-Key — repetir depois de um timeout não duplica nada.

Rastreável

Toda resposta traz X-Request-Id, repetido em meta.request_id. É o identificador que o suporte usa.

Base URL

Todas as requisições devem usar HTTPS. Requisições HTTP são rejeitadas.

Autenticação

Gere uma API Key em Configurações → Desenvolvedores no painel. Cada chave possui escopos de permissão granulares — conceda apenas o acesso que sua integração precisa.

Recursos disponíveis

Contatos

CRUD completo, tags, notas e campos personalizados.

Empresas

Vincule contatos a empresas com CRUD e tags.

Negócios

Gerencie negócios em funis, mova entre etapas, marque como ganho/perdido.

Funis de venda

Crie e configure funis com etapas e probabilidades de fechamento.

Conversas

Inbox multi-canal: WhatsApp, Instagram, Messenger e chat do site.

Mensagens

Envie mensagens de texto, mídia e templates via WhatsApp ou Messenger.

Tarefas

Crie e gerencie atividades da equipe de vendas.

Agentes de IA

Configure, publique e monitore agentes de IA de vendas e suporte.

Disparos

Campanhas de disparo em massa via WhatsApp com segmentação de audiência.

Campos personalizados

Crie campos extras em contatos, empresas e negócios.

Webhooks

Receba eventos em tempo real no seu sistema.

Créditos de mensagem

Descontinuado — as mensagens do WhatsApp Oficial são cobradas pela Meta.

Spec OpenAPI

A API inteira está descrita em um arquivo OpenAPI 3.1 — 68 caminhos, 97 operações, 17 schemas:
Serve para gerar cliente na sua linguagem, importar no Postman ou no Insomnia, e validar payloads antes de enviar. O arquivo é montado a partir do próprio código do servidor, e um teste quebra o build se alguma rota ficar de fora.
No Postman: Import → Link e cole a URL acima. Vem com todos os endpoints, parâmetros e schemas de resposta prontos.

Formato padrão de resposta

Toda resposta bem-sucedida segue o mesmo padrão:
Em listas, data é um array e meta inclui total, has_more e next_cursor. Em erros, a resposta tem error.type, error.code e error.message — sempre legível para humanos e tratável por código. Veja a referência de erros.

Próximos passos

Início Rápido

Faça sua primeira requisição em menos de 5 minutos.

Autenticação

Gere uma API Key e entenda os escopos de permissão.

Webhooks

Receba eventos em tempo real sem polling.

Referência completa

Todos os endpoints com exemplos e parâmetros.