Usar la API de E-goi

Temas de este artículo

Introducción
Antes de comenzar
- Seguridad y necesidades
- Costes
Paso a paso
Preguntas frecuentes
- Dificultades en la integración
- Ejemplos de integraciones

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. Mira cómo usarlo.

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

Un webhook es una manera sencilla de integrar E-goi con sistemas o servicios que no se integran directamente con nuestra plataforma.

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.

Costes

La API está disponible en todos los planes E-goi (incluyendo el plan gratuito 5001), excepto en el plan GoSend. Cada plan tiene un límite de llamadas a la API, según nuestra tarifa.

Paso a paso

Encontrar tu clave API

1) Accede a E-goi y, en tu menú de usuario (esquina superior derecha), haz clic en Integrar.

2) En Clave de la API 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 a tu menú de usuario (esquina superior derecha) y haz clic en Integrar.

2) En Clave de la API, pulsa en el botón Regenerar clave, invalidando la anterior.

Crear un webhook

¡Atención! Para crear y usar webhooks, necesitas tener conocimientos técnicos de programación.

1) Haz clic en tu menú de usuario (en la esquina superior derecha) y pulsa en Integrar.

2) En el panel del lado izquierdo, haz clic en Marketing API o Transacional API o Registered API dependiendo de la API de E-goi donde quieras añadir el webhook.

3) Pulsa en la pestaña Gestión de webhooks a la derecha y a continuación en Añadir webhook.

4) 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 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.

Ver estadísticas de uso

1) Haz clic en tu menú de usuario (en la esquina superior derecha) y pulsa en Integrar.

2) En el panel del lado izquierdo, haz clic en Marketing API o Transaccional API o Registered API dependiendo del tipo de estadísticas que quieras ver.

Te saldrán a la derecha las estadísticas de esa API. Si también deseas ver las estadísticas de sus webhooks, haz clic en la pestaña Gestión de webhooks.

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 ha sido diseñada para ser flexible y accesible para programadores. Con una buena lectura de la documentación disponible en inglés, puedes integrar E-goi con numerosos sistemas, sitios web o softwares.

La mayoría de los problemas de integración mediante API están relacionados con la autenticación, la estructura de las peticiones, los límites de la API o el formato incorrecto del payload.

La API devuelve un error

Comprueba:

si la clave de la API es correcta y está activa.
si el endpoint de la API es correcto.
si el método HTTP que has utilizado es el esperado (GET, POST, PUT, DELETE, etc.).
si el payload que has enviado está en JSON válido.
si se han enviado todos los campos obligatorios de la petición.
si no has superado los límites de uso de la API de tu cuenta E-goi.

Ejemplo: Una petición puede devolver un error porque el campo "email" se ha enviado vacío o porque el JSON tiene una coma extra que invalida el payload.

Error de autenticación de la API

Normalmente sucede cuando:

tu clave de la API no es correcta.
tu clave de la API se ha eliminado o regenerado.
tu petición utiliza credenciales de autenticación incorrectas.
el encabezado de autenticación no se ha enviado correctamente.

Comprueba siempre que utilizas la clave API correcta de tu cuenta E-goi y que tu petición tiene los encabezados necesarios según la documentación de la petición.

Petición (o request) inválida

Este error indica que la petición que has hecho a la API no respeta el formato o las reglas que la API espera.

Causas más comunes:

faltan campos obligatorios de la petición.
tipos de datos inválidos.
los ID de los elementos de la petición (por ejemplo, contacto, campaña) no existen.
payload JSON mal formateado.
uso incorrecto del endpoint o del método HTTP.

¡Atención! Incluso pequeñas diferencias en la estructura del JSON pueden invalidar la petición enviada a la API.

Límites de la API

Para proteger la estabilidad de E-goi, la API puede aplicar limitaciones temporales cuando recibe un volumen excesivo de peticiones en poco tiempo.

En estos casos:

algunas peticiones pueden fallar temporalmente.
la API puede devolver errores de limitación (rate limit).
reduce la frecuencia de tus peticiones e inténtalo de nuevo más tarde.

¡Atención! Si haces integraciones de gran volumen, implementa mecanismos automáticos de retry, queue y control de velocidad de tus peticiones.

Validar el payload JSON

Antes de hacer peticiones a la API de E-goi, comprueba que tu JSON:

tiene una estructura válida.
no tiene comas extra.
utiliza las comillas correctamente.
envía los campos que la API espera.
respeta los formatos de fecha, direcciones de email, ID y listas de contactos.

Herramientas como Postman, Insomnia o validadores JSON online pueden ayudarte a probar tu payload antes de usarlo en la API.

¿Dónde puedo encontrar ejemplos o escenarios para integraciones?

Documentación de la API de E-goi: Tu mejor punto de partida.
Use cases: Casos prácticos para usar la API de manera eficaz.