🚀 Primeiros Passos: API do CRM

Bem-vindo à documentação oficial da API do CRM! Nossa API REST foi projetada para ser simples, rápida e fácil de integrar, permitindo que você conecte seus sistemas, sites e aplicativos diretamente com o seu CRM.

Autenticação

Todas as requisições para a API devem ser autenticadas. No painel web, acesse Configurações > Integrações (API) e crie uma nova credencial. Você receberá duas chaves:

1. Access Key: Chave pública que identifica sua aplicação (ex: bk_...).
2. Secret Key: Segredo de autenticação gerado uma única vez (ex: sk_...).

Como enviar as chaves

Envie as chaves em todos os cabeçalhos (headers) HTTP das suas requisições:

X-API-Access-Key: bk_12345abcdef
X-API-Secret-Key: sk_98765xyz
Content-Type: application/json

Códigos de Retorno (HTTP Status)

Código	Significado	Descrição
200	OK	Requisição realizada com sucesso.
201	Created	O recurso foi criado com sucesso.
204	No Content	O recurso foi deletado/atualizado sem corpo na resposta.
400	Bad Request	Faltam parâmetros obrigatórios ou os dados são inválidos.
401	Unauthorized	Chaves de API inválidas, inativas ou faltando.
404	Not Found	O recurso que você tentou acessar não existe.
500	Server Error	Erro interno no nosso servidor.

Informações Importantes

• Rastreabilidade: Todas as alterações feitas pela API utilizando a sua credencial ficarão automaticamente visíveis no histórico (Timeline e Recent Activity) do CRM, marcadas com o nome do usuário gerador da chave.
• Fuso Horário (Timezones): Todos os campos que representam Data e Hora retornam no formato universal UTC (ISO 8601), exemplo: 2026-07-11T12:00:00Z.
• Formato de Dados: A API aceita e retorna dados estritamente em JSON.