Temas deste artigo
- Introdução
- Antes de começar
- Passo-a-passo
- Perguntas frequentes
O E-goi oferece centenas de integrações e uma API para realizar ações remotas, como adicionar contatos e enviar campanhas.
O que é a API do E-goi?
A API (Application Programming Interface) do E-goi é uma ferramenta poderosa que permite realizar ações remotas na plataforma, como adicionar contatos ou enviar campanhas. Com a capacidade de se integrar com inúmeros serviços, a API expande significativamente a funcionalidade e a automação que o E-goi pode oferecer. Este artigo visa guiá-lo através do acesso e uso da sua chave de API (API key) e do Goidini, bem como fornecer dicas de segurança e sugestões de integração.
O que é o Goidini?
O Goidini é a nossa ferramenta de integrações, que ajuda a fazer toda a configuração inicial da maioria das integrações do E-goi.
As credenciais de acesso ao Goidini são as mesmas que usa no E-goi.
Uma vez no Goidini, basta escolher a integração que pretende e seguir os passos para finalizar a configuração.
O que é um webhook?
É um mecanismo através do qual o E-goi notifica automaticamente um URL à sua escolha sempre que acontece um certo evento, como a inscrição de um contato, um clique num email, etc.
Quando o evento acontece, o E-goi envia um pedido por HTTP (normalmente um POST) para o URL que escolheu. A partir daí, pode armazenar e processar os dados do seu lado num outro software ou serviço.
Antes de começar
Segurança e necessidades
Preparar-se para utilizar a API do E-goi envolve alguns passos iniciais importantes:
- Verifique suas necessidades: Tenha claro o que deseja alcançar com a API, seja para adicionar contatos automaticamente, enviar campanhas de e-mail programaticamente, entre outras funcionalidades.
- Segurança é fundamental: Antes de prosseguir, entenda que sua chave de API é tão sensível quanto a sua senha. Tê-la em mãos é essencial, mas requer que você a mantenha segura e longe de acessos não autorizados.
- Confirme o seu tipo de conta E-goi: A chave da API não está disponível nas contas de teste (ou "trial") e no plano grátis Social One.
Passo-a-passo
Encontrar a sua chave da API
1) Acesse o E-goi e, no menu superior direito, clique em Integrações.
2) Neste espaço você encontrará a sua chave de API pronta para ser copiada.
Manuseio seguro da sua chave de API
Nunca compartilhe sua chave de API com outras pessoas e somente use-a em integrações de confiança, pois ela dá acesso remoto à sua conta E-goi.
O que fazer em caso de roubo da chave de API
1) Acesse o menu das Integrações novamente.
2) Clique em Regenerar a chave para obter uma nova, invalidando a anterior.
Criar um webhook
1) Clique no menu no canto superior direito (onde está o seu ícone de usuário ou foto de perfil) e escolha Integrações.
2) No painel do lado esquerdo, clique em Integrações.
Criar um webhook
Vá à área Gestão de webhooks e clique em Adicionar webhook. Introduza o URL do webhook (ou seja, o URL do seu site que vai receber as informações do E-goi), escolha a lista de contatos onde constam os dados que vai enviar e, por fim, assinale os eventos propriamente ditos (inscrições na lista, aberturas de emails, etc.). Clique em Gravar para criar o webhook.
Daí em diante, sempre que ocorrer um dos eventos que assinalou na lista de contatos, o E-goi enviará os dados desse evento para o URL do webhook, onde pode depois processá-los do seu lado.
Criar um webhook para as mensagens transacionais
Vá à área Gestão de webhooks da transacional e clique em Adicionar webhook. Introduza o URL do webhook (ou seja, o URL do seu site que vai receber as informações do E-goi), escolha o tipo de mensagens transacionais (email ou SMS) e, por fim, assinale os eventos que o E-goi vai enviar (mensagem enviada, mensagem aberta, etc.). Clique em Gravar para criar o webhook.
Daí em diante, sempre que ocorrer nas mensagens transacionais um dos eventos que assinalou, o E-goi enviará os dados desse evento para o URL do webhook, onde pode depois processá-los do seu lado.
Ver estatísticas de uso
1) Clique no menu no canto superior direito (onde está o seu ícone de usuário ou foto de perfil) e escolha Integrações.
2) No painel do lado esquerdo, pode ver:
- Estatísticas da API
- Estatísticas dos webhooks que criar
- Estatísticas dos webhooks das mensagens transacionais
- Estatísticas da API do Registered Message
Em cada estatística, além dos totais, constará cada pedido (ou seja, o log) com:
- URL
- data e hora
- código de resposta
- dados completos do pedido, entre os quais:
- pedido (payload)
- código da resposta
- cabeçalho da resposta
- tempo de resposta
- resposta detalhada
Perguntas frequentes
É difícil integrar a API do E-goi com outros sistemas?
Não. A API do E-goi é projetada para ser flexível e acessível para desenvolvedores. Com uma boa leitura da documentação disponível em inglês, é possível integrar o E-goi a variados sistemas, sites, ou softwares.
Onde posso encontrar exemplos ou inspiração para integrações?
A documentação da API do E-goi é o melhor ponto de partida. Ela não apenas detalha como utilizar a API, mas também pode oferecer insights sobre possíveis integrações e uso de funcionalidades.