Chaves de API
As Chaves de API são tokens Bearer que concedem acesso programático à API REST do LeadHub. Use-as para criar integrações personalizadas, sincronizar dados com outros sistemas ou automatizar tarefas via código.
Criando uma Chave de API
- Vá para Integrações → Chaves de API.
- Clique em Nova Chave de API.
- Preencha:
| Campo | Descrição |
|---|---|
| Nome | Nome descritivo (ex.: "Integração do Meu App", "Zapier") |
| Permissões | Quais ações essa chave pode executar (somente leitura, leitura e escrita) |
| Expira Em | Data de expiração opcional; deixe em branco para não expirar |
- Clique em Salvar.
- Copie o token imediatamente — ele é exibido apenas uma vez. Se perdê-lo, você deverá gerá-lo novamente.
Usando uma Chave de API
Inclua a chave como token Bearer em cada requisição à API:
GET /api/leads HTTP/1.1
Host: yourdomain.com
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json
Endpoints da API
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/leads | Listar todos os leads (paginado) |
GET | /api/leads/{id} | Obter um único lead |
POST | /api/leads | Criar um novo lead |
PUT | /api/leads/{id} | Atualizar um lead |
DELETE | /api/leads/{id} | Excluir um lead |
GET | /api/pipelines | Listar pipelines |
GET | /api/tags | Listar tags |
POST | /api/leads/{id}/tags | Adicionar tags a um lead |
A referência completa da API está disponível na documentação Swagger do LeadHub em /api/documentation na sua instalação.
Revogando uma Chave
Para revogar uma chave de API:
- Vá para Integrações → Chaves de API.
- Clique no ícone de exclusão na linha da chave e confirme.
A chave é invalidada imediatamente. Qualquer requisição que a use receberá uma resposta 401 Não Autorizado.
Boas Práticas de Segurança
- Nunca faça commit de chaves de API em controle de versão (GitHub, Bitbucket, etc.)
- Use chaves somente leitura quando precisar apenas ler dados
- Defina datas de expiração para chaves usadas em integrações temporárias
- Revogue chaves imediatamente se elas puderem ter sido expostas
- Use uma chave por integração para poder revogar apenas as específicas