Growth Station

Como realizar a integração via API com o GS Engage?

Conecte o GS Engage a CRMs, ferramentas de marketing e sistemas de análise via API para automatizar a gestão de cadências, leads e prospecções.

Integração via API com o GS Engage

Conecte o GS Engage a CRMs, ferramentas de marketing e sistemas de análise para automatizar a gestão de cadências, leads e prospecções.

A API do GS Engage permite a integração com outras plataformas para otimizar a gestão de cadências, leads e prospecções, possibilitando a automação de processos e o gerenciamento eficiente de dados.

A API do GS Engage é uma interface que permite a comunicação entre o GS Engage e outras plataformas, como CRMs, sistemas de automação de marketing e ferramentas de análise de dados. Com ela, é possível automatizar processos e otimizar a gestão de leads.

Por meio da API, é possível:

Iniciar leads

Automatizar o início do contato com um lead dentro da plataforma.

Criar leads

Adicionar novos leads ao GS Engage diretamente de outras ferramentas.

Extrair dados

Obter informações sobre leads, cadências e atividades realizadas para análise e integração com outros sistemas.

A API do GS Engage permite a comunicação entre o sistema e outras plataformas, como CRMs, sistemas de automação de marketing e ferramentas de análise de dados. Isso é feito por meio de chamadas HTTP que possibilitam o envio e recebimento de dados entre os sistemas.

Método apiKeyQuery

Para acessar a API, é utilizado o método de autenticação apiKeyQuery. Isso significa que é necessário incluir uma chave de API (API Key) em todas as requisições para autenticação.

Para obter sua chave API, siga os seguintes passos:

1

Acesse Ajustes e Permissões

Na navbar, clique no atalho Ajustes e Permissões.

Atalho Ajustes e Permissões na navbar do GS Engage

2

Abra Configurações de API

Selecione a seção de Configurações de API.

Seção Configurações de API nos ajustes do GS Engage

3

Crie uma nova chave

Clique no botão Criar chave para gerar uma nova chave API.

Botão Criar chave nas Configurações de API

4

Copie a chave

Copie a chave de API gerada.

Chave de API gerada pronta para ser copiada

5

Use a chave nas requisições

Inclua a chave de API copiada nas requisições da seguinte forma:

GET /api/v1/leads?apiKey=SUA_CHAVE_DE_API

Documentação técnica completa

Para saber mais sobre as requisições disponíveis, acesse a Referência da API do GS Engage.

Proteja sua chave de API

  • Proteja sua chave: não compartilhe sua chave de API publicamente, nem a inclua em scripts ou URLs acessíveis publicamente.
  • Exclusão de chave: se houver suspeita de comprometimento da chave, exclua-a imediatamente e gere uma nova.

Para excluir a chave API gerada, siga os seguintes passos:

1

Acesse Ajustes e Permissões

Na navbar, clique no atalho Ajustes e Permissões.

Atalho Ajustes e Permissões na navbar do GS Engage

2

Abra Configurações de API

Selecione a seção de Configurações de API.

Seção Configurações de API nos ajustes do GS Engage

3

Exclua a chave

Clique no botão Excluir chave de API para realizar a exclusão.

Botão Excluir chave de API nas Configurações de API

4

Confirme a exclusão

Confirme a exclusão da chave API clicando na opção Excluir chave de API.

Confirmação de exclusão da chave de API

Painel de Atividades

Leads iniciados via API aparecem com a tag Levantada de Mão e são exibidos primeiro na listagem de atividades a serem realizadas.

Gerenciamento de Leads

Leads inseridos através da integração via API são exibidos como Criado a partir da API.

Ainda tem dúvida?

Abra uma solicitação para o nosso time.

Sua opinião importa

Este guia resolveu sua dúvida?

Leva poucos segundos e ajuda a manter a KB realmente útil.

Nesta página

Conteúdo mantido por Produto GS Engage