Chaves e autenticação
Chaves de API
Existem dois tipos de chave:
Chave secreta (cvs_) | Chave publicável (cvp_) | |
|---|---|---|
| Onde usar | Servidores e ferramentas de automação (n8n, Zapier, Make, seu sistema) | Formulários em páginas e apps que rodam no navegador |
| Envio em lote | Sim, até 100 por vez | Não |
| O que a resposta devolve | Resultado e identificador do registro | Só { "success": true } |
| Restrição de origem | Opcional por IP | Obrigatória: só os sites que você autorizar |
Chave secreta nunca vai em página ou app público. Se for preciso enviar de um formulário no navegador, use a chave publicável.
A chave aparece uma única vez, na criação. Guarde-a em um cofre de senhas ou no campo de credenciais da sua ferramenta. Você pode ter várias chaves ativas ao mesmo tempo, o que permite trocar uma chave sem tirar nada do ar: crie a nova, atualize a ferramenta e revogue a antiga.
Cada chave define para onde os registros vão (etapa do funil, lista, tags e responsável padrão), quais ações ela pode fazer (escopos write:leads e write:prospects) e se exige consentimento do titular.
Autenticação
Envie a chave em um destes cabeçalhos:
Authorization: Bearer SUA_CHAVE
X-Api-Key: SUA_CHAVE
Para testar a conexão:
curl -H "Authorization: Bearer SUA_CHAVE" https://api.conversaas.com.br/v1/inbound/ping
Resposta esperada:
{ "ok": true, "keyName": "n8n producao", "keyType": "SECRET", "scopes": ["write:leads", "write:prospects"] }