Cómo usar la API pública (Interfaz de Programación de Aplicaciones) de systeme.io

En este artículo, aprenderás cómo configurar y usar la API pública de systeme.io, incluida la generación de claves de API y las acciones que puedes realizar con ellas.

1. ¿Qué es una API?

El acrónimo API significa "Interfaz de programación de aplicaciones", una serie de instrucciones mediante las cuales una plataforma ofrece servicios a otras plataformas. Es una puerta de acceso estratégica para desarrolladores externos, que les permite acceder a funcionalidades o datos específicos de una plataforma de manera estructurada y segura. Es como un conjunto de herramientas listas para usar que facilitan la creación de nuevas aplicaciones, servicios o combinaciones.

En resumen, systeme.io se abre a otras plataformas para ofrecer sus servicios donde aporta valor añadido.

2. ¿Cómo funciona nuestra API pública?

Nuestra API expone un conjunto cuidadosamente seleccionado de funciones, lo que permite a los desarrolladores interactuar con nuestra plataforma de forma transparente y eficiente. Si deseas saber más sobre cómo funciona, puedes consultar nuestra documentación oficial de la API.

3. Cómo generar tus claves de API

Las claves de API son identificadores únicos que autentican las solicitudes a nuestra API pública. Te permiten acceder y gestionar de forma programática varios recursos en nuestra plataforma.

Para crear una clave de API pública, haz clic en tu foto de perfil, selecciona Configuración (1) y desplázate hacia abajo hasta Claves MCP y API (2).

Haz clic en Crear (3) para empezar a crear una clave API pública.

En la ventana emergente Crear clave API pública, ingresa un nombre y selecciona una fecha y hora de expiración para tu clave de API.

Una vez hecho esto, haz clic en Guardar (4).

Nota: para mantener tu clave de API activa indefinidamente, deja el campo "Expiración" vacío.

Tu clave ya está lista.

4. ¿Qué puedes hacer con nuestra API?

Nuestra API abre algunas posibilidades interesantes. A continuación encontrarás las principales acciones que puedes realizar usando nuestra API pública:

a. Contactos, etiquetas y campos personalizados:

  • Gestionar contactos: crea nuevos contactos, actualiza los existentes, lista a tu audiencia con filtros avanzados o elimina contactos.
  • Gestionar etiquetas: crea, asigna, lista y elimina etiquetas de los contactos.
  • Campos personalizados: recupera los campos personalizados de contacto disponibles y sus identificadores (slugs) para completar correctamente la información de contacto.

b. Newsletters:

  • Crear y actualizar newsletters: Crea nuevos borradores de newsletters o actualiza parcialmente los existentes. Puedes definir el tipo de editor (Clásico o Visual), recuperar el contenido HTML completo y establecer explícitamente el nombre del remitente y la dirección de correo electrónico.
  • Listar y recuperar: revisa tus newsletters existentes o recupera el contenido completo de una newsletter específica usando su ID.

c. Embudos y editor de página:

  • Gestionar túneles: crear nuevos túneles, agregar nuevas etapas (páginas) y obtener una lista de todas las etapas individuales dentro de un túnel específico.
  • Editor de página: Guardar el contenido de página generado directamente en las etapas de tu túnel o en las páginas de tu sitio web (reemplazo completo) y recuperar esquemas JSON para tipos de página específicos.

d. Precios y cupones:

  • Crear, editar y eliminar: genera nuevos precios y cupones, o actualiza parcialmente y elimínalos.
  • Listar y buscar: Explora todos tus precios y cupones, o recupera elementos específicos por su ID.

e. Cursos y estudiantes:

  • Gestionar cursos y estudiantes: obtén una lista de tus cursos y recupera una lista de estudiantes actualmente inscritos.
  • Inscribe estudiantes: inscribe contactos en cursos individualmente de forma programática.

Nota sobre cursos: se añadirá compatibilidad con paquetes de cursos en futuras actualizaciones.

f. Comunidades:

  • Gestionar comunidades: recupera una lista de tus comunidades y accede a una lista de los miembros actuales dentro de una comunidad específica.
  • Invitar a miembros: invita de forma programática a nuevos usuarios para que se unan a tus comunidades proporcionando su ID de contacto.

g. Reglas de automatización:

  • Gestionar reglas: conecta de forma programática eventos y acciones comunes, actualiza reglas (p. ej., cambiar una acción manteniendo el mismo generador) o elimina reglas sutilmente.
  • Listar y recuperar: explora tus reglas de automatización o recupera una regla específica por su ID.

h. Suscripciones:

  • Gestionar suscripciones: recupera una lista de todos los recursos en una suscripción de plataformas de terceros y cancela una suscripción ya sea de inmediato o al final del ciclo de facturación.

i. Webhooks

  • Gestionar webhooks: crea programáticamente nuevos webhooks para recibir notificaciones en tiempo real, recupera listas de tus webhooks existentes y elimina webhooks que ya no sean necesarios.

Notas:

  • Para identificar y gestionar fácilmente tus tokens, cada uno debe tener un nombre.
  • Un token solo se puede copiar inmediatamente después de crearlo. Si olvidaste copiar tu token, elimínalo y crea uno nuevo.
  • Como medida de seguridad, te enviaremos una notificación por correo electrónico cada vez que se cree una nueva clave pública de API en tu cuenta de systeme.io.
  • Puedes crear hasta 3 claves API por cuenta.

Aprende más: Documentación de la API.