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 conectar una integración externa, primero necesitas generar una clave de API segura. Haz clic en tu foto de perfil y selecciona Configuración (1). En el menú de la izquierda, haz clic en Claves MCP y API (2).

Desplázate hacia abajo hasta la sección de claves de API pública y haz clic en Crear (3).

Ingresa un nombre para tu clave, establece una fecha de expiración y 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. Gestionar contactos, etiquetas y campos personalizados:

• Contactos: Crea nuevos contactos, actualiza los existentes, lista a tu audiencia con filtros avanzados o elimina contactos.

• 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. Gestionar newsletters y campañas de correos:

• Newsletters: Crea nuevos borradores, actualiza existentes, target de audiencia (usando etiquetas de inclusión/exclusión), configura detalles del remitente, programa o elimina programación, envía correos de prueba, envía newsletters directamente, elimina borradores y recupera newsletters específicas.

• Campañas: Crea, recupera, actualiza y elimina campañas de correo electrónico completas, así como etapas individuales de la campaña.

c. Gestionar túneles y el editor de página:

• Crear túneles, pasos de opt-in y túneles de webinars: Crea fácilmente nuevos túneles, añade pasos de opt-in a tus túneles y crea túneles de webinars con todos los pasos necesarios, incluyendo las páginas de registro, agradecimiento y transmisión del webinar.

• Listar y recuperar túneles: Explora tus túneles existentes, pasos de opt-in y páginas de webinars, o busca específicos.

• Regenerar contenido de páginas (páginas de webinars): Regenera el contenido completo de una página de webinar.

• Editor de página: Guarda el contenido generado de una página directamente en tus pasos de túnel o en páginas de tu sitio web (reemplazo completo), recupera esquemas JSON para tipos de página específicos y regenera contenido de página de webinar.

Notas:

• Actualmente, modificar (editar) túneles y pasos de túneles a través de MCP no está soportado.

• Eliminar túneles, pasos de túneles y páginas de webinars a través de MCP tampoco está soportado actualmente.

• La IA puede regenerar el contenido de una página de webinar reemplazando el contenido completo, pero las ediciones pequeñas no están soportadas actualmente.

d. Gestionar precios y cupones:

• Crear, editar y eliminar: Genera nuevos planes de precios y cupones, o actualiza parcialmente y elimina los existentes.

• Listar y buscar: Explora todos tus planes de precios y cupones, o recupera específicos por su ID.

e. Gestionar cursos y estudiantes:

• Cursos y estudiantes: Crea, edita configuraciones, elimina, lista, recupera, activa y desactiva cursos. Lista plantillas de páginas de curso y elige un tema para el curso. Recupera una lista de tus cursos existentes y una lista de estudiantes actualmente inscritos.

• Módulos: Crea, edita, elimina, lista y recupera módulos.

• Lecciones: Crea, edita, elimina, añade retrasos, habilita comentarios, lista, recupera, activa y desactiva lecciones.

• Inscribir estudiantes: Inscribe programáticamente contactos en tus cursos individuales.

Nota sobre cursos: Soporte para paquetes de cursos se añadirá en futuras actualizaciones.

f. Gestionar comunidades:

• Comunidades: Recupera una lista de tus comunidades existentes y accede a una lista de los miembros actuales dentro de una comunidad específica.

• Invitar a miembros: Invita programáticamente a nuevos usuarios para que se unan a tus comunidades proporcionando su ID de contacto.

g. Gestionar reglas de automatización:

• Reglas de automatización: Conecta programáticamente eventos y acciones comunes, actualiza reglas existentes (por ejemplo, cambiando una acción manteniendo el mismo disparador) o elimina reglas sutilmente.

• Listar y recuperar: Explora tus reglas de automatización o recupera una regla específica por su ID.

h. Gestionar suscripciones:

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

j. Gestión de productos digitales:

• Crear, ver, actualizar y eliminar: Gestiona completamente tus productos digitales.

• Listar y buscar: Explora tus productos digitales existentes o busca específicos.

• Vincular planes de precios: Crea o vincula programáticamente planes de precios directamente a tus productos digitales.

• Conectar a flujos de venta: Conecta programáticamente productos digitales a tus flujos de venta (formularios de pedido, upsells, downsells).

k. Gestión de productos físicos:

• Crear, ver, actualizar, recuperar y eliminar: Gestiona completamente tus productos físicos.

• Conectar a flujos de venta: Conecta programáticamente productos físicos a tus flujos de venta (formularios de pedido, upsells, downsells).

l. Gestión de configuraciones de ofertas y ventas:

• Crear y configurar ofertas: Configura ofertas para tus flujos de venta, tales como formularios de pedido, upsells y downsells.

• Gestionar configuraciones de ventas: Configura ajustes detallados para tus ofertas, incluyendo cupones, order bumps, moneda, métodos de pago, configuraciones de impuestos, comisiones de afiliados, retrasos de pago y límites de ventas. También puedes adjuntar fácilmente tus productos digitales y físicos directamente a estas ofertas.

m. Gestión de reservas de calendario:

• Crear, actualizar y eliminar eventos: Genera nuevos eventos de calendario de reservas, o modifica y elimina fácilmente los existentes.

• Listar y buscar eventos: Recupera una lista de tus eventos de calendario de reservas o busca específicos por nombre.

• Recuperar detalles del evento: Obtén detalles completos para un evento específico, incluyendo sus ubicaciones, disponibilidad, zona horaria, rango de fechas y recordatorios.

• Listar y filtrar reservas: Recupera una lista de tus reservas de calendario y fíltrelas por evento, estado y rango de fechas.

Nota sobre eventos de calendario: Actualizar el tipo de evento de calendario existente no está soportado actualmente a través de MCP.

n. Gestión de plantillas de SMS:

• Listar y buscar: Recupera una lista de tus plantillas de SMS existentes o busca específicas.

Notas:

• Para identificar y gestionar fácilmente tus tokens, cada uno debe tener un nombre único.

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