Una Guía de Acceso a la RESTful API de ActiveTrail
ActiveTrail les brinda a sus usuarios un espacio de trabajo online eficaz y sencillo. Sin embargo, hay compañías que prefieren trabajar con nosotros a través de sus propios sistemas, mediante el uso de una Interfaz de Programación de Aplicaciones (API por sus siglas en inglés), en lugar de usar nuestra interfaz de usuario estándar (UI). Además, ciertas operaciones requieren ser integradas con sistemas externos como el sitio web del cliente, sistemas de CRM (Gestión de Relaciones con los Clientes), entre otros. La interfaz API hace posible tales integraciones, permitiéndoles a los programadores llevar a cabo operaciones de forma remota, como la sincronización de datos.
RESTful API te permite realizar todas las acciones disponibles en el sistema de ActiveTrail a través de una interfaz de máquina. La API es muy intuitiva, clara y fácil de usar. Así que, pongámonos manos a la obra.
¿Cómo ingreso a la RESTful API?
Para comenzar a usar RESTful API, tendrás que iniciar sesión en ActiveTrail y, en la parte superior derecha del menú principal, ir a:
Más>> Integraciones >> API >> Apps
En Configuración, en la pestaña de “API Apps”, puedes ingresar un token de acceso que te permitirá conectarte al sistema ActiveTrail.
Para crear un token de acceso, haz clic en el botón de “New” y a continuación se abrirá la ventana “API Apps”, donde podrás introducir los detalles del token y, finalmente, generarlo.
ActiveTrail te permite crear tantos Tokens de Acceso como necesites, donde cada token corresponde a un sistema diferente. Puedes cancelar cada token por separado, de modo que elimines su acceso en un sistema particular sin afectar tu capacidad de trabajar con otros sistemas.
Para un token de acceso determinado también puedes definir una única dirección o un rango de direcciones IP autorizadas.
Después de rellenar la información del token de acceso, haz clic en “Save”. Esto generará el token en sí y aparecerá en la lista de la ventana “API Apps”.
Webhooks
En “Settings”, a la derecha de la pestaña de “API Apps”, se encuentra la pestaña de “Events”. En la documentación de la RESTful API se les denomina a estos eventos como Webhooks, que, en el sistema, representan las actualizaciones de la información de contacto.
Estas actualizaciones pueden realizarse manualmente cuando hagas dichos cambios directamente en el Sistema de ActiveTrail, cuando alguien se registre a través de un formulario de registro, o en el momento en que un usuario modifique externamente su información de contacto (por ejemplo, en un formulario de “update information” disponible en el sitio web de algún tercero). Esto puede aplicar en otros casos.
Para que ActiveTrail pueda conectarse a tu sistema, necesitas ingresar la dirección web de la API en el campo URL del evento deseado. Por favor, ingresa las URLs completas incluyendo “http://”, por ejemplo, “https://www.activetrail.es”.
“Parameters” – agrega los parámetros basados en tu propia API, que serán enviados con cada llamada que reciba tu API.
“Test” – realiza una prueba para comprobar que tu aplicación está recibiendo las llamadas de ActiveTrail.
Existen varios eventos que activarán el Webhook y harán que ActiveTrail realice una llamada a tu API. Para configurar los eventos, ingresa la URL de tu API en los campos correspondientes. Los principales eventos son:
- Modificaciones de Contacto – Ocurre cuando se realiza un cambio en la información de un contacto por algún medio que no sea la interfaz de usuario de ActiveTrail, es decir, como resultado de una actualización externa (bien sea mediante un formulario de registro, una actualización de API, por una landing page o cualquier otra forma que no sea manual).
- Modificación manual de un contacto– Cuando se realiza un cambio manual a los detalles de un contacto directamente en la aplicación web de ActiveTrail (la interfaz de usuario de ActiveTrail).
Los eventos adicionales disponibles en el sistema son:
- Proceso de Automatización
- Un contacto se ha unido al grupo
- Un contacto ha sido eliminado del grupo
- Un contacto canceló su suscripción
- Contacto actualizado
El enfoque de la documentación online
Se puede acceder directamente a la RESTful API a través de Internet (no únicamente a través de la aplicación web ActiveTrail), sin embargo, también hemos publicado documentación en nuestro sitio web que describe claramente cada función y ¡qué puedes hacer con cada una de ellas!
Todas las tareas que se pueden completar utilizando la interfaz de usuario de ActiveTrail también se pueden ejecutar mediante la API. Todas las funciones del sistema están disponibles para ti, incluidas las automatizaciones.
Encontrarás dos pestañas adicionales en la ventana Configuración que están relacionadas con las integraciones a sistemas externos:
Facebook Leads – Te permite iniciar sesión en tu cuenta de Facebook a través del sistema ActiveTrail y elegir el Facebook leads que te gustaría sincronizar con tus contactos de ActiveTrail.
Zapier – Zapier es una aplicación web que te permite integrar aplicaciones, como ActiveTrail, a un nivel de API con otras aplicaciones, como puede ser a tu sistema de CRM. Si deseas realizar dichas integraciones, pero no tienes desarrolladores de software, o acceso a programadores, esta es la opción ideal para ti.
¿Deseas obtener información adicional sobre la RESTful API?
Escribe a soporte@activetrail.es
No requiere tarjeta de crédito