Skip to main content

Documentation Index

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

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

​
API Keys

Toda requisição à API do Vistum requer uma API Key no header Authorization: 
Authorization: Bearer vg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Formato da chave

As chaves seguem o padrão vg_live_ seguido de 40 caracteres hexadecimais: 
vg_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
A chave é exibida uma única vez no momento da criação. Se perdida, revogue e gere uma nova — não é possível recuperar a chave original.

​
Onde gerar sua API Key

  1. Acesse Configurações → Desenvolvedor → API Keys no CRM
  2. Clique em Nova API Key
  3. Defina um nome descritivo e limite de requisições por minuto
  4. Copie e guarde a chave gerada

​
Escopos

Cada API Key tem um escopo que define quais operações ela pode realizar:
EscopoPermissão
leads:writeCriar e atualizar contatos e cards no pipeline
Atualmente o único escopo disponível é leads:write. Novos escopos serão adicionados em versões futuras.

​
Segurança

  • Não exponha sua chave em código frontend, repositórios públicos ou logs
  • Use variáveis de ambiente para armazenar a chave na sua aplicação
  • Configure uma data de expiração para chaves de uso temporário
  • Revogue imediatamente se suspeitar de comprometimento

​
Erros de autenticação

CódigoCausa
401 UnauthorizedChave inválida, ausente ou expirada
403 ForbiddenChave válida, mas sem o escopo necessário
402 Payment RequiredPlano não inclui acesso à API
Exemplo de resposta 401
{
  "error": "Unauthorized",
  "hint": "Pass a valid API key: Authorization: Bearer <key>"
}
Exemplo de resposta 403
{
  "error": "Forbidden",
  "hint": "This API key does not have the 'leads:write' scope",
  "scopes": ["outro:escopo"]
}