Zenkiu API Introducción Ordenes para Envio

Zenkiu API Introducción Ordenes para Envio

12/01/13
Zenkiu API - Wiki.imolko.com
Zenkiu API
From Wiki.imolko.com
Introducción
Zenkiu-ws es el componente de nuestra plataforma que se encarga de manejar los envios. Zenkiu-ws provee su
funcionalidad a través de una interface que utiliza el Protocolo REST. En esta página puedes encontrar la
documentación del protocolo utilizado.
Para hacer pruebas "en vivo" con el protocolo sólo sigue estas instrucciones.
Contents
1 Introducción
2 Ordenes para Envio
2.1 Operaciones
2.2 Campos
2.3 Ejemplos
3 Envios
3.1 Operaciones
3.2 Campos
3.3 Ejemplos
Ordenes para Envio
URL
Base
/usuarios/{username}/ordenes
Atajo
--
Operaciones
Recurso
/ordenes
GET
POST
Obtiene la lista de
Solicita hacer una
ordenes de envio
-nueva orden
del usuario
wiki.imolko.com/index.php/Zenkiu_API
PUT
DELETE
--
1/4
12/01/13
Zenkiu API - Wiki.imolko.com
/ordenes/{ordenid} Obtiene la orden -de envío cuyo id=
{ordenid}
--
Cancela la orden
cuyo id={ordenid}
Campos
orden: {
_id: 999999,
propietario: 'bromine_user',
created : '1-jan-2012',
modified: '5-jan-2012',
trigger :
{
startTime: "2012-01-01",
endTime: "2012-12-31" ,
cronExpression: '0 30 10-13 ? * WED,FRI',
timeZone: "-0430"
},
triggerState: "normal",
nextTriggerFire: '15-jul-2012 3.30pm',
destinatarios: {etiqueta: "cines" , filtro: "" ,avatares: ["",""] , query:""}
etiquetas: ["campaña Toy Story"],
tipoOrden: "email"
contenido: "http://bromine_user.imolko.com/boletin22",
ordenesEjecutadas: [
{runDate:'2012-01-01', triggerInstructionCode: '0'},
{runDate:'2012-03-01', triggerInstructionCode: '0'},
{runDate:'2012-05-01', triggerInstructionCode: '0'}
],
sizeOrdenesEjecutadas: 3,
ordenesMissfire: [
{runDate:'2012-02-01', triggerInstructionCode: '9'},
{runDate:'2012-04-01', triggerInstructionCode: '9'},
{runDate:'2012-06-01', triggerInstructionCode: '9'}
],
sizeOrdenesMissfire: 2,
}
trigger: objeto que contiene la información de calendario de ejecución. Para envíos inmediatos no se
envía trigger.
triggerState: es una enumeración y es únicamente de lectura. Este campo se actualiza
nextTriggerFire: es la próxima ejecución.
tipoOrden: puede ser email o sms.
destinatarios: es un objeto que debe tener al menos una propiedad. Si se proporcionan más de una, las
condiciones se concatenan con un AND.
etiqueta: indica que los avatares deben tener una determinada etiqueta.
filtro: indica el id del filtro que se debe utilizar
avatares: lista de id de avatares a los que se debe realizar el envío.
query: este parámetro es para permite querys específicos
ordenesEjecutadas: almacena la fecha de los envios que se han ejecutado con su status.
sizeOrdenesEjecutadas: contador de las ordenes ejecutadas.
ordenesMissfire: almacena la fecha de los envios que no se pudieron ejecutar en tiempo.
sizeOrdenesEjecutadas: contador de las ordenes missfire.
Ejemplos
wiki.imolko.com/index.php/Zenkiu_API
2/4
12/01/13
Zenkiu API - Wiki.imolko.com
Envios
URL
Base
/usuarios/{username}/ordenes/envios
Atajo
/ordenes/{ordenid}/envios
Operaciones
Recurso
GET
POST
PUT
DELETE
/ordenes/{ordenid}/envios
Obtiene la
lista de
envios del
usuario
que
-pertenecen
a la
orden=
{ordenid}.
--
--
/ordenes/{ordenid}/envios/{envioid}
Obtiene el
envío cuyo
-id=
{envioid}
--
--
/ordenes/{ordenid}/envios/{envioid}/request --
--
Solicitud para Solicitud para
PAUSAR un CANCELAR
envio. Solo lo un envio.
pueden hacer
administradores
del sistema.
Status:
Queued:
Running
Paused
Ended
Steps:
Indica en cuál paso se encuentra el envio. Los valores posibles son:
Created
Despues de Quartz, cuándo se crea el jobid.
Start
Cuándo comenzó un worker a trabajarlo.
wiki.imolko.com/index.php/Zenkiu_API
3/4
12/01/13
Zenkiu API - Wiki.imolko.com
DataReady
Cuándo se crea el snapshoot de los destinatarios
Prepared
Collected
Paused
Error
dió un error en el proceso de preparación. Puede ser template o preparación de data.
Cancelled
Cancelado por el usuario
Resumed:
El proceso que había sido pausado se reinició
End:
cuándo el envío se terminó correctamente
Se puede solicitar:
Pause: se permite sólo en status Queue y Running
Cancel: se permite sólo en Status Queue, Running y Paused
Resume: se permite sólo en status Paused
Campos
Ejemplos
TBD
Retrieved from "http://wiki.imolko.com/index.php/Zenkiu_API"
This page was last modified on 19 August 2012, at 16:56.
wiki.imolko.com/index.php/Zenkiu_API
4/4