Introducción
El conector Mailer Lite de Bizagi está disponible en Connectors Xchange de Bizagi.
A través de este conector, podrá conectar sus procesos de Bizagi a una cuenta en www.mailerlite.com para usar los servicios API de Mailer Lite.
Para más información de las capacidades de este conector, visite Connectors Xchange de Bizagi.
Antes de iniciar
Para probar y usar este conector, necesita:
1.Bizagi Studio previamente instalado.
2.Éste conector previamente instalado a traves de Connectors Xchange, tal como se describe en https://help.bizagi.com/platform/es/index.html?Connectors_Xchange.htm, o a través de el manual de instalación descrito en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm
3.Una cuenta en www.mailerlite.com.
a.Asegúrese de que tiene una llave del API configurada en Bizagi. Tal llave debe corresponderse con la asignada a su cuenta de Mailer Lite. Para obtenerla, inicie sesión con su cuenta de Mailer Lite y haga clic en su perfil en la parte superior derecha de la pantalla, seleccione la opción Integreaciones y ubique la sección API de desarrollador. Allí podrá encontrar o pedir (si no lo ha hecho) su llave del API. El paso a paso de estas instrucciones se puede evidenciar en las imágenes a continuación.
Configurar el conector
Para configurar el conector siga los pasos presentados en el capítulo de configuración en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
Para esta configuración, considere los siguientes parámetros de autenticación:
•Método de autenticación: custom.
•api_key: [your_api_key].
|
Note que [your_api_key] corresponde a la llave del API que obtuvo al realizar las instrucciones mencionadas en la sección anterior de este artículo. |
Usar el conector
Éste conector permite el uso de 23 métodos disponibles para el uso de servicios de Mailer Lite.
Para aprender en general como y donde configurar el uso de un conector, por favor visite el artículo https://help.bizagi.com/platform/es/index.html?Connectors_Studio.htm.
Para mayor información del uso de alguno de los métodos, refiérase a la documentación oficial de Mailer Lite en: https://developers.mailerlite.com/reference..
Al usar el conector, asegúrese de considerar los siguientes detalles de cada uno de los métodos disponibles:
Obtener campañas (Get Campaigns)
Obtiene todos los datos relacionados a sus campañas.
Para configurar las entradas, considere:
•CampaignStatus: Es el único parámetro requerido. Se usa para especificar el estado de las campañas que desea obtener. Los valores posibles son:
osent
odraft
ooutbox
oSi no se especifica ninguno, el valor por defecto es sent.
•limit: limita la cantidad de campañas a retornar,
•Offset: indica cuantas campañas se deben saltar al generar la lista de resultados.
•Order: especifica el orden de las campañas. Los valores posibles son:
oASC - Para orden ascendente.
oDESC - Para orden descendente.
Para configurar las salidas considere:
Obtener número de campañas (Get Campaigns count)
Obtiene el número de campañas que usted tiene del tipo de Estado especificado.
Para configurar las entradas considere:
•CampaignStatus: Es el único parámetro requerido. Se usa para especificar el Estado de las campañas que desea obtener. Los valores posibles son:
osent
odraft
ooutbox
oDe no especificar ninguno, el valor por defecto es sent.
Para configurar las salidas considere:
Eliminar campaña por ID (Delete Campaign by ID)
Permite eliminar una campaña en específico.
Para configurar sus entradas considere:
•campaignId: este parámetro es requerido. El identificador de la campaña que desea eliminar.
Para configurar sus salidas considere:
Actualizar contenido de una campaña (Put Campaign content)
Actualiza el contenido de una campaña.
Para configurar sus entradas considere:
•campaignId: ID de la campaña que desea actualizar.
•html: plantilla HTML del código fuente con el que desea remplazar el que ya existe.
•plain: texto plano del correo.
•auto_inline: define si se necesita convertir el CSS disponible a CSS embebido (excluyendo los queries de multimedia).
Los primeros 3 parámetros son requeridos para que la invocación del servicio sea exitosa.
Para configurar las salidas considere:
Crear acción de campaña (Post campaign action)
Permite enviar, cancelar o agendar una campaña.
Para configurar las entradas considere:
•campaignId: ID de la campaña que desea modificar.
•action: Tipo de acción. Los valores posibles son:
osend
ocancel
•type: Tipo de agendamiento. Los valores posibles son:
o1 - Enviar instantáneamente (si no se especifica, este es el valor por defecto).
o2 - Agendar envío.
•followup_schedule: define el tipo de seguimiento. Los valores posibles son:
o24h - el correo de seguimiento es enviado en 24 horas. (si no se especifica, este es el valor por defecto).
ospecific - el correo de seguimiento se enviará en una fecha específica que debe ser provista.
•followup_date: define la fecha en la que se enviará el seguimiento. El formato esperado es yyyy-mm-dd h:i y solo está disponible cuando el parámetro anterior se definió como específico.
•followup_timezone_id: ID de la zona horaria para le fecha de seguimiento.
•analytics: especifica si se hará análisis sobre la campaña. Los valores posibles son:
o0 - Falso (no).
o1 - Verdadero (si).
•date: especifica la fecha en la que se enviará el correo. El formato esperado es yyyy-mm-dd h:i. Solo estará disponible si el type es 2.
•timezone_id: ID de la zona horaria para el parámetro anterior. Solo estará disponible si el type es 2.
Los dos primeros parámetros son requeridos para que la invocación del servicio sea exitosa.
Para configurar las salidas considere:
Obtener grupos (Get groups)
Obtiene información sobre sus grupos.
Para configurar las entradas considere:
•limit: limita el conjunto de resultados al número provisto.
•Offset: salta esta cantidad de grupos al generar el conjunto de resultados.
•filters: especifica información que los grupos deben satisfacer para ser incluidos en el conjunto de resultados.
Todos los parámetros son opcionales.
Para configurar las salidas considere:
Obtener grupo por ID (Get group by ID)
Obtiene información de un grupo específico.
Para configurar las entradas considere:
•groupId: ID del grupo en particular que desea obtener. Este parámetro es requerido para que la invocación sea exitosa.
Para configurar las salidas considere:
Crear un grupo (Post new group)
Permite crear un nuevo grupo de Mailer Lite en su cuenta.
Para configurar las entradas considere:
•name: nombre del grupo a ser creado. Este parámetro es requerido para que la invocación sea exitosa.
Para configurar las salidas considere:
Actualizar nombre de un grupo (Put group name)
Actualiza el nombre de un grupo existente.
Para configurar las entradas considere:
•groupId: ID del grupo cuyo nombre desea cambiar. Este parámetro es requerido para que la invocación sea exitosa.
•name: nombre nuevo del grupo que se va a actualizar. Este parámetro es requerido para que la invocación sea exitosa.
Para configurar las salidas considere:
Obtener subscriptores (Get subscribers)
Obtiene la lista de subscriptores de un grupo.
Para configurar las entradas considere:
•groupId: ID del grupo cuyos subscriptores se desean obtener. Este parámetro es requerido para que la invocación sea exitosa.
•limit: limita la cantidad de subscriptores a obtener.
•offset: define cuantos registros ignorar al generar los resultados.
•filters: información especificada para limitar los resultados de tal manera que solo los registros que los cumplan sean tenidos en cuenta.
Para configurar las salidas considere:
Obtener subscriptores por tipo (Get subscribers by type)
Obtiene la lista de subscriptores de una grupo que correspondan con el tipo provisto.
Para configurar las entradas considere:
•groupId: ID del grupo cuyos subscriptores se van a obtener. Este parámetro es requerido para que la invocación sea exitosa.
•limit: limita la cantidad de subscriptores a obtener.
•offset: define cuántos registros se deben ignorar a la hora de generar los resultas.
•filters: limita la cantidad de registros a obtener, solo se traen los que correspondan con la información enviada.
•subsType: especifica el tipo de subscriptor a obtener. Este parámetro es requerido para que la invocación sea exitosa. Los posibles valores son:
oactive.
ounsubscribed.
obounced.
ojunk.
ounconfirmed.
Para configurar las salidas considere:
Eliminar subscriptor de grupo (Delete group subscriber)
Eliminar subscriptores de un grupo.
Para configurar sus entradas considere:
•groupId: ID del grupo cuyos subscriptores se van a eliminar.
•subscriberIdent: ID o correo del subscriptor que se va a eliminar del grupo.
Ambos parámetros son requeridos para que la invocación sea exitosa.
Para configurar las salidas considere:
Añadir subscriptor a un grupo (Post group subscriber)
Añadir subscriptores a un grupo.
Para configurar las entradas considere:
•groupId: ID del grupo al que se desea añadir el subscriptor. Este parámetro es requerido para que la invocación del servicio sea exitosa.
•email: correo del subscriptor a añadir. Este parámetro es requerido para que la invocación sea exitosa.
•name: nombre del subscriptor a añadir. Este parámetro es requerido para que la invocación sea exitosa.
•company: compañía del subscriptor a añadir.
•city: ciudad del subscriptor a añadir.
•resubscribe: valor booleano que indica si el subscriptor hacía parte del grupo en el pasado.
•autoresponders: se enviarán auto-respuestas si el valor enviado es True (verdadero). Este parámetro es requerido para que la invocación sea exitosa.
•type: Tipo del subscriptor. Este parámetro es requerido para que la invocación sea exitosa. Los valores posibles son:
ounsubscribed.
oactive.
ounconfirmed.
Para configurar las salidas considere:
Añadir subscriptores a un grupo por importación (Post group subscribers import)
Añade múltiples subscriptores a un grupo en una sola operación.
Para configurar sus entradas considere:
•groupId: ID del grupo al que desea añadir subscriptores. Este parámetro es requerido para que la invocación sea exitosa.
•subscribers: colección de subscriptores a añadir.
oemail: correo del subscriptor a añadir. Este parámetro es requerido para que la invocación sea exitosa.
oname: nombre del subscriptor a añadir.
•resubscribe: valor booleano que indica si los subscriptores hacían parte del grupo en el pasado.
•autoresponders: se enviarán auto-respuestas si el valor de este parámetro es True (verdadero).
Para configurar las salidas considere:
Crear subscriptor (Post subscriber)
Crear un subscriptor sin añadirlo a un grupo.
Para configurar las entradas, considere:
•email: correo del subscriptor a crear. Este parámetro es requerido para que la invocación sea exitosa.
•name: nombre del subscriptor a crear.
•company: compañía del subscriptor a crear.
•city: ciudad del subscriptor a crear.
•resubscribe: valor booleano que indica si el subscriptor existía en el pasado.
•type: Tipo de subscriptor a crear. Este parámetro es requerido para que la invocación sea exitosa. Los valores posibles son:
ounsubscribed.
oactive.
ounconfirmed.
Para configurar las salidas considere:
Obtener subscriptor (Get subscriber)
Obtiene un subscriptor específico al proveer su información.
Para configurar sus entradas considere:
•subscriberId: ID o correo del subscriptor a obtener. Este parámetro es requerido para que la invocación sea exitosa.
Para configurar las salidas considere:
Actualizar subscriptor (Put subscriber)
Actualiza un subscriptor en específico al proveer su información.
Para configurar las entradas considere:
•subscriberId: ID o correo del subscriptor. Este parámetro es requerido para que la invocación sea exitosa.
•name: nuevo nombre para el subscriptor. Este parámetro es requerido para que la invocación sea exitosa.
•company: nueva compañía del subscriptor.
•city: nueva ciudad del subscriptor.
•resend_autoresponders: valor booleano que define si es necesario volver a mandar las auto-respuestas.
•type: nuevo tipo para el subscriptor. Este parámetro es requerido para que la invocación sea exitosa. Los valores posibles son:
ounsubscribed.
oactive.
Para configurar sus salidas considere:
Obtener subscriptor por búsqueda (Get search subscriber)
Obtiene los subscriptores que cumplan con los parámetros especificados.
Para configurar sus entradas considere:
•query: texto usado como string de búsqueda. Este parámetro es requerido para que la invocación sea exitosa.
•offset: cantidad de registros a ignorar al generar los resultados.
•limit: limita la cantidad de resultados a este número.
Para configurar las salidas considere:
Obtener grupos de subscriptor (Get subscriber groups)
Obtiene la lista de los grupos a los que un subscriptor dado pertenece.
Para configurar las entradas considere:
•subscriberId: ID o correo del usuario del que se desean obtener los grupos. Este parámetro es requerido para que la invocación sea exitosa.
Para configurar las salidas considere:
Obtener actividad de subscriptor (Get subscriber activity)
Obtiene las actividades que un subscriptor ha desarrollado.
Para configurar las entradas considere:
•subscriberId: ID o correo del subscriptor del que desea obtener las actividades. Este parámetro es requerido para que la invocación sea exitosa.
Para configurar las salidas considere:
Obtener actividad de subscriptor por tipo (Get subscriber activity by type)
Obtiene las actividades que ha desarrollado un subscriptor que coincidan con el tipo provisto.
Para configurar las entradas considere:
•subscriberId: ID o correo del subscriptor del que desea obtener las actividades. Este parámetro es requerido para que la invocación sea exitosa.
•activityType: Tipo de la actividad del subscriptor que desea obtener. Este parámetro es requerido para que la invocación sea exitosa. Los valores posibles son:
oopens.
oclicks.
ojunks.
obounces.
ounsubscribes.
oforwards.
osendings.
Para configurar las salidas considere:
Last Updated 10/28/2022 4:23:19 PM