Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.vistum.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
O que são API Keys

API Keys são chaves de autenticação que permitem que sistemas externos (n8n, Google Sheets, Zapier, seu site) enviem dados para o seu CRM sem precisar de login manual. Com uma API Key você pode, por exemplo:
  • Receber um lead de um formulário no seu site e criá-lo automaticamente no CRM
  • Importar leads de uma planilha Google via n8n
  • Conectar qualquer ferramenta que suporte chamadas HTTP
API Keys estão disponíveis apenas nos planos Growth e PRO.
PlanoAPI Keys disponíveis
EssencialNão disponível
Growth1 chave
PRO5 chaves

​
Criar uma API Key

1

Acesse Configurações → Desenvolvedor

No menu lateral (rodapé), clique em Configurações → aba API.Ou clique em API Keys diretamente no grupo Desenvolvedor da sidebar.
2

Clique em Nova API Key

Botão no topo da seção de API Keys.
3

Dê um nome descritivo

Use um nome que identifique de onde essa chave será usada (ex: n8n-producao, site-formulario, zapier).
4

Configure o limite de requisições

Defina quantas requisições por minuto essa chave pode fazer (padrão: 100, máximo: 1.000).
5

Copie a chave

A chave aparece uma única vez. Copie e guarde em local seguro — não é possível recuperá-la depois.Formato: vg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Se perder a chave, você precisará revogar e criar uma nova. A chave antiga pára de funcionar imediatamente após a revogação.

​
Editar uma API Key

Você pode alterar o nome e o limite de requisições sem revogar a chave:
  1. Na lista de API Keys, passe o mouse sobre a chave
  2. Clique no ícone de edição (lápis)
  3. Altere o nome ou o limite
  4. Salve

​
Revogar uma API Key

Para desativar permanentemente uma chave:
  1. Na lista de API Keys, clique no botão de revogar (lixeira)
  2. Confirme a ação
A chave para de funcionar imediatamente. Qualquer sistema que a usava receberá erros 401 Unauthorized.

​
Como usar a chave

Passe a chave no header Authorization de todas as requisições: 
POST https://crm.vistum.com.br/api/v1/leads
Authorization: Bearer vg_live_SUA_CHAVE_AQUI
Content-Type: application/json

​
O que a API Key permite fazer

Atualmente, as API Keys têm apenas um escopo: criar e atualizar leads (leads:write). Com isso você pode:
  • Criar novos contatos no CRM
  • Atualizar dados de contatos existentes
  • Adicionar contatos a pipelines
  • Aplicar tags
  • Vincular produtos e atendentes
Para mais detalhes técnicos, consulte a documentação da API.