API do GS Engage
Conecte formulários, CRM e planilhas ao GS Engage e reaja a vendas ganhas — com ou sem programar.
API do GS Engage
Conecte suas ferramentas ao GS Engage e deixe o fluxo de leads acontecer sozinho — com ou sem escrever código.
A API é a ponte que liga seus outros sistemas ao GS Engage. Com ela, um lead que preenche um formulário no seu site, cai numa planilha ou aparece no seu CRM pode entrar automaticamente na fila do vendedor — sem ninguém copiar e colar. Ela também deixa você reagir a vendas ganhas: quando uma prospecção é marcada como Ganha, o GS Engage avisa seus outros sistemas na hora. E o melhor: dá para montar boa parte dessas integrações sem programar, usando ferramentas como o Zapier.
Não sabe o que é uma API?
Sem problema. Pense nela como um encaixe padrão: as ferramentas conversam entre si por esse encaixe, e você só configura quem fala com quem. Ao longo da documentação a gente traduz cada termo técnico na primeira vez que ele aparece.
Escolha a trilha que combina com o seu momento. Se você está só chegando, comece pela primeira. Se prefere não mexer com código, vá direto para Sem código.
O que dá para automatizar, em linguagem de negócio, e o primeiro passo de cada integração.
Sem códigoIntegre pelo Zapier (e também Make ou n8n) sem escrever uma linha de programação.
GuiasPasso a passo por objetivo: adicionar um lead a uma cadência, criar leads, ouvir vendas ganhas.
ReferênciaA lista completa de operações, campos e respostas — para quem vai colocar a mão no código.
GlossárioEndpoint, webhook, rate limit, HMAC... todos os termos explicados em português claro.
Cada linha abaixo é um objetivo real de negócio. Não precisa entender agora como fazer — as trilhas acima mostram o caminho.
| Você quer... | A API faz isso |
|---|---|
| Captar leads do site sem digitar | Cria o lead no GS Engage assim que o formulário é enviado |
| Colocar um lead na fila do vendedor | Adiciona o lead a uma Cadência e inicia a prospecção |
| Reagir na hora a uma venda ganha | Avisa seu sistema por webhook quando a prospecção vira Ganha |
| Manter o CRM sincronizado | Lê e atualiza dados de leads e prospecções |
| Puxar conversas de WhatsApp e e-mail | Lista as threads e mensagens dos canais de atendimento |
Lead criado pela API entra como Levantada de Mão
Todo lead que chega pela API é marcado como Levantada de Mão e aparece no topo da fila de atividades do vendedor. Ou seja: o time trata esse contato como quente, sem espera.
Dois pontos que valem para qualquer integração — do Zapier ao código próprio.
Sua chave é uma senha
O acesso à API usa uma apiKey (uma chave de cerca de 40 caracteres criada em Configurações › Configurações de API). Como ela viaja na URL, acaba aparecendo em logs e históricos. Trate como senha: guarde em variável de ambiente e nunca cole em canais públicos.
Não existe ambiente de teste
Toda chamada mexe em dados de produção reais — não há sandbox separado. Ao experimentar, prefira operações de leitura e avise seu time antes de qualquer escrita.
Preciso saber programar para usar a API?
Não necessariamente. Muita coisa dá para montar no Zapier apontando e clicando. Programação só é preciso para integrações mais sob medida — e aí a Referência tem tudo.
Onde eu pego minha chave de acesso?
Na plataforma, em Configurações › Configurações de API. A chave aparece uma vez; copie e guarde num lugar seguro.
O que é um endpoint?
É cada "porta" da API — um caminho que faz uma coisa específica, como listar leads ou criar um lead. O Glossário explica esse e os outros termos.
Este artigo foi útil?