Resumen, modificación y estadísticas Rest Massiv Guía de consumo Web Service

Documentos relacionados
MICROSITIOS. Perfiles

Sistema de Presentación y Gestión de Proyectos Instructivo para la carga de Proyectos.

Exponiendo los servicios de nuestro Redmine Corporativo a través del WSO2 ESB

MANUAL TECNICO API SMS-HTTP

TELKIA. Especificación, SMSBROKER HTTP Protocol TELKIA. Versión: 2.5 Fecha: Page 1

API.NET. Introducción. Aspectos generales. Configuración. Recomendaciones. Permite enviar SMS mediante una librería.net.

API didimo Marketing - Aplicateca

Manual de Instrucciones Definición de Componentes y Registro de Notas Parciales

Extensión K2B proyectos para Smart Devices

Documentación Técnica

TELECO CHILE S.A. WSDL SOAP de Acceso a Plataforma SMS

1. Accediendo a la plataforma HTTP de Marketext Código de ejemplo Seguridad y autenticación Enviando un SMS Simple 5

Guía de uso para envío de SMS

ESPECIFICACIONES DE SERVICIOS ABIERTOS

MANUAL DE USUARIO DE LA EXTRANET DEL MINISTERIO DE COMERCIO EXTERIOR Y TURISMO

Informar a los usuarios de la aplicación FDAA de cómo usarla

Web Service: Consulta de Sistema de Turnos Manual de referencia

Definición y Conversión de datos. Agustín J. González ELO-329

Integración con ecommerce Bancard

SERVICIO DE ENVÍO MASIVO DE MENSAJES MMS MULTIMEDIA HTTPS/API

MANUAL DE USO DEL PORTAL DE FACTURACIÓN MEDIACCESS

PRUEBA TIENDA MAGENTO

ORIENTACIONES PARA EL REPORTE DEL BALANCE DE GESTIÓN INDIVIDUAL

Administración WEB SERVICES MasterBase

ojovoz Una plataforma de código abierto para la creación de memorias comunitarias. Manual del usuario

Taller de Herramientas de marketing. Juan Pablo Navarrete P.

Guia de Implantación Mexicana (GIM) UN/EDIFACT/EANCOM CONTRL. Reporte de Aviso y Sintaxis. Nombre del mensaje: Fecha última actualización:

Especificación WebService para:

PLAN DE PRUEBAS 17 DISEÑO WEB

UNIT4 ekon.laboro IRPF

PROGRAMA DE INVESTIGACIÓN ASOCIATIVA

MARKETING IPLAN

FORMULARIO HTML PREPARACION DEL FORMULARIO. Que información debes solicitar al visitante de tu web?

Tips & Buenas Prácticas. del Marketing HTML TEMPLATES. Ventajas y desventajas en los diseños en fotmato HTML

INSTRUCTIVO ANEXO DE GASTOS PERSONALES EN LÍNEA. ENERO 2016 Anexo de Gastos Personales en Línea / Instructivo (Versión1.0.0)

Aplicateca API Certificados SMS -

IRIS MAIL. Manual de usuario

1. Usted deberá ingresar al portal para generar su registro y obtener su factura.

ATLAS MANUAL DE USUARIO COMPONENTE CODIGO DE BARRAS

Creando Plantilla de Procesos para la Generación de Team Project

Acerca de emblue. Dentro de las características de emblue se encuentran:

SICRES 3.0 Presentación Ejecutiva

Gestión de acciones vía HTTP Action XML API

IMPRESIÓN Y CONECTIVIDAD

Redes P2P y Java: JXTA

RESTful 4 all. Diego Sapriza

07/033/14 Manual Gestión de Contenidos. Manual Gestión de Contenidos

SETIEMBRE DE 2014 INSTRUCTIVO PARA ACCEDER A LOS RECIBOS DE SUELDO

TIPS PARA DISEÑADORES

IM-ComBro. Información de Seguros para Corredurías y Agencias de Compañías de Seguros. Infoseg, S.A.

Especificación de API SMS ITD Chile

Guía para usar APIs de SMS Masivos

Manual de Usuario Sistema de Postulación en línea

Actividad Retroalimentación

Marketing Services.

Manual del Servicio Web. Afilnet.com. Afilnet. Servicios de Telecomunicaciones SMS

FORMATO INFORMACIÓN ELECTRÓNICA DE COMPRAS Y VENTAS PARA ENTREGA DETALLADA SEGÚN RESOLUCIÓN 42 DEL

MARKETING IPLAN MARKETING AVANZADO ESTADISTICAS Y REPORTES

SAP BusinessObjects Versión del documento: Manual de instalación de la puerta de enlace de Reporting Services de Dashboards

Introducción... 3 PLATAFORMA TÉCNICA Petición de envío de SMS... 3 Ver estado de envíos de SMS... 5 Ver créditos disponibles...

Integrando AngularJS y Drupal. Iván G. Campaña

Ficha Técnica SMS Combinado con Telegram Versión: 1.0

Especificació n de API SMS ITD Chile

BANCO CENTRAL DE RESERVA DEL PERÚ

Plataforma de Índices Informatizados

Especificaciones de la Interfaz para envío de SMS

Esquema de Integración Externa Aranda Versión 8.0

CORSAIR GAMING RATÓN GUÍA DE INICIO RÁPIDO DEL SOFTWARE

UdeSA CMS Tutorial Administración de microsite Revista Jurídica

GUIA USUARIO. Mailjet y webcrm

WorkManager E.D. Manual guía de usuario Diseñador de formularios

API VERSIÓN 4.0 DOCUMENTACIÓN PARA INTEGRACION DE SITIOS WEB

Gestitrans Extensión

Manual del Servicio Web. Afilnet.com. Afilnet. Servicios de Telecomunicaciones SMS

Indice. Indice: Acerca de emblue. Cómo comienzo a usar emblue? El entorno emblue. Creación de una campaña de marketing. Listas de contactos

PROCESO DE SINCRONIZACIÓN

Contenido. Introducción. prerrequisitos. Requisitos. Componentes Utilizados

Serialización de datos en C# en Binario, Soap y Xml

FCS03-3 Manual de Usuario ED. 2 MANUAL DE USUARIO

GUIA DE INTEGRACIÓN DE INFOFAX

Plataformas de Gestión y Administración de Sitios Web (PGS PAS)

RESUMEN BOLETÍN NOTICIAS RED 2006/10, DE 22 DE DICIEMBRE DE 2006.

Botón de Pago Instapago versión 1.1 TECNOLOGÍA INSTAPAGO C.A.

1. INTRODUCCIÓN 2 2. EVERDRIVE LITE 3 3. SINCRONIZADOR DE EVERDRIVE 4 4. VISTA GENERAL DE LAS OPCIONES DE LA APLICACIÓN 5

Manual de usuario de la Renovación Electrónica de Diseños Industriales

La plantilla propone aprovechar esta estructura en común y sólo modificar el contenido del área del documento que sea diferente.

ARANDA SERVICE DESK WEB VERSIÓN DE ACTUALIZACIÓN QUE SE LIBERA: LISTADO DE ARCHIVOS Tamaño (En Bytes)

Control Center Agencias de Viajes

Si usted quiere desarrollar con Bluevia y Java, esto es lo primero que debe saber

Panorama. Resumen: Principio básico. No es un mundo (NACO) perfecto

VE-Ventanilla Electrónica Especificación Caso de Uso VE-CU-WS-Consumir-Comunicaciones

Portal Inteligente Medellín Documentación de la Arquitectura de Software

Campañas de marketing. capítulo 04

Descripción de servicio

Juegos de Azar y Apuestas

Manual de usuario RVE 2.0. Módulo Inhabilitaciones

Guía para la configuración del servicio de SMTP con Autenticación

Módulo I: Repaso Crystal Reports

Preguntas frecuentes en la plataforma RECyT

Transcripción:

Resumen, modificación y estadísticas Rest MassiveMail: Guía de consumo Web Service

Índice Índice... 2 Guía de consumo... 3 Método GET:... 3 Método PUT:... 3 Código de resultado: Response... 3 Payload:... 3 Los endpoints son:... 4 Actualización de envío sin plantilla... 5 Datos de Entrada... 5 Ejemplo de estructura XML:... 6 Ejemplo de estructura JSON:... 7 RESULTADO:... 8 Actualización de envío con plantilla... 9 Datos de Entrada... 9 Ejemplo de estructura XML:... 10 Ejemplo de estructura JSON:... 11 RESULTADO:... 12 Información de un envío... 13 Para la obtención de información relacionada a envíos masivos, se debe utilizar el método GET.... 13 Información de un envío... 13 El endpoint es:... 13 RESULTADO:... 13 Información de múltiples envíos... 15 El endpoint es el siguiente:... 15 RESULTADO:... 15 Estadísticas de un envío... 18 El endpoint es el siguiente:... 18 RESULTADO:... 18

Guía de consumo Este documento está orientado para la realización de modificaciones a mensajes masivos generados, la obtención del resumen de uno o más envíos y a la obtención de estadísticas asociadas a un envío en particular. Definimos como Endpoint: Dirección completa que incluye una URL base más los parámetros necesarios (obligatorios u opcionales) para su ejecución. URL Base: Dirección raíz para el consumo de los Web Services. Este Web Service posee los siguientes métodos: Método GET: Utilizado para la realización de ping de autenticación, para obtener información asociada a uno o más envíos masivos y para la obtención de estadísticas asociadas a un envío. https://rest.masterbase.com/massivemail/v1/ Método PUT: Utilizado para la actualización de un mensaje no enviado. Cada ejecución de un Web Service, entrega: Código de resultado: Response El RESPONSE es un código que representa el resultado de la ejecución: o 200: resultado satisfactorio o 400 : problema en la ejecución o 500 : problema en el servicio (interno) o Etc. Payload: Consiste en la información que se adjunta al llamado Web Services, como información necesaria para la acción que estamos realizando.

Web Service MassiveMail REST: Para la modificación de envíos masivos, se debe utilizar el método PUT. Actualización de envíos previamente creados. Los endpoints son: https://rest.masterbase.com/massivemail/v1/{cliente Donde: Cliente Nombre de la cuenta del cliente Parámetro obligatorio Utilizar credenciales válidas para el consumo de este Web Service, las cuales corresponden a las Credenciales API que se generan en la plataforma. Para este método es necesario incluir una estructura XML/JSON en el PAYLOAD de acuerdo a lo descrito más abajo.

Actualización de envío sin plantilla Datos de Entrada SubCategoryId: Identificador de subcategoría, atributo tipo numérico, opcional. Type: Sólo valores "Standard" o Dynamic para el tipo de remitente, atributo opcional. Id: Identificador numérico de remitente, atributo opcional. ListId: Identificador de la lista de contactos a la que se destinará el envío, atributo opcional. FilterType: Sólo acepta valores Static, Dynamic o Newsletter, atributo opcional. Ids: Listado de identificadores asociados al filtro seleccionado. Sólo permite múltiples identificadores el tipo de filtro Newsletter (boletín), campo opcional. Format: Sólo acepta valores html o text, atributo opcional. Now: Sólo acepta valores true o false. Asume valor true por defecto. OpenTracking: Sólo acepta valores true o false, atributo opcional. ClickTracking: Sólo acepta valores true o false, atributo opcional. Enable: Sólo acepta valores true o false, atributo opcional. Importante: Un mensaje generado sin plantilla, no puede modificarse con intención de convertirlo en uno con plantilla, solo los atributos expuestos previamente pueden ser modificados en un mensaje sin plantilla. Solo las credenciales de tipo productivas pueden habilitar un envío.

Ejemplo de estructura XML: <MassiveMail> <GeneralData Classification="T"> <MailId>11111</MailId> <SubCategoryId>2</SubCategoryId> </GeneralData> <From Id="1" Type="Standard"/> <To FilterType="Newsletter" ListId="1"> <Ids> <Id>1</Id> </Ids> </To> <Message> </Message> <Options> <SendDate Now="false">2016-10-25T21:11:48.533</SendDate> <OpenTracking>true</OpenTracking> <ClickTracking>true</ClickTracking> <Enable>true</Enable> </Options> </MassiveMail>

Ejemplo de estructura JSON: { "GeneralData" : { "MailId" : "111111", SubCategoryId" : "64" "From" : { "Type" : "Dynamic", "Id" : "74" "To" : { "Ids" : ["437"], "ListId" : "1", "FilterType" : "Dynamic" "Message" : { " Options ": { " SendDate ": { " Now ": " false ", " Value ": "2016-11 05T14:11:48" " OpenTracking ": "true", " ClickTracking ": "true", " Enable ": "true"

RESULTADO: El resultado (en caso de éxito), reflejará la siguiente estructura: { "Service" : "MassiveMail", "Version" : "1.0.2.0", "TransactionId" : "d9b963de5ae2407c9e337ef5726e1ad0", "Status" : { "Code" : "200", "Value" : "OK" "MailId" : { "AccountStatus" : "T", "Value" : "76699"

Actualización de envío con plantilla Datos de Entrada SubCategoryId: Identificador de subcategoría, atributo tipo numérico, opcional. Based on Type: Solo acepta valor template, atributo opcional para modificar envíos con plantilla Based on Id: Identificador de la plantilla, atributo opcional para la modificación de envíos con plantilla. From Type: Solo acepta valores "Standard" o Dynamic, atributo opcional. From Id: Identificador numérico de remitente, atributo opcional. ListId: Identificador de la lista de contactos sobre la cual se realizará el envío, atributo opcional. FilterType: Solo acepta valores Static, Dynamic o Newsletter, atributo opcional. Ids: listado de identificadores asociados al filtro seleccionado, solo permite múltiples identificadores el tipo de filtro Newsletter (boletín), atributo opcional. Format: Solo acepta valores html o text, atributo opcional. Now: Solo acepta valores true o false, asume valor true por defecto. OpenTracking: Solo acepta valores true o false, atributo opcional. ClickTracking: Solo acepta valores true o false, atributo opcional. Enable: Solo acepta valores true o false, atributo opcional. Importante: Un mensaje generado con plantilla, no puede modificarse con intención de convertirlo en uno sin plantilla, solo los atributos expuestos previamente pueden ser modificados en un mensaje sin plantilla. Solo las credenciales de tipo productivas pueden habilitar un envío.

Ejemplo de estructura XML: <MassiveMail> <GeneralData Classification="T"> <MailId>11111</MailId> <SubCategoryId>2</SubCategoryId> <BasedOn Id="1" Type="Template"/> </GeneralData> <From Id="1" Type="Standard"/> <To FilterType="Newsletter" ListId="1"> <Ids> <Id>1</Id> </Ids> </To> <Message> </Message> <Options> <SendDate Now="false">2016-10-25T21:11:48.533</SendDate> <OpenTracking>true</OpenTracking> <ClickTracking>true</ClickTracking> <Enable>true</Enable> </Options> </MassiveMail>

Ejemplo de estructura JSON: { "GeneralData" : { "MailId" : "111111", "SubCategoryId" : "64", "BasedOn" : { "Type" : "Template", "Id" : "2" "Classification" : "C" "From" : { "Type" : "Dynamic", "Id" : "74" "To" : { "Ids" : ["437"], "ListId" : "1", "FilterType" : "Dynamic" "Message" : { " Options ": { " SendDate ": { " Now ": " false ", " Value ": " 2016-11 - 05 14 : 11 : 48 " " OpenTracking ": " true ", " ClickTracking ": " true ", " Enable ": " true "

RESULTADO: El resultado (en caso de éxito), reflejará la siguiente estructura: { "Service" : "MassiveMail", "Version" : "1.0.2.0", "TransactionId" : "d9b963de5ae2407c9e337ef5726e1ad0", "Status" : { "Code" : "200", "Value" : "OK" "MailId" : { "AccountStatus" : "T", "Value" : "76699"

Información de un envío Para la obtención de información relacionada a envíos masivos, se debe utilizar el método GET. Información de un envío El endpoint es: https://rest.masterbase.com/massivemail/v1/{cliente/getmail?mailid={idmail Donde: Cliente Nombre de la cuenta del cliente Parámetro Obligatorio. IdMail Es el identificador numérico asociado al envío Parámetro Obligatorio. Utilizar credenciales válidas para el consumo de este Web Service, las cuales corresponden a las Credenciales API que se generan en la plataforma. Para este método NO necesario incluir una estructura XML/JSON en el PAYLOAD. RESULTADO: El resultado (en caso de éxito), reflejará la siguiente estructura: { "Service" : "MassiveMail", "Status" : { "Code" : "200", "Value" : "OK" "TransactionId": "INSTANCIA_20170111_e6381b8be7cd4d868317af6960996d7d", "Version" : "1.0.2.0", "Response" : { "AccountType" : "T", "MassiveMail" : { "Creator" : "AccTSTPRO", "EnabledBy" : "AccTSTPRO",

"EnabledDate" : "2017-01-09T14:01:06.277", "Id" : "90682", "Name" : "Mail para Modificar", "SentDate" : "2017-01-09T14:01:06.277", "Status" : "E", "Subject" : "Asunto del mensaje", "Total" : "1" Donde: AccountType Tipo de credencial que originó el mensaje T: Testing P: Productiva Creator Credencial que creo el mensaje EnabledBy Credencial que habilitó el mensaje EnabledDate Fecha de habilitación del mensaje Id Identificador numérico del mensaje Name Nombre asignado al mensaje SentDate Fecha de envío Status Estado del mensaje E: Enviado D: Deshabilitado H: Habilitado Subject Asunto del mensaje Total Cantidad de destinatarios

Información de múltiples envíos El endpoint es el siguiente: https://rest.masterbase.com/massivemail/v1/{cliente/getmails?pagenumber={n&pagesize={n &startdate={d&enddate={d Donde: Cliente Nombre de la cuenta del Parámetro Obligatorio. cliente PageNumber Numero de página Parámetro Opcional PageSize Cantidad de registros por Parámetro Opcional pagina StartDate Fecha de inicio de corte Parámetro Opcional EndDate Fecha de fin de corte Parámetro Opcional Utilizar credenciales válidas para el consumo de este Web Service, las cuales corresponden a las Credenciales API que se generan en la plataforma. Para este método NO necesario incluir una estructura XML/JSON en el PAYLOAD. RESULTADO: El resultado (en caso de éxito), reflejará la siguiente estructura: { "Service" : "MassiveMail", "Status" : { "Code" : "200", "Value" : "OK" "TransactionId" : "INSTANCIA_20170111_517c8ea733a644d083470d4a2fa68cf8", "Version" : "1.0.2.0", "Response" : { "AccountType" : "T", "CurrentPage" : "1",

"TotalPages" : "960", "TotalRecords" : "2879", "MassiveMails" : [{ "Creator" : "AccTSTPRO", "EnabledBy" : "AccTSTPRO", "EnabledDate" : "2017-01-09T11:02:39.707", "Id" : "90684", "Name" : "Mail para Modificar", "SentDate" : "2017-01-09T11:02:39.707", "Status" : "E", "Subject" : "Asunto del mensaje", "Total" : "1" { "Creator" : "AccTSTPRO", "EnabledBy" : "AccTSTPRO", "EnabledDate" : "2017-01-09T11:01:06.277", "Id" : "90682", "Name" : "Mail para Modificar", "SentDate" : "2017-01-09T11:01:06.277", "Status" : "E", "Subject" : "Asunto del mensaje", "Total" : "1" { "Creator" : "AccTSTPRO", "EnabledBy" : "AccTSTPRO", "EnabledDate" : "2017-01-09T10:56:59.650", "Id" : "90677", "Name" : "Mail para Modificar", "SentDate" : "2017-01-09T10:56:59.650", "Status" : "E", "Subject" : "Asunto del mensaje", "Total" : "14" ]

Donde: AccountType Tipo de credencial que originó el mensaje T: Testing P: Productiva Creator Credencial que creo el mensaje EnabledBy Credencial que habilitó el mensaje EnabledDate Fecha de habilitación del mensaje Id Identificador numérico del mensaje Name Nombre asignado al mensaje SentDate Fecha de envío Status Estado del mensaje E: Enviado D: Deshabilitado H: Habilitado Subject Asunto del mensaje Total Cantidad de destinatarios

Estadísticas de un envío Para la obtención de estadísticas relacionadas a envíos masivos, se debe utilizar el método GET. El endpoint es el siguiente: https://rest.masterbase.com/massivemail/v1/{cliente/getstatistics?mailid={idmail Cliente IdMail Nombre de la cuenta del cliente Es el identificador numérico asociado al envío Parámetro Obligatorio. Parámetro Obligatorio. Utilizar credenciales válidas para el consumo de este Web Service, las cuales corresponden a las Credenciales API que se generan en la plataforma. Para este método NO necesario incluir una estructura XML/JSON en el PAYLOAD. RESULTADO: El resultado (en caso de éxito), reflejará la siguiente estructura: { "Service" : "MassiveMail", "Status" : { "Code" : "200", "Value" : "OK" "TransactionId" : "INSTANCIA_20170111_eff117fa78d447b08035b0b9bf05ad76", "Version" : "1.0.2.0", "Response" : { "Mail" : { "Id" : "90633", "Statistic" : { "Accepted" : "0", "Accepted_Rate" : "0", "Bounce" : "0",

"BounceUnique" : "0", "CTO" : "0", "CTR" : "0", "Click" : "0", "ClickUnique" : "0", "NotOpen" : "0", "Open" : "0", "OpenClicDeduced" : "0", "OpenPixelTracking" : "0", "OpenUnique" : "0", "OpenWebview" : "0", "Sent" : "0", "TAC" : "0" Donde: Id Accepted Accepted_Rate Bounce BounceUnique Click ClickUnique NotOpen Open OpenUnique OpenWebview Sent TAC Identificador numérico del mensaje Cantidad de mensajes aceptados Porcentaje de aceptación de mensajes Cantidad total de rebotes Cantidad de rebotes únicos Cantidad total de link abiertos Cantidad de link únicos abiertos Cantidad de mensajes no abiertos Cantidad total de mensajes abiertos Cantidad de aperturas únicas Cantidad de mensajes visualizados vía web Cantidad de envíos realizados Tasa de aperturas únicas