Newsletter API Version 2

En esta guía, encontrarán todo lo que necesitan saber sobre nuestra API Version 2, y cómo integrar sus sistemas externos con el plugin Newsletter utilizando dicha API.

Referencia de API

La API Reference es una documentación detallada de todos los detalles de la API. Pueden consultarla para obtener toda la información necesaria.

Autenticación

La mayoría de las llamadas a la API requieren una clave de autenticación para ser invocadas. Esta clave debe ser proporcionada en cada solicitud.

Añadir un suscriptor a mi blog cuando se agrega a mi CRM (u otra herramienta similar)

Para esta tarea, deben utilizar el endpoint “subscribers” con el método “POST”. Este endpoint acepta un objeto JSON en el cuerpo de la solicitud que contiene los datos del suscriptor, como la dirección de correo electrónico. También es posible establecer listas privadas y campos de perfil privados. Esta llamada requiere una clave de autenticación y solo debe ser utilizada para el intercambio de datos entre servidores. No se realiza ninguna verificación de spam, ya que se asume que los datos proporcionados por su otro sistema ya son correctos. Además, esta llamada no envía correos de activación o bienvenida, simplemente inserta al suscriptor en la base de datos con todos sus datos asignados. También se asume que el consentimiento para tratar esos datos ya ha sido obtenido.

Actualizar un suscriptor existente con nuevos datos recolectados en otro lugar

Utilicen el endpoint “subscribers” con el método “PUT”, junto con el ID o el correo electrónico del suscriptor. Este endpoint acepta cualquier tipo de campo de datos del suscriptor y sobrescribe los datos actuales almacenados en el blog. Pueden proporcionar una dirección de correo electrónico o el ID del suscriptor de Newsletter para identificar al suscriptor que se actualizará. También se puede actualizar la dirección de correo electrónico asociada, siempre y cuando no esté ya registrada para otro suscriptor. Esta llamada también está permitida para actualizar listas privadas y campos de perfil, y requiere una clave de autenticación que solo debe utilizarse para intercambios de datos entre servidores.

Agregar o actualizar un suscriptor en una sola llamada

Si desean agregar o actualizar un suscriptor en una sola llamada, deben utilizar el método “PUT” del endpoint “subscribers” como se mencionó anteriormente. Esto les permite realizar estas acciones de manera eficiente y sin tener que realizar múltiples llamadas a la API.

Cambiar el estado de un suscriptor

Para cambiar el estado de un suscriptor, pueden utilizar el método “PUT” proporcionando el ID del suscriptor o el correo electrónico junto con el nuevo estado. Por ejemplo, si desean marcar a un suscriptor como “bounced” (rebotado) o “unsubscribed” (dado de baja), pueden hacerlo mediante esta llamada a la API. Un cambio directo de estado no activa eventos como el envío de correos electrónicos.

Agregar un suscriptor a una lista o listas específicas

Si desean agregar un suscriptor a una lista o listas específicas, pueden utilizar el método “PUT” del endpoint “subscribers”. Deben proporcionar el ID o el correo electrónico del suscriptor y la(s) lista(s) en la(s) que desean realizar el cambio. Esto les permite gestionar de manera flexible las suscripciones de los usuarios y asignarlos a las listas correspondientes según sus preferencias o acciones realizadas.

Interacción con el complemento Autoresponder

Si tienen configurado el complemento Autoresponder, al agregar un suscriptor a una lista conectada a él, comenzará a recibir la serie de correos electrónicos establecidos. La vinculación entre el suscriptor y la serie de correos electrónicos se realiza en un plazo de 5 minutos después de agregar al suscriptor. Esto les brinda la capacidad de automatizar el envío de mensajes de correo electrónico secuenciales y crear una experiencia personalizada para sus suscriptores.

Eliminar un suscriptor

Si desean eliminar completamente los datos de un suscriptor, pueden utilizar el método “DELETE” del endpoint “subscribers”. Esta acción eliminará todos los datos del suscriptor de la base de datos, incluidos los datos personales y las estadísticas de interacción con los boletines. Es importante destacar que esta acción es irreversible, por lo que se debe tener cuidado al utilizarla.

Proceso de suscripción estándar

Si desean proporcionar un formulario de suscripción estándar en su sitio web, pueden utilizar el endpoint “subscriptions” con el método “POST”. Este endpoint permite iniciar el proceso de suscripción estándar, que incluye verificaciones de spam, duplicados y envío de correos electrónicos de activación o bienvenida, según la configuración establecida. Además, pueden personalizar el proceso de suscripción con diversas opciones disponibles. Esta funcionalidad les permite capturar suscriptores de manera efectiva y brindarles una experiencia de suscripción óptima.

Obtener las listas de suscripción configuradas

Si desean obtener una lista de las listas de suscripción configuradas en el plugin Newsletter, pueden utilizar el endpoint “lists” con el método “GET”. Esto les proporcionará la información sobre las listas existentes y les permitirá administrarlas de manera adecuada en su sitio web.

Obtener una lista de los últimos boletines enviados

Si desean obtener una lista de los últimos boletines enviados a través del plugin Newsletter, pueden utilizar el endpoint específico “newsletters”. Este endpoint les permitirá obtener información sobre los boletines completos que han sido enviados. Tengan en cuenta que, por defecto, solo se retornan los boletines públicos, a menos que utilicen una clave de autenticación para acceder a todos los boletines. Esto les brinda la posibilidad de obtener una lista de los boletines pasados y utilizarlos, por ejemplo, para crear un archivo o mostrar un historial de boletines en su sitio web.

Pruebas en localhost sin HTTPS

Si desean probar la API en un servidor local sin utilizar el protocolo HTTPS, pueden seguir las indicaciones proporcionadas anteriormente agregando el código necesario en el archivo wp-config.php. Esto les permitirá realizar pruebas y desarrollo en un entorno local sin la necesidad de configurar un certificado SSL. Sin embargo, es importante tener en cuenta que, al no utilizar HTTPS, las llamadas a la API no estarán cifradas y los datos viajarán sin protección adicional.

En resumen, la API Version 2 del plugin Newsletter les ofrece un conjunto de herramientas poderosas para administrar suscripciones, gestionar suscriptores y enviar boletines de manera eficiente. Con su clave de autenticación, podrán interactuar con la API de manera segura y personalizar la integración con sus sistemas externos. Explore la documentación de la API para obtener más detalles sobre los endpoints y las opciones disponibles, y aproveche al máximo las funcionalidades que ofrece el plugin Newsletter.