Diferencia entre revisiones de «Docu push exchange»
(→Campos Obligatorios y No Obligatorios para las notificaciones) |
(→Campos Obligatorios y No Obligatorios para las notificaciones) |
||
| Línea 15: | Línea 15: | ||
#*En caso de '''tratarse de un array''', se mandará la notificación a todos los tokens de dicho array. | #*En caso de '''tratarse de un array''', se mandará la notificación a todos los tokens de dicho array. | ||
#*En caso de '''no ser un array''', podrá contener lo siguiente: | #*En caso de '''no ser un array''', podrá contener lo siguiente: | ||
| + | ##* | ||
#'''message:''' | #'''message:''' | ||
#'''type:''' | #'''type:''' | ||
Revisión del 09:28 6 mar 2018
Contenido
Introducción
En este documento se va a mostrar como ha de ser el contenido que se mande al api-xchange de Mobeleader para realizar las distintas acciones que ésta nos permite. Se expondrá brevemente como ha de realizarse la conexión a dicha API, como han de ser los campos obligatorios que han de ir para todos los casos y a continuación se procederá a tratar todos los casos con ejemplos para un mayor entendimiento.
Conectándonos a la API
Lo primero que deberemos hacer es solicitar el token necesario para la conexion a Mobeleader. Dicho token es un identificador único para cada usuario desarrollador. Una vez obtenido dicho token procederemos a hacer una breve prueba de conexión para comprobar que tenemos acceso a la API. En dicha prueba haremos uso de la tarea “ping”.
En la imagen vemos como ha de ser el código necesario para realizar dicha prueba y el resultado transformado a un array. Si la posición del responsecode es “OK” significa que todo ha ido correctamente y en la posición data deberemos ver “pong”. Mientras esta prueba no de este resultado no podremos hacer ninguna acción más sobre la API.
Campos Obligatorios y No Obligatorios para las notificaciones
Para generar notificaciones desde nuestro sistema, en la conexión con la API deberá ir especificada la tarea “setPush”, junto un array de datos con una serie de campos.
Independientemente del SO al que la notificación irá, hay unos campos que son obligatorios; son los siguientes:
- appHash: contendrá el hash autogenerado por el panel Mobeleader de la aplicación registrada.
- terminalTokens: este campo podrá tener más de un formato, de manera que los dispositivos que reciban la notificación puedan ser diferentes.
- En caso de tratarse de un array, se mandará la notificación a todos los tokens de dicho array.
- En caso de no ser un array, podrá contener lo siguiente:
- message:
- type:
- normal:
- openApp:
- openUrl:
- openAppWithextras:
