API REST e webhooks

API REST pública com várias API keys e webhooks assinados

Registe customers a partir do seu site, formulário ou backend com uma chamada HTTP, e receba cada alteração no seu servidor assinada com HMAC-SHA256.

O seu CRM deixa de ser um local onde é preciso entrar para escrever: passa a ser um endpoint ao qual os seus sistemas chamam.

AiCrm, a app de CRM da AIsToHire, expõe uma API REST pública sobre os seus próprios customers. Com uma API key na cabecera «X-Api-Key» pode criar, listar, consultar, atualizar e apagar customers, e adicionar atividades a qualquer um deles, a partir do formulário do seu site, do seu chatbot, de um Zap, de um script Python ou do seu próprio backend. As respostas são JSON com o formato `{ success, data }`, e o limite é de 100 pedidos por minuto e API key.

O registo via API não duplica: se o email que envia já existe na sua base, o AiCrm atualiza a ficha que já tinha (completa o telefone, o nome ou a empresa que faltavam, une as tags/labels de contacto) e regista um novo envio na sua timeline, devolvendo HTTP 200; se for novo, cria-o e devolve 201. Cada customer que entra via API é automaticamente etiquetado como `api-lead`, mantém as tags/labels de contacto que enviar e guarda o `subId` de origem, além do país, do IP e do navegador de onde chegou.

Pode ter até 20 API keys com nome próprio, além da chave interna da app. Assim, atribui uma API key diferente a cada integração —o site, o formulário da campanha de maio, o estagiário, o fornecedor— e revoga-a individualmente quando essa integração termina, sem afetar as outras. O valor completo de uma API key é mostrado uma única vez, ao criá-la; depois só é visível mascarado na listagem.

Na outra direção, os webhooks avisam os seus sistemas. Configura até 10 destinos, escolhe a que eventos cada um se subscreve (`customer.created`, `customer.updated`, `customer.deleted`, `activity.created`) e o AiCrm faz um POST para o seu URL com as cabeceras `X-AiCrm-Event` e `X-AiCrm-Signature: sha256=…`, a assinatura HMAC-SHA256 do corpo com o segredo desse webhook, para que verifique que a entrega é legítima. Ao guardar o URL, uma proteção anti-SSRF rejeita localhost, 127.0.0.0/8, 10.x, 192.168.x, 172.16-31.x, ::1, 0.0.0.0 e os domínios «.local» e «.internal».

Vantagens de API REST e webhooks

Registo de customers com uma única chamada

um POST para `/api/apps/public/crm/customers` com o email e as tags/labels de contacto que quiser, e o lead já está no seu CRM classificado.

Sem duplicados por design

se o email já existe, a ficha é atualizada e o novo envio é registado na sua timeline em vez de criar uma segunda ficha.

Até 20 chaves nomeadas

uma por integração, revogável separadamente. Se uma chave for vazada, você apaga essa e nada mais para de funcionar.

Webhooks assinados com HMAC-SHA256

você verifica o cabeçalho HTTP `X-AiCrm-Signature` com seu segredo e sabe que o aviso vem do seu CRM e não de um terceiro.

Proteção anti-SSRF incluída

o aplicativo se recusa a entregar webhooks para localhost ou para faixas de rede privadas, assim, seu CRM não pode ser usado para sondar uma rede interna.

CRUD completo, não apenas adições

listar com paginação e filtros (busca, status, tags, país), consultar um contato com sua atividade, atualizá-lo, excluí-lo e registrar atividades para ele.

Origem rastreada automaticamente

cada adição via API salva o `subId` que você envia mais o país, o IP e o navegador, e é marcada como `api-lead` para filtrá-la depois no aplicativo.

Testes sem adivinhação

o aplicativo traz a documentação dos endpoints com um exemplo de `curl` copiável e um botão para enviar uma entrega de teste a cada webhook, com o status e a hora da última tentativa.

Claire Donovan

Conecte seu site ao seu CRM ainda hoje

AiCrm é a ferramenta de CRM da AIsToHire que recebe seus contatos via API REST e notifica seus sistemas com webhooks assinados. Crie sua conta, gere uma chave e faça a primeira chamada.

API REST para CRM com webhooks assinados | AiCrm