Conectar outras ferramentas
Como criar uma chave de API para receber leads de formulários, landing pages ou ferramentas como Zapier, escolher o que a chave pode fazer, revogar uma chave e acompanhar os envios de webhook.
Recurso de plano mais completo
A API pública não vem em todos os planos. Se não aparece na sua tela, o seu plano atual não inclui. Fale com a Vendee para incluir no seu contrato.
Para que serve
A chave de API é a senha que outra ferramenta usa para conversar com o seu Vendee. Com ela, o formulário do seu site, uma landing page ou uma ferramenta como o Zapier consegue mandar leads direto para o CRM, ou ler e criar negócios, contatos e atividades.
Quem monta a integração do outro lado normalmente é a pessoa que cuida do seu site ou da ferramenta. O seu papel aqui é criar a chave, decidir o que ela pode fazer e entregar a chave a essa pessoa.
Onde fica
Configurações › Dados e integrações › API e Integrações. A tela tem o título API e Integrações e a frase "Crie chaves de API e conecte ferramentas externas ao seu CRM."
Como criar uma chave
Abra o formulário
Clique em Nova chave. Abre a janela Nova chave de API.
Dê um nome
Em nome da chave, escreva para que ela serve. Ex.: Integração — Site institucional. Até 120 caracteres.
Escolha o que a chave pode fazer
Em "O que esta chave pode fazer?":
- Acesso total: "A chave pode fazer tudo na API — agora e no futuro."
- Permissões específicas: marque só o necessário, por grupo. Ex.: para um formulário do site, basta a permissão de Entrada de lead.
Prefira Permissões específicas: se a chave vazar, o estrago fica limitado ao que ela pode fazer.
Crie e copie
Clique em Criar chave. Na tela Copie sua chave agora, copie a chave completa e guarde num lugar seguro. Aparece Chave copiada.. Depois de fechar essa janela, o Vendee só mostra o começo da chave.
Entregue a chave
A chave vai no campo de "API Key" ou "Token" da ferramenta que vai enviar os leads. Trate a chave como uma senha: mande só para quem vai configurar a integração.
Como ler e cuidar das chaves
Cada chave aparece num cartão com o nome, o começo da chave, o selo Ativa ou Revogada, a data de criação, o último uso (Nunca usada se ainda não foi usada) e as permissões.
- Revogar: a chave para de funcionar na hora. Use quando a integração acabou ou a chave vazou. Não dá para desfazer; se precisar de novo, crie outra chave.
- Apagar: só aparece depois de revogar. Remove a chave da lista para sempre.
Envios de webhook
O cartão Envios de webhook mostra os últimos 50 envios que o Vendee tentou fazer para os endereços cadastrados pela integração (webhook é o aviso que o Vendee manda para outra ferramenta quando algo acontece no CRM). Cada linha mostra o evento, a situação (Entregue, Não entregue, Tentando de novo ou Na fila), a resposta do outro sistema e quando foi.
Os endereços de webhook são cadastrados pela própria integração, não por esta tela.
Regras
- A chave completa aparece uma vez só. Perdeu? Revogue a antiga e crie outra.
- Use uma chave por integração. Assim, se uma integração acabar, você revoga só a chave dela.
- Quando a API não está ativa no escritório, a tela abre só para consulta, com o aviso "A API pública está desligada neste workspace" (workspace é o seu escritório no Vendee). As chaves não funcionam e os envios de webhook são descartados até a API voltar a estar ativa no seu plano.
O que pode dar errado
- "Selecione ao menos uma permissão para continuar.": em Permissões específicas, marque pelo menos uma.
- "Revogue a chave antes de apagar.": revogue primeiro.
- "Não foi possível carregar as chaves": clique em Tentar novamente.
- Os envios aparecem como "Não entregue": o sistema do outro lado não respondeu ou recusou. Mostre a coluna de resposta a quem cuida da integração.
Exportar os dados
Como baixar os contatos, empresas, negócios e atividades do escritório em arquivos CSV, com os campos personalizados, e como abrir e ler esses arquivos no Excel.
Dúvidas comuns sobre as configurações
Respostas rápidas para as dúvidas mais comuns sobre as configurações do Vendee — acesso, equipe, funil, qualificação, propostas, metas, listas, alertas, importação e exportação.