Manual del usuario - Sinermail

2 Manual de uso i gestión de SINERMAIL

INDICE

Índice o Página Principal ...................................................................................................................... 3

Contactos ...................................................................................................................................... 4 -‐ 13

Envíos ......................................................................................................................................... 14 – 20

Estadísticas ................................................................................................................................. 21 – 25

API REST ..................................................................................................................................... 26 – 29

FAQ’s y Preguntas Frecuentes ............................................................................................................ 30

Manual de uso i gestión de SINERMAIL 3

INDICE O PAGINA PRINCIPAL

Figura 1

-‐ LEYENDA FIGURA 1 -‐

Menú donde puede ver su página principal o inicio.

Panel de gestión de contactos.

Panel de gestión de Envíos de los boletines electrónicos.

Panel de visualización de las estadísticas de los envíos de boletines.

Nombre del usuarios conectado actualmente.

Créditos disponibles del usuario activo para poder realizar envíos de boletines.

Botón para cerrar la sesión del usuario activo actualmente.

Tabla de los envíos programados y pendientes. Al hacer clic en “Ver más” te muestra mas detalles. (ver sección “Envíos”)

Tabla de los envíos realizados. Al hacer clic en “Ver más” te muestra mas detalles. (ver sección “Estadísticas”)

Muestra la documentación del servicio SinerMail.

Vuelve a cargar tu menú o página principal.


CONTACTOS – Crear nuevo Contacto

Figura 2


Muestra la libreta de direcciones de todos los usuarios ordenados alfabéticamente.

Formulario para dar de alta a un nuevo contacto.

Interface para importar contactos des de un archivo de texto externo.

Interface para exportar los contactos en un fichero de texto.

Muestra todos los contactos que se han dado de baja.

Formulario para crear campos personalizados en el formulario de alta de usuarios.

Nos muestran mensajes al realizar cambios, mensajes satisfactorios o erróneos.

Te re direcciona a la libreta de direcciones.

Te re direcciona al formulario de alta contactos.

Formulario de alta y modificación de contactos.

Nos permite agregar el contacto existente a las listas.

Botón para dar de alta al contacto.


CONTACTOS – Baja Contacto

Figura 3


Nos permite filtrar los emails de los contactos de forma que solo nos muestren los que deseemos ver.

Nos muestran los resultados de los correo dados de baja correspondiente al filtro introducido.

CONTACTOS – Menú Eliminar Lista de Contactos

Figura 4


Formulario para eliminar una lista de contactos de la libreta.

CheckBox para marcar si se desea eliminar los contactos que contenga, si no se marca simplemente borrará la lista i los contactos que contenía se les eliminará la lista eliminada. Si se marca eliminará la lista i los contactos.

Botón para ejecutar el borrado de la lista seleccionada con o sin contactos. *ESTE MENÚ EMERGENTE SE MUESTRA AL CLICAR EN LA CRUZ ROJA DE CADA LISTA(VER FIGURA7)


CONTACTOS – Campos Personalizados Creación Contacto

Los campos personalizados se utilizan para tener más información sobre el contacto que queremos añadir a nuestra libreta de contactos.

Figura 5


Muestra todos los campos personalizados que han sido creados.

Nos da la opción de eliminar el campo seleccionado.

Permite crear un nuevo campo personalizado.

Figura 6


Nos permite añadir un campo personalizado en el registro de contactos.

Nombre que le daremos al nuevo campo que vamos a crear.

Tipo del campo que estamos creando. (VER SECCIÓN EJEMPLOS PERSONALIZADOS)

Botón para crear el campo que hemos definido.


CONTACTOS – Ejemplos Campos Personalizados

OPCIÓN CAMPO DE TEXTO – Campo texto (una sola línea)

Figura 6.1

RESULTADO Figura 6.1

-‐ LEYENDA FIGURA 6.1 -‐

Tipo del Campo personalizado. En este caso es un campo de texto de una sola línea. -‐ LEYENDA RESULTADO FIGURA 6.1 -‐

En el formulario de creación de contactos podemos ver que el campo creado anteriormente ha sido agregado. En el caso de Campo de Texto podremos escribir texto en un campo de una sola línea.


OPCIÓN PARÀGRAFO -‐ Campo texto (varias líneas)

Figura 6.2



Tipo del Campo personalizado. En este caso es un campo de texto multi-‐línea. -‐ LEYENDA RESULTADO FIGURA 6.2 -‐

En el formulario de creación de contactos podemos ver que el campo creado anteriormente ha sido agregado. En el caso de Párrafo podremos escribir texto en un campo varias líneas.


OPCIÓN DESPLEGABLE – Selección Única

Figura 6.3



Tipo del Campo personalizado.

Opciones que deseamos mostrar en el campo desplegable.

Elimina una opción creada.

Añade una nueva opción a nuestro campo personalizado. -‐ LEYENDA RESULTADO FIGURA 6.3 -‐

En el formulario de creación de contactos podemos ver que el campo creado anteriormente ha sido agregado. En el caso del desplegable solo se puede escoger un valor de la lista mostrada.

10

Manual de uso i gestión de SINERMAIL

OPCIÓN CHECKBOXES – Selección Múltiple

Figura 6.4




Opciones que deseamos mostrar en el campo desplegable.



En el formulario de creación de contactos podemos ver que el campo creado anteriormente ha sido agregado. En el caso del CheckBoxes nos da la opción de marcar más de una opción de las mostradas.


1

OPCIÓN RADIOBUTTON – Selección Única

Figura 6.5




Opciones que deseamos mostrar en el campo personalizado.



En el formulario de creación de contactos podemos ver que el campo creado anteriormente ha sido agregado. En el caso de RadioButton podremos seleccionar solo una opción de las dos (o más) disponibles.

12


CONTACTOS -‐ Libreta de Contactos

Figura 7


Muestra las listas de contactos existentes, pudiendo seleccionar una lista para mostrarla en el listado de la parte derecha (2)

Listado de los contactos de la lista seleccionada, ordenados alfabéticamente.

Barra de desplazamiento, nos permite filtrar a los contactos por la letra del abecedario que seleccionemos.

Permite modificar, borrar i agregar a listas del usuario seleccionado.

Opción para borra una lista completa, borrando sus contactos o no.


3

CONTACTOS – Importación y Exportación de Contactos

Figura 8


Formulario de importación de contactos.

Permite seleccionar la forma de importar los contactos, en formato CSV o Excel.

Permite asignar a los usuarios que queremos importar a las listas de contactos.

Figura9


Formulario para exportar contactos

Muestra la listas de contactos posibles a exportar.

Botón para realizar la exportación, nos genera una archivo CSV (*) con los datos de todos los contactos referentes a las listas seleccionadas.

*El formato CSV es aquel que divide los datos por medio de algún signo de puntuación ‘;’ ‘,’ .

14


ENVIOS – 1. Selección de la plantilla

Figura 10


Menú interactivo de progreso. Desde este menú nos podemos situar en las diferentes fases de creación i envío de un boletín.

Plantillas prediseñadas de boletines.

Plantillas personalizadas de boletines, creadas por los usuarios.

Acceso a los boletines pendientes de enviar.

Acceso a la lista las plantillas personalizadas por los usuarios.

Acceso a la selección de una plantilla para crear un nuevo boletín.


5

ENVIOS – 2. Diseño del boletín

Figura 11


Botón para aceptar los cambios en el boletín y ver la pre visualización del mismo.

Editor tipo ‘Word’ para la creación/modificación del boletín.

Botón que muestra la información sobre como introducir comodines para cambiar dinámicamente los datos del usuario que recibirá el correo. Como por ejemplo personalizar el correo

Barra de variables, con la cual podremos añadir los comodines citados anteriormente de manera rápida i limpia. Al hacer clic sobre ellos se nos añadirá en el lugar donde esté el cursor, el texto indicado.

16


ENVIOS – 3. Pre visualización

Figura 12


Permite editar el boletín.

Nos re direcciona al formulario de envíos.

Permite guardar la plantilla para ser enviada más adelante.

Vista previa del boletín que hemos editado.


7

ENVIOS – 4. Destinatarios

Figura 13


Formulario que nos permite escoger los destinatarios que recibirán nuestro boletín.

Muestra el numero de listas i usuarios escogidos para el envío.

Muestra todas las listas creadas.

Asunto del envío

Tipo del envío, online; la imagen no se incrusta en el correo(recomendado) mientras que la offline se carga toda la imagen en el correo.

Permite programar el envío de un boletín o bien enviarlo al instante.

Correo donde llegarán las notificaciones de los resultados de los envíos.

Persona que realiza el envío.

Email del cual se realizara el envío.

Texto alternativo al boletín.

Permite indicar la alineación del contenido del envío.

Envía el boletín junto con los datos introducidos.

18


ENVIOS – 5. Envía

Envío Instantáneo

Figura 14


Muestra el estado del envío.

Muestra la información de los envíos que se acaban de realizar. Indica que se ha enviado un correo porque no se ha programado como pospuesto.

Envío Pospuesto

Figura 15


Muestra el estado del envío.

Muestra la información de los envíos que se acaban de realizar. En este caso indica que no se ha realizado ningún envío porque estos han sido programados como pospuestos.


9

ENVIOS – Plantillas Personalizadas

Figura 16


Formulario para guardar el boletín.

Nombre de la plantilla que vamos a guardar.

Guarda la plantilla creada.

Permite regresar al paso 3.

Pre visualización de la plantilla que vamos a guardar.

Figura 17


Muestra todas las plantillas guardadas

Permite editar la plantilla indicada.

Pre visualiza la plantilla seleccionada.

Permite cambiar el nombre de la plantilla.

Permite borrar la plantilla seleccionada.

20


ENVIOS – Envíos Pendientes

Figura 18


Muestra los boletines que han sido programados para ser enviados.

Permite cancelar el envío programado.

Nos muestra mas información referente al envío.


1

ESTADÍSTICAS – Resumen

Figura 19


Acceso al resumen de las estadísticas.

Muestra la gráfica de los últimos envíos realizados.

Tabla del resumen de las estadísticas.

Muestra las estadísticas completas del envío.

Indica las listas que se les ha enviado el boletín.

22


ESTADÍSTICAS – Resumen de una Campaña

Figura 20


Muestra el resumen de la campaña junto con las listas a la cuales se les envío el boletín.

Muestra la visualización del boletín.

Re direcciona a los detalles del envío.

Permite crear gráficos personalizados del los envíos, segmentándolos por los criterios indicados.(VER FIGURA 21)

Muestra 3 gráficos con información visual de los boletines abiertos, enviados y los enlaces. Además de un menú para seleccionar solo una de las tres gráficas.

Muestra la gráfica de los boletines abiertos.

Muestra la gráfica de los boletines enviados.

Muestra la gráfica de los enlaces introducidos en el boletín.

Crea un archivo PDF con los gráficos.


3

ESTADÍSTICAS – Segmentación de un envío

Figura 21


Campo del cual se va a realizar el gráfico.

Muestra la condición que se ha insertado.

Permite escoger el campo al cual se va hacer referencia para crear la condición.

Permite escoger el valor de la condición que queremos.

Agregar otra condición a la gráfica.

Exporta los resultados del gráfico a un archivo Excel.

Muestra el grafico en relación a las condiciones establecidas.

24


ESTADÍSTICAS – Detalles últimos envíos

Figura 22


Grafica de los últimos envíos.

Al ponernos encima nos indica el total de envíos.

Crea un archivo PDF con el gráficos de los últimos envíos.

Muestra el numero de envíos abiertos, sin abrir i rechazados

Muestra el nombre de los boletines junto con la fecha. Da acceso a las estadísticas concretas de cada envío. (VER FIGURA 23)


5

ESTADÍSTICAS – Detalles envío

Figura 23


Muestra detalles generales de los envíos.

Permite obtener detalles más precisos de los envíos.

26


REST API – API para interactuar con SINERMAIL

Podemos interactuar con la API de Sinermail fácilmente con 4 métodos:

Crear Contacto Borrar Contacto Mostrar las Listas

Mostrar los Créditos Disponibles

La url patrón con la que haremos estas consultas i modificaciones es básicamente es la siguiente:

Teniendo en cuenta las siguiente limitaciones:

• Se usa HTTP 1.1 Basic Auth para la autentificación. • Todos los métodos requieren una petición HTTP GET. • Todas las contraseñas deben ser encriptadas con el algoritmo MD5 antes de ser enviadas al

servidor. • Por favor espera al menos un segundo entre peticiones.

Ejecutar cualquier método de la API devuelve una respuesta en formato XML. Por ejemplo:

También podemos obtener la siguiente respuesta en caso de que el nombre de usuario i la contraseña sean erróneos.

<?xml version="1.0" encoding="UTF-8"?> <resultado codigo="error"> <error>Faltan parámetros</error> </resultado>

http://usuario:md5(clave)@sinermail.com/rest/metodo/?parametro1=valor1&parametro2=valor2

<?xml version="1.0" encoding="UTF-8"?> <resultado codigo="error"> <error>Combinación de usuario/contraseña incorrecta</error> </resultado>


7

API MÉTODOS -‐ 1.Crear Contacto

Podemos añadir un contacto a nuestro sistema de envíos desde cualquier interfaz web simplemente añadiendo un link a la url anteriormente citada con unas simples modificaciones.

Los parámetros:

• email: El e-‐mail del contacto a crear. El e-‐mail es el único parámetro REQUERIDO. • lista: Un array(tabla) de listas a las que añadir el contacto. Es un parámetro OPCIONAL. • campo: Un array(tabla) de campos a guardar del usuario. Es un parámetro OPCIONAL.

Con estos parámetros deberemos construir una url como esta:

*RECORDATORIO: La contraseña que usemos ha de estar previamente en MD5 Al intentar crear un usuario podemos recibir dos tipos de respuestas: Contacto creado satisfactoriamente

Observando la respuesta vemos que el parámetro “codigo” nos informa del resultado del método y “errores ” de la cantidad de errores que se han producido. Además de obtener el ID del usuario creado para utilizarlo en posteriores acciones como eliminar un contacto. Error creando contacto Si obtenemos un error se puede deber a una mala construcción de la url o que los datos de la misma no son correctos.

En el caso de esta respuesta vemos que se han pasado dos campos inexistentes y se han generado dos errores que nos lo indican.

http://USER:[email protected]/rest/crea_contacto/[email protected]&lista[]=sip&campo[nombre]=contacto

<?xml version="1.0" encoding="UTF-8"?> <resultado codigo="ok" errores="0">

<id>1498</id> </resultado>

<?xml version="1.0" encoding="UTF-8"?> <resultado codigo="ok" errores="2">

<id>1498</id> <error>No se encuentra el campo "valor1"</error> <error>No se encuentra el campo "valor2"</error>

</resultado>

28


API MÉTODOS -‐ 2.Borrar Contacto Este método utiliza la ID de Contacto que devuelve el método “crea_contacto”, para eliminar un contacto. El parámetro:

• id: El id del contacto a eliminar. El id es el único parámetro, y por tanto es REQUERIDO. La url quedaría así:

*RECORDATORIO: La contraseña que usemos ha de estar previamente en MD5 Cuando ejecutemos el “borrar_contacto” podremos obtener dos respuestas: Contacto borrado satisfactoriamente

Esta respuesta nos informa de que el borrado del contacto ha sido satisfactoria. Error borrando contacto Si obtenemos un error se puede deber a una mala construcción de la url o que la id introducida es inexistente o errónea.

En el caso de esta respuesta vemos que simplemente nos informa de que se ha producido un error al intentar borrar el contacto.

http://USER:[email protected]/rest/borra_contacto/?id=1498

<?xml version="1.0" encoding="UTF-8"?> <resultado codigo="error”>

<error>Error al borrar el contacto</error> </resultado>

<?xml version="1.0" encoding="UTF-8"?> <resultado codigo="ok”/>


9

API MÉTODOS -‐ 3.Créditos Disponibles Si lo deseamos también podemos consultar los créditos disponibles para realizar envíos de un usuario en concreto. Este método no necesita de ningún parámetro ya que efectúa la consulta sobre el usuario que accede al lugar. La url sería la siguiente:

*RECORDATORIO: La contraseña que usemos ha de estar previamente en MD5 Cuando efectuemos la consulta de créditos obtendremos la siguiente respuesta: Créditos consultados satisfactoriamente

API MÉTODOS -‐ 4.Listas Disponibles Por último podemos obtener el listado de listas de contactos que tenemos disponibles. Este método no necesita de ningún parámetro ya que efectúa la consulta sobre el usuario que accede al lugar. La url sería la siguiente:

*RECORDATORIO: La contraseña que usemos ha de estar previamente en MD5 Cuando efectuemos la consulta de las listas obtendremos la siguiente respuesta: Listas de contactos consultadas satisfactoriamente

http://USER:[email protected]/rest/creditos_restantes/

<?xml version="1.0" encoding="UTF-8"?> <resultado codigo="ok"> <creditos>47</creditos> </resultado>

http://USER:[email protected]/rest/ver_listas/

<?xml version="1.0" encoding="UTF-8"?> <resultado codigo="ok">

<lista id="51">Barcelona</lista> <lista id="50">Madrid</lista> <lista id="64">Girona</lista>

</resultado>

30


FAQ’s – Preguntas Frecuentes

¿Como creo un contacto?

1-‐ Vamos a la pestaña contactos (Figura 1). 2-‐ Rellenamos los campos del contacto nuevo y lo añadimos a una o mas listas

(Figura2). ¿Como creo un boletín?

1-‐ Seleccionamos una plantilla prediseñada o bien una plantilla en blanco(Figura 10). 2-‐ Escribimos el contenido del boletín(Figura 11). 3-‐ Escogemos los destinatarios o bien guardamos la plantilla para ser enviada mas

adelante(Figura 12). 4-‐ Seleccionamos la lista o las listas a la que le queremos enviar el boletín y

enviamos(Figura 13). ¿Como creo una estadística personalizada?

1-‐ Seleccionamos los campos que queremos visualizar junto con las condiciones(Figura 21).

2-‐ Podemos crear un PDF con las estadísticas visualizadas(Figura 21). ¿Como veo las estadísticas de un envío?

1-‐ Abrir la pestaña estadísticas(Figura 1). 2-‐ Seleccionamos un envío i hacemos clic done dice "resumen envíos"(Figura 19). 3-‐ A continuación se nos muestra las estadística de la campaña(Figura 20).

¿Como realizo un envío pospuesto?

1-‐ Seleccionamos una plantilla prediseñada o bien una plantilla en blanco(Figura 10). 2-‐ Escribimos el contenido del boletín(Figura 11). 3-‐ Escogemos los destinatarios, seleccionamos donde dice "Pospuesto" y finalmente

escribimos la fecha en la que se realizar el envío(Figura 12). 4-‐ Seleccionamos la lista o las listas a la que le queremos enviar el boletín y

enviamos(Figura 13).

Documents

Manual del usuario - Sinermail