Temas de este artículo
- Introducción
- Antes de comenzar
- Paso a paso
- Preguntas frecuentes
E-goi ofrece cientos de integraciones y una API para realizar acciones remotas, como agregar contactos y enviar campañas.
¿Qué es la API de E-goi?
La API (Application Programming Interface) de E-goi es una herramienta poderosa que permite realizar acciones remotas en la plataforma, como añadir contactos o enviar campañas. Con la capacidad de integrarse con cientos de servicios, la API expande significativamente la funcionalidad y la automatización que E-goi puede ofrecer. Este artículo tiene como objetivo guiarte a través del acceso y uso de tu clave de la API (API key) y de Goidini, así como proporcionarte consejos de seguridad y sugerencias de integración.
¿Qué es Goidini?
Goidini es nuestra herramienta de integraciones, que ayuda a realizar toda la configuración inicial de la mayoría de las integraciones de E-goi.
Las credenciales de acceso a Goidini son las mismas que utilizas en E-goi.
Una vez en Goidini, solo debes elegir la integración que deseas y seguir los pasos para finalizar la configuración.
¿Qué es un webhook?
Es un mecanismo a través del cual E-goi notifica automáticamente una URL escogida por ti siempre que ocurre un cierto evento, como la inscripción de un contacto en tu lista, un clic en tu email, etc.
Cuando ocurre el evento, E-goi envía una solicitud por HTTP (normalmente un POST) a tu URL. A partir de ahí, puedes almacenar y procesar los datos en tu lado en otro software o servicio.
Antes de comenzar
Seguridad y necesidades
Utilizar la API de E-goi implica algunos pasos iniciales importantes:
- Verifica tus necesidades: Ten claro lo que deseas lograr con la API, ya sea para agregar contactos automáticamente, enviar campañas de email programáticamente, entre otras funcionalidades.
- La seguridad es fundamental: Antes de continuar, entiende que tu clave API es tan sensible como tu contraseña. Tenerla a mano es esencial, pero requiere que la mantengas segura y lejos de accesos no autorizados.
- Confirma tu tipo de cuenta E-goi: La clave API no está disponible en las cuentas de prueba (o "trial") y en el plan gratis Social One.
Paso a paso
Encontrar tu clave API
1) Accede a E-goi y, en el menú superior derecho, haz clic en Integraciones.
2) En este espacio encontrarás tu clave de la API, lista para que la copies.
Manipulación segura de tu clave API
La clave solamente debe usarse quando te la pida una integración, así que nunca la compartas con otras personas, dado que facilita el acceso remoto a tu cuenta E-goi. Protégela como si fuera tu contraseña.
¿Qué hacer en caso de robo de mi clave API?
Genera una clave nueva lo antes posible:
1) Ve al menú en la esquina superior derecha y pulsa en Integraciones.
2) En la página de las integraciones, haz clic en el botón Regenerar clave, invalidando la anterior.
Crear un webhook
1) Haz clic en el menú en la esquina superior derecha (donde está tu ícono de usuario o foto de perfil) y elige Integraciones.
2) En el panel del lado izquierdo, haz clic en Integraciones.
Crear un webhook
Ve a la área Gestión de webhooks y haz clic en Añadir webhook. Introduce la URL del webhook (es decir, la URL de tu web que va a recibir la información de E-goi), elige la lista de contactos donde están los datos que vas a enviar y, finalmente, selecciona los eventos propiamente dichos (inscripciones en tu lista, aperturas de emails, etc.). Haz clic en Guardar para crear el webhook.
A partir de ese momento, cada vez que ocurra en la lista de contactos uno de los eventos que seleccionaste, E-goi enviará los datos de ese evento a tu URL del webhook, donde puedes procesarlos en tu lado.
Crear un webhook para los mensajes transaccionales
Ve a la área Gestión de webhooks del transaccional y haz clic en Añadir webhook. Introduce la URL del webhook (es decir, la URL de tu web que va a recibir la información de E-goi), elige el tipo de mensajes transaccionales (email o SMS) y, finalmente, selecciona los eventos que E-goi va a enviar (mensaje enviado, mensaje abierto, etc.). Haz clic en Guardar para crear el webhook.
A partir de ese momento, cada vez que ocurra en los mensajes transaccionales uno de los eventos que seleccionaste, E-goi enviará los datos de ese evento a la URL del webhook, donde puedes procesarlos en tu lado.
Ver estadísticas de uso
1) Haz clic en el menú en la esquina superior derecha (donde está tu ícono de usuario o foto de perfil) y elige Integraciones.
2) En el panel del lado izquierdo, puedes ver:
- Estadísticas de la API
- Estadísticas de los webhooks que crees
- Estadísticas de los webhooks de los mensajes transaccionales
- Estadísticas de la API del Registered Message
En cada estadística, además de los totales, cada solicitud incluirá:
- URL
- fecha y hora
- código de respuesta
- datos completos (es decir, logs) de la solicitud, entre los cuales:
- solicitud (payload)
- código de la respuesta
- encabezado de la respuesta
- tiempo de respuesta
- respuesta detallada
Preguntas frecuentes
¿Es difícil integrar la API de E-goi con otros sistemas?
No. La API de E-goi está diseñada para ser flexible y accesible para desarrolladores. Con una buena lectura de la documentación (en inglés), podrás integrar E-goi a variados sistemas, sitios web o aplicaciones de software.
¿Dónde puedo encontrar ejemplos o escenarios para integraciones?
La documentación de la API de E-goi es tu mejor punto de partida. No solo detalla cómo utilizar la API, sino que también puede ofrecerte ideas sobre posibles integraciones y uso de funcionalidades.