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

A API do GS Engage permite a integração com outras plataformas para otimizar a gestão de cadências, leads e prospecções. Essa funcionalidade possibilita a automação de processos e o gerenciamento eficiente de dados, conectando o GS Engage a CRMs, ferramentas de marketing e sistemas de análise.

 

O que é a API do GS Engage?

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.

 

Como funciona a integração via API?

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.

 

Autenticação

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.

 

Como obter a sua chave API?

Para obter sua chave API, siga os seguintes passos:

1° passo: Acesse a página de Ajustes de Permissões, através da navbar clique no atalho "Ajustes e Permissões".

2° passo: Selecione a seção de "Configurações de API".

3° passo: Clique no botão "Criar chave" para gerar uma nova chave API.

4° passo: Copiei a chave de API gerada.

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

GET /api/v1/leads?apiKey=SUA_CHAVE_DE_API

 

Dicas de segurança

• 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.

 

Como excluir sua chave API?

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

1° passo: Acesse a página de Ajustes de Permissões, através da navbar clique no atalho "Ajustes e Permissões".

2° passo: Selecione a seção de "Configurações de API".

3° passo: Clique no botão " Excluir chave de API" para realizar a exclusão da chave API.

4° passo: Confirme a exclusão da chave API clicando na opção "Excluir chave de API".

 

Casos de uso comuns

1. Integração com CRMs: A API do GS Engage pode ser integrada a sistemas de CRM, como o Pipedrive, permitindo que os leads capturados sejam automaticamente sincronizados. Isso garante que todas as informações estejam centralizadas e atualizadas em um único lugar.
2. Integração com Plataformas de Marketing: A API também possibilita a conexão com plataformas de automação de marketing, como o RD Station Marketing. Com isso, é possível criar campanhas personalizadas utilizando dados coletados de diferentes fontes.

 

Como leads criados e iniciados via API são exibidos no GS Engage?

• 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.