Esta página documenta todos los puntos finales de la API REST de Mautic a los que llama el complemento. Todas las solicitudes se realizan a través de la MauticApiClient clase, que envuelve wp_remote_request() y gestiona los encabezados de autenticación (autenticación básica o token OAuth2 Bearer), la codificación JSON, el manejo de errores y la actualización automática de tokens para OAuth2.
Todas las rutas de los puntos finales son relativas a la URL de su instancia de Mautic. Por ejemplo, si su URL de Mautic es https://mautic.example.com, la URL completa para /api/contacts/new sería https://mautic.example.com/api/contacts/new.
Contactos
Crear contacto
Propiedad
Valor
Método
POST
Punto final
/api/contacts/new
Cuando se llama
Al crear un nuevo contacto que aún no existe en Mautic. Llamado por el createOrUpdateContact() método cuando no se encuentra ningún contacto existente por correo electrónico.
Datos enviados
Objeto JSON que contiene campos de contacto: email, firstname, lastname, phone, address1, city, state, zipcode, country, tags (matriz) y cualquier campo personalizado, como mautic_woo_order_data, mautic_woo_cart_data, mautic_woo_recovery_url, mautic_woo_total_spent, mautic_woo_order_count, mautic_woo_coupon_code.
Editar contacto
Propiedad
Valor
Método
PATCH
Punto final
/api/contacts/{id}/edit
Cuando se llama
Al actualizar un contacto existente en Mautic. Llamado por el createOrUpdateContact() método cuando se encuentra un contacto existente por correo electrónico. También se llama directamente para actualizar el campo del código de cupón después de la sincronización del carrito abandonado y para borrar los campos de datos del carrito en la recuperación.
Datos enviados
Objeto JSON con los campos que se van a actualizar. Solo es necesario incluir los campos modificados. El {id} El parámetro path es el ID de contacto de Mautic.
Obtener contacto
Propiedad
Valor
Método
GET
Punto final
/api/contacts/{id}
Cuando se llama
Al recuperar un contacto específico por su ID de Mautic.
Datos enviados
Ninguno. El {id} El parámetro path es el ID de contacto de Mautic.
Buscar contactos por correo electrónico
Propiedad
Valor
Método
GET
Punto final
/api/contacts
Cuando se llama
Al buscar un contacto por su dirección de correo electrónico antes de crearlo o actualizarlo. También se utiliza en la prueba de conexión para verificar la conectividad.
Datos enviados
Parámetros de consulta: search=email:user@example.com y limit=1 para búsquedas de correo electrónico, o limit=1 solo para pruebas de conexión.
Campos de contacto
Obtener campos de contacto
Propiedad
Valor
Método
GET
Punto final
/api/fields/contact
Cuando se llama
Al comprobar qué campos personalizados existen en Mautic. Se activa mediante el botón «Comprobar campos» de la pestaña de configuración de campos de Mautic y mediante la lógica de creación automática de campos.
Datos enviados
Ninguno.
Crear campo de contacto
Propiedad
Valor
Método
POST
Punto final
/api/fields/contact/new
Cuando se llama
Al crear un campo personalizado que falta en Mautic. Se activa mediante el botón «Crear campos» de la pestaña Campos de Mautic y mediante la lógica de creación automática durante la sincronización de carritos abandonados y la sincronización de pedidos.
Datos enviados
Objeto JSON: label (nombre para mostrar), alias (nombre de la máquina), type (tipo de campo: text, url, o number).
El complemento utiliza los siguientes alias de campos personalizados:
Alias
Etiqueta
Tipo
Objetivo
mautic_woo_order_data
Datos del último pedido
text
Cadena JSON que contiene los detalles del último pedido (ID del pedido, estado, total, descuento, cupones, moneda, fecha, método de pago y artículos).
mautic_woo_cart_data
Datos de carritos abandonados
text
Cadena JSON que contiene los detalles del carrito abandonado (total, moneda, URL de recuperación y lista de artículos).
mautic_woo_recovery_url
URL de recuperación del carrito
url
La URL completa en la que un cliente puede hacer clic para restaurar su carrito abandonado y pasar por caja.
mautic_woo_total_spent
Total gastado
number
El total gastado por el cliente a lo largo de su vida en WooCommerce.
mautic_woo_order_count
Recuento de pedidos
number
El número total de pedidos que el cliente ha realizado en WooCommerce.
mautic_woo_coupon_code
Código de cupón de recuperación
text
El código de cupón de WooCommerce generado para los correos electrónicos de recuperación de carritos abandonados.
Etiquetas
Obtener etiquetas
Propiedad
Valor
Método
GET
Punto final
/api/tags
Cuando se llama
Al recuperar etiquetas existentes de Mautic.
Datos enviados
Ninguno.
Crear etiqueta
Propiedad
Valor
Método
POST
Punto final
/api/tags/new
Cuando se llama
Al crear una nueva etiqueta en Mautic que aún no existe.
Datos enviados
Objeto JSON: tag (la cadena del nombre de la etiqueta).
Notas
Crear nota
Propiedad
Valor
Método
POST
Punto final
/api/notes/new
Cuando se llama
Cuando la opción «Añadir notas» está habilitada en la configuración de sincronización de pedidos. Se crea una nota en el contacto de Mautic después de cada sincronización de pedidos.
Datos enviados
Objeto JSON: lead (ID de contacto de Mautic), type ("general"), text (tenga en cuenta que el título y el cuerpo están separados por una nueva línea, que contiene los detalles del pedido y del producto).
Correos electrónicos
Enviar correo electrónico al contacto
Propiedad
Valor
Método
POST
Punto final
/api/emails/{email_id}/contact/{contact_id}/send
Cuando se llama
Cuando la función Email Trigger está habilitada en la configuración de Order Sync y se configura un ID de plantilla para el estado actual del pedido. Envía un correo electrónico transaccional a través de Mautic cuando un pedido pasa a un estado específico.
Datos enviados
Objeto JSON: tokens (pares clave-valor opcionales para la sustitución de variables de plantilla). El {email_id} y {contact_id} Los parámetros de ruta son el ID de la plantilla de correo electrónico de Mautic y el ID de contacto, respectivamente.
Cuando el módulo Carrito abandonado tiene configurado un ID de segmento. Después de sincronizar un carrito abandonado con Mautic, el contacto se añade al segmento especificado.
Datos enviados
Ninguno. El {segment_id} y {contact_id} Los parámetros de ruta son el ID del segmento de Mautic y el ID de contacto, respectivamente.
Autenticación
Todas las solicitudes API incluyen encabezados de autenticación gestionados por el AuthFactory clase. El complemento admite dos métodos de autenticación:
Autenticación básica – Envía un Authorization: Basic encabezado con credenciales de nombre de usuario y contraseña codificadas en Base64.
OAuth2 – Envía un Authorization: Bearer con el token de acceso. Si se recibe una respuesta 401, el complemento intenta automáticamente actualizar el token y vuelve a intentar la solicitud una vez.
Encabezados de solicitud
Cada solicitud API incluye los siguientes encabezados, además del encabezado de autenticación:
Encabezado
Valor
Content-Type
application/json
Accept
application/json
Manejo de errores
El cliente API gestiona los errores en varios niveles:
Errores HTTP de WordPress – Si wp_remote_request() devuelve un WP_Error, el mensaje de error se captura y se devuelve en la matriz de respuesta.
Respuestas HTTP 4xx/5xx – Si el servidor Mautic devuelve un código de estado 400 o superior, el mensaje de error se extrae del cuerpo de la respuesta.
Caducidad del token OAuth2 – Si se recibe una respuesta 401 con autenticación OAuth2, el complemento actualiza automáticamente el token de acceso y vuelve a intentar la solicitud una vez.
Conflictos de correo electrónico únicos – Si no se puede crear un contacto porque el correo electrónico ya existe, el complemento vuelve a intentar la operación como una edición.
Rechazos del campo Región – Si Mautic rechaza el state o country campos, el complemento vuelve a intentarlo sin esos campos.
Todas las solicitudes utilizan un tiempo de espera de 30 segundos.
