mobeleader - Contribuciones del usuario [es]

SDKs:Push:configurar android

2019-12-05T15:18:01Z

Deneb:

Seleccionamos nuestra aplicación y añadimos el token de la Clave de servidor proporcionado por Google en la consola de Firebase.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_4.png

Una vez añadida la app, procederemos a configurar nuestro proyecto en Android Studio antes de comenzar con las notificaciones.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_5.png

SDKs:Push:configurar android

2019-12-05T15:17:43Z

Deneb:

Seleccionamos nuestra aplicación y añadimos el token de la Clave de servidor proporcionado por Google en la consola de Firebase.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_4.png

Una vez añadida la app, procederemos a configurar nuestro proyecto en Android Studio antes de comenzar con las notificaciones.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_5.png

SDKs:Push:configurar android

2019-12-05T11:52:53Z

Deneb:

Seleccionamos nuestra aplicación y añadimos el ***token*** de la **Clave de servidor*** proporcionado por **Google** en la consola de **Firebase**.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_4.png

Una vez añadida la app, procederemos a configurar nuestro proyecto en Android Studio antes de comenzar con las notificaciones.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_5.png

SDKs:Push:pasos panel

2019-12-05T11:48:41Z

Deneb:

Para poder configurar las notificaciones Push en una aplicación, debemos de haberla añadido previamente a nuestro panel. Si aún no la tenemos creada, lo haremos desde la sección [http://panel.mobeleader.com/index.php?sec=6 '''Mis Aplicaciones'''] del panel, pulsando en '''Crear Aplicación'''.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_1.png

Rellenamos los datos necesarios y enviamos el formulario.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_2.png

Una vez creada la aplicación, iremos a la sección [http://panel.mobeleader.com/index.php?sec=6 '''Mis Aplicaciones'''] del panel y pulsaremos [http://panel.mobeleader.com/index.php?sec=6 '''Añadir app a push'''].

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_3.png

SDKs:Push:pasos panel

2019-12-05T11:44:26Z

Deneb:

Para poder configurar las notificaciones Push en una aplicación, debemos de haberla añadido previamente a nuestro panel. Si aún no la tenemos creada, lo haremos desde la sección [http://panel.mobeleader.com/index.php?sec=6 '''Mis Aplicaciones'''] del panel, pulsando en '''Crear Aplicación'''.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_1.png

Rellenamos los datos necesarios y enviamos el formulario.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_2.png

Una vez creada la aplicación, iremos a la sección [http://panel.mobeleader.com/index.php?sec=6 '''Mis Aplicaciones'''] del panel y pulsaremos '''Añadir app a push'''.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_3.png

SDKs:Push:pasos panel

2019-12-05T11:39:59Z

Deneb:

Para poder configurar las notificaciones Push en una aplicación, debemos de haberla añadido previamente a nuestro panel. Si aún no la tenemos creada, lo haremos desde la sección [http://panel.mobeleader.com/index.php?sec=6 '''Mis Aplicaciones'''] del panel, pulsando en '''Crear Aplicación'''.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/panel_1.png

Rellenamos todos los datos necesarios y le damos a Crear la aplicación.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/Rellenar_datos_app.png

Una vez creada la aplicación, iremos a Notificaciones Push —> Añadir app a push, ubicado dentro de la sección de Desarrolladores.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/CrearNotificacion_3.png

SDKs:Push:pasos panel

2019-12-05T11:30:36Z

Deneb:

Para poder configurar las notificaciones Push en una aplicación, debemos de haberla añadido previamente a nuestro panel. Si aún no la tenemos creada, lo haremos desde la sección [http://panel.mobeleader.com/index.php?sec=6 '''Mis Aplicaciones'''] del panel, pulsando en '''Crear Aplicación'''.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/Panel_1.png

Rellenamos todos los datos necesarios y le damos a Crear la aplicación.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/Rellenar_datos_app.png

Una vez creada la aplicación, iremos a Notificaciones Push —> Añadir app a push, ubicado dentro de la sección de Desarrolladores.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/CrearNotificacion_3.png

Archivo:Panel 1.png

2019-12-05T11:30:01Z

Deneb:

Link Management

2019-06-07T11:34:12Z

Deneb: /* Consulta de las descargas */

= Introducción =
El '''Link Management''' permite realizar el seguimiento de las descargas de una aplicación realizadas a través de determinados enlaces o ''links''.
= Funcionamiento =
El proceso de seguimiento se realiza en 3 fases:
#Creación del ''link'' de descarga y agregación de éste en el HTML.
#Click del ''link'' y descarga de la aplicación asociada a él.
#Registro de la descarga y consulta.
= Creación y agregación del link =
== Creación del link ==
El primer paso consiste en crear el enlace o ''link'' para su posterior utilización. Si no lo está, diríjase a la sección [https://panel.mobeleader.com/index.php?sec=45 Link Management] de nuestro panel y pulse el botón '''Añadir nuevo link'''. Se mostrará el formulario a través del cual crear el ''link''.
[[Archivo: Link_select_0.png]]

Seleccione la aplicación que desee descargar a través del enlace. Recuerde que es necesario haber añadido la aplicación a nuestro sistema previamente. Si no es así, puede crearla en la sección [https://panel.mobeleader.com/index.php?sec=6 Mis Apps] de nuestro panel. A continuación escriba un nombre que identifique el enlace o ''link''.
Una vez seleccionada la app y el nombre del ''link'', añada la tienda o tiendas (''store'') a las que redireccionará el ''link''. Puede añadir los tipos de tienda que quiera. El sistema se encargará de redirigir a la ''store'' más apropiada, en función del terminal desde el que se clique el ''link''. Recuerde que si añade dos tiendas para el sistema Android (Google Play y Amazon por ejemplo), primará siempre la ''store'' oficial.

[[Archivo: Link_select_1.png]]
=== Campos opcionales ===
Puede añadir si lo desea hasta 3 campos opcionales con valores fijos para aportar mayor información al seguimiento de las descargas:
#Creando grupos de enlaces (enlaces para Facebook, descargas desde sus propias webs, etc.). Los campos y sus valores pueden repetirse o variar en cada uno de sus enlaces, en función de cómo quiera realizar el seguimiento de éstos.
#Añadiendo directamente estos campos a URLs de ''postback'' que quiera retornar a su propio sistema.

[[Archivo: Link_select_2.png]]

=== URLs Postback ===
En caso de querer retornar la información del enlace a su propio sistema, puede añadir URLs de ''postback'' al propio enlace. Si lo desea también puede añadir los campos opcionales (en caso de haber creado alguno) para que retornen como variables dentro de la URL de ''postback''.

[[Archivo: Link_select_3.png]]

== Agregación del link ==
Una vez creado el ''link'', éste aparecerá en la tabla '''Mis Links''' junto a la información correspondiente. La cadena que debe usar para añadir el ''link'' en el HTML desde el cual quiera lanzarlo (anuncio, web, imagen, etc.) es la correspondiente al campo '''Tracking Link'''.

[[Archivo: Link_select_4.png]]

Añádalo en su HTML de la siguiente forma:
<source lang="PHP">
<a href="https://referrer.mobeleader.com/api_referrer.php?a=d&r=5bacf404a21e3">Download MyFirstApp!</a>
</source>
Una vez el usuario pulse en el enlace, el sistema abrirá automáticamente la ''store'' que le corresponda, de aquellas añadidas al crearlo.
=== Variables externas del Link ===
Si desea obtener datos dinámicos desde el terminal del usuario y registrarlos posteriormente, puede hacerlo añadiendo las variables que desee al enlace. Ejemplo:
URL Postback: https://postbackserver.com/receiver.php?postback=1&userip=[IP]
Enlace: https://referrer.mobeleader.com/api_referrer.php?a=d&r=5bacf404a21e3&userip=0.0.0.0&aid=1234
En el este caso, también se añadirá la variable '''aid''' a su URL Postback, resultando: https://postbackserver.com/receiver.php?postback=1&userip=0.0.0.0&aid=1234

= Click del Link y descarga de la aplicación =
Una vez el ''link'' haya sido creado e implementado en el código correctamente, al clicar los usuarios en él, el sistema abrirá la tienda o ''store'' correspondiente en la que se mostrará la opción de descargar la aplicación.
Cada vez que se realice una descarga a través de éste proceso, el sistema registrará toda la información correspondiente a esa descarga y enviará la URL de ''postback'' en caso de que la haya. El sistema no registrará descargas realizadas desde otras URLs, o si la aplicación ya estuviera descargada y se abriera a través del enlace.
= Registro de la descarga y consulta =
== Registro de la descarga ==
Para que una aplicación pueda registrar descargas en nuestro sistema, es necesario lo siguiente:
#Haber añadido la aplicación a nuestro sistema desde la sección [https://panel.mobeleader.com/index.php?sec=6 Mis Apps] de nuestro panel.
#Haber implementado en la aplicación la librería Referrer (Android) o el Framework Referrer (iOS). Si aún no ha completado esta parte del proceso, diríjase a la documentación para agregar la [https://panel.mobeleader.com/index.php?sec=85&id=44&tipo=4 Librería en Android] o el [https://panel.mobeleader.com/index.php?sec=85&id=49&tipo=4 Framework en iOS] , en la que se explica detalladamente cómo realizar la implementación.
Una vez implementada la librería (o ''framework''), ésta enviará al sistema la información cada vez que se realice una descarga.

== Consulta de las descargas ==
Cada enlace o ''link'' mostrará, en la columna '''Descargas''' de la tabla '''Mis Links''', las descargas totales de cada plataforma.
Si desea obtener información más detallada de las descargas, diríjase a la sección [https://panel.mobeleader.com/index.php?sec=67&bloque=6 Analytics Links] de nuestro panel. Desde esa sección podrá segmentar la información de sus descargas por aplicación, fecha, sistema operativo, etc.

Link Management

2019-06-07T11:33:26Z

Deneb: /* Registro de la descarga */

= Introducción =
El '''Link Management''' permite realizar el seguimiento de las descargas de una aplicación realizadas a través de determinados enlaces o ''links''.
= Funcionamiento =
El proceso de seguimiento se realiza en 3 fases:
#Creación del ''link'' de descarga y agregación de éste en el HTML.
#Click del ''link'' y descarga de la aplicación asociada a él.
#Registro de la descarga y consulta.
= Creación y agregación del link =
== Creación del link ==
El primer paso consiste en crear el enlace o ''link'' para su posterior utilización. Si no lo está, diríjase a la sección [https://panel.mobeleader.com/index.php?sec=45 Link Management] de nuestro panel y pulse el botón '''Añadir nuevo link'''. Se mostrará el formulario a través del cual crear el ''link''.
[[Archivo: Link_select_0.png]]

Seleccione la aplicación que desee descargar a través del enlace. Recuerde que es necesario haber añadido la aplicación a nuestro sistema previamente. Si no es así, puede crearla en la sección [https://panel.mobeleader.com/index.php?sec=6 Mis Apps] de nuestro panel. A continuación escriba un nombre que identifique el enlace o ''link''.
Una vez seleccionada la app y el nombre del ''link'', añada la tienda o tiendas (''store'') a las que redireccionará el ''link''. Puede añadir los tipos de tienda que quiera. El sistema se encargará de redirigir a la ''store'' más apropiada, en función del terminal desde el que se clique el ''link''. Recuerde que si añade dos tiendas para el sistema Android (Google Play y Amazon por ejemplo), primará siempre la ''store'' oficial.

[[Archivo: Link_select_1.png]]
=== Campos opcionales ===
Puede añadir si lo desea hasta 3 campos opcionales con valores fijos para aportar mayor información al seguimiento de las descargas:
#Creando grupos de enlaces (enlaces para Facebook, descargas desde sus propias webs, etc.). Los campos y sus valores pueden repetirse o variar en cada uno de sus enlaces, en función de cómo quiera realizar el seguimiento de éstos.
#Añadiendo directamente estos campos a URLs de ''postback'' que quiera retornar a su propio sistema.

[[Archivo: Link_select_2.png]]

=== URLs Postback ===
En caso de querer retornar la información del enlace a su propio sistema, puede añadir URLs de ''postback'' al propio enlace. Si lo desea también puede añadir los campos opcionales (en caso de haber creado alguno) para que retornen como variables dentro de la URL de ''postback''.

[[Archivo: Link_select_3.png]]

== Agregación del link ==
Una vez creado el ''link'', éste aparecerá en la tabla '''Mis Links''' junto a la información correspondiente. La cadena que debe usar para añadir el ''link'' en el HTML desde el cual quiera lanzarlo (anuncio, web, imagen, etc.) es la correspondiente al campo '''Tracking Link'''.

[[Archivo: Link_select_4.png]]

Añádalo en su HTML de la siguiente forma:
<source lang="PHP">
<a href="https://referrer.mobeleader.com/api_referrer.php?a=d&r=5bacf404a21e3">Download MyFirstApp!</a>
</source>
Una vez el usuario pulse en el enlace, el sistema abrirá automáticamente la ''store'' que le corresponda, de aquellas añadidas al crearlo.
=== Variables externas del Link ===
Si desea obtener datos dinámicos desde el terminal del usuario y registrarlos posteriormente, puede hacerlo añadiendo las variables que desee al enlace. Ejemplo:
URL Postback: https://postbackserver.com/receiver.php?postback=1&userip=[IP]
Enlace: https://referrer.mobeleader.com/api_referrer.php?a=d&r=5bacf404a21e3&userip=0.0.0.0&aid=1234
En el este caso, también se añadirá la variable '''aid''' a su URL Postback, resultando: https://postbackserver.com/receiver.php?postback=1&userip=0.0.0.0&aid=1234

= Click del Link y descarga de la aplicación =
Una vez el ''link'' haya sido creado e implementado en el código correctamente, al clicar los usuarios en él, el sistema abrirá la tienda o ''store'' correspondiente en la que se mostrará la opción de descargar la aplicación.
Cada vez que se realice una descarga a través de éste proceso, el sistema registrará toda la información correspondiente a esa descarga y enviará la URL de ''postback'' en caso de que la haya. El sistema no registrará descargas realizadas desde otras URLs, o si la aplicación ya estuviera descargada y se abriera a través del enlace.
= Registro de la descarga y consulta =
== Registro de la descarga ==
Para que una aplicación pueda registrar descargas en nuestro sistema, es necesario lo siguiente:
#Haber añadido la aplicación a nuestro sistema desde la sección [https://panel.mobeleader.com/index.php?sec=6 Mis Apps] de nuestro panel.
#Haber implementado en la aplicación la librería Referrer (Android) o el Framework Referrer (iOS). Si aún no ha completado esta parte del proceso, diríjase a la documentación para agregar la [https://panel.mobeleader.com/index.php?sec=85&id=44&tipo=4 Librería en Android] o el [https://panel.mobeleader.com/index.php?sec=85&id=49&tipo=4 Framework en iOS] , en la que se explica detalladamente cómo realizar la implementación.
Una vez implementada la librería (o ''framework''), ésta enviará al sistema la información cada vez que se realice una descarga.

== Consulta de las descargas ==
Cada enlace o ''link'' mostrará, en la columna '''Descargas''' de la tabla '''Mis Links''', las descargas totales de cada plataforma.
Si desea obtener información más detallada de las descargas, diríjase a la [https://panel.mobeleader.com/index.php?sec=67&bloque=6 sección Analytics Links] del Panel de Mobeleader. Desde esa sección podrá segmentar la información de sus descargas por aplicación, fecha, sistema operativo, etc.

Link Management

2019-06-07T11:30:44Z

Deneb: /* Creación del link */

= Introducción =
El '''Link Management''' permite realizar el seguimiento de las descargas de una aplicación realizadas a través de determinados enlaces o ''links''.
= Funcionamiento =
El proceso de seguimiento se realiza en 3 fases:
#Creación del ''link'' de descarga y agregación de éste en el HTML.
#Click del ''link'' y descarga de la aplicación asociada a él.
#Registro de la descarga y consulta.
= Creación y agregación del link =
== Creación del link ==
El primer paso consiste en crear el enlace o ''link'' para su posterior utilización. Si no lo está, diríjase a la sección [https://panel.mobeleader.com/index.php?sec=45 Link Management] de nuestro panel y pulse el botón '''Añadir nuevo link'''. Se mostrará el formulario a través del cual crear el ''link''.
[[Archivo: Link_select_0.png]]

Seleccione la aplicación que desee descargar a través del enlace. Recuerde que es necesario haber añadido la aplicación a nuestro sistema previamente. Si no es así, puede crearla en la sección [https://panel.mobeleader.com/index.php?sec=6 Mis Apps] de nuestro panel. A continuación escriba un nombre que identifique el enlace o ''link''.
Una vez seleccionada la app y el nombre del ''link'', añada la tienda o tiendas (''store'') a las que redireccionará el ''link''. Puede añadir los tipos de tienda que quiera. El sistema se encargará de redirigir a la ''store'' más apropiada, en función del terminal desde el que se clique el ''link''. Recuerde que si añade dos tiendas para el sistema Android (Google Play y Amazon por ejemplo), primará siempre la ''store'' oficial.

[[Archivo: Link_select_1.png]]
=== Campos opcionales ===
Puede añadir si lo desea hasta 3 campos opcionales con valores fijos para aportar mayor información al seguimiento de las descargas:
#Creando grupos de enlaces (enlaces para Facebook, descargas desde sus propias webs, etc.). Los campos y sus valores pueden repetirse o variar en cada uno de sus enlaces, en función de cómo quiera realizar el seguimiento de éstos.
#Añadiendo directamente estos campos a URLs de ''postback'' que quiera retornar a su propio sistema.

[[Archivo: Link_select_2.png]]

=== URLs Postback ===
En caso de querer retornar la información del enlace a su propio sistema, puede añadir URLs de ''postback'' al propio enlace. Si lo desea también puede añadir los campos opcionales (en caso de haber creado alguno) para que retornen como variables dentro de la URL de ''postback''.

[[Archivo: Link_select_3.png]]

== Agregación del link ==
Una vez creado el ''link'', éste aparecerá en la tabla '''Mis Links''' junto a la información correspondiente. La cadena que debe usar para añadir el ''link'' en el HTML desde el cual quiera lanzarlo (anuncio, web, imagen, etc.) es la correspondiente al campo '''Tracking Link'''.

[[Archivo: Link_select_4.png]]

Añádalo en su HTML de la siguiente forma:
<source lang="PHP">
<a href="https://referrer.mobeleader.com/api_referrer.php?a=d&r=5bacf404a21e3">Download MyFirstApp!</a>
</source>
Una vez el usuario pulse en el enlace, el sistema abrirá automáticamente la ''store'' que le corresponda, de aquellas añadidas al crearlo.
=== Variables externas del Link ===
Si desea obtener datos dinámicos desde el terminal del usuario y registrarlos posteriormente, puede hacerlo añadiendo las variables que desee al enlace. Ejemplo:
URL Postback: https://postbackserver.com/receiver.php?postback=1&userip=[IP]
Enlace: https://referrer.mobeleader.com/api_referrer.php?a=d&r=5bacf404a21e3&userip=0.0.0.0&aid=1234
En el este caso, también se añadirá la variable '''aid''' a su URL Postback, resultando: https://postbackserver.com/receiver.php?postback=1&userip=0.0.0.0&aid=1234

= Click del Link y descarga de la aplicación =
Una vez el ''link'' haya sido creado e implementado en el código correctamente, al clicar los usuarios en él, el sistema abrirá la tienda o ''store'' correspondiente en la que se mostrará la opción de descargar la aplicación.
Cada vez que se realice una descarga a través de éste proceso, el sistema registrará toda la información correspondiente a esa descarga y enviará la URL de ''postback'' en caso de que la haya. El sistema no registrará descargas realizadas desde otras URLs, o si la aplicación ya estuviera descargada y se abriera a través del enlace.
= Registro de la descarga y consulta =
== Registro de la descarga ==
Para que una aplicación pueda registrar descargas en nuestro sistema, es necesario lo siguiente:
#Haber añadido la aplicación a nuestro sistema desde la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Apps] del Panel de Mobeleader.
#Haber implementado en la aplicación la librería Referrer (Android) o el Framework Referrer (iOS). Si aún no ha completado esta parte del proceso, diríjase a la documentación para agregar la [https://panel.mobeleader.com/index.php?sec=85&id=44&tipo=4 Librería en Android] o el [https://panel.mobeleader.com/index.php?sec=85&id=49&tipo=4 Framework en iOS] , en la que se explica detalladamente cómo realizar la implementación.
Una vez implementada la librería (o ''framework''), ésta enviará al sistema la información cada vez que se realice una descarga.

== Consulta de las descargas ==
Cada enlace o ''link'' mostrará, en la columna '''Descargas''' de la tabla '''Mis Links''', las descargas totales de cada plataforma.
Si desea obtener información más detallada de las descargas, diríjase a la [https://panel.mobeleader.com/index.php?sec=67&bloque=6 sección Analytics Links] del Panel de Mobeleader. Desde esa sección podrá segmentar la información de sus descargas por aplicación, fecha, sistema operativo, etc.

Link Management

2019-06-07T11:30:17Z

Deneb: /* Creación del link */

= Introducción =
El '''Link Management''' permite realizar el seguimiento de las descargas de una aplicación realizadas a través de determinados enlaces o ''links''.
= Funcionamiento =
El proceso de seguimiento se realiza en 3 fases:
#Creación del ''link'' de descarga y agregación de éste en el HTML.
#Click del ''link'' y descarga de la aplicación asociada a él.
#Registro de la descarga y consulta.
= Creación y agregación del link =
== Creación del link ==
El primer paso consiste en crear el enlace o ''link'' para su posterior utilización. Si no lo está, diríjase a la sección [https://panel.mobeleader.com/index.php?sec=45 Link Management] de nuestro panel y pulse el botón '''Añadir nuevo link'''. Se mostrará el formulario a través del cual crear el ''link''.
[[Archivo: Link_select_0.png]]

Seleccione la aplicación que desee descargar a través del enlace. Recuerde que es necesario haber añadido la aplicación a nuestro sistema previamente. Si no es así, puede crearla en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Apps] de nuestro panel. A continuación escriba un nombre que identifique el enlace o ''link''.
Una vez seleccionada la app y el nombre del ''link'', añada la tienda o tiendas (''store'') a las que redireccionará el ''link''. Puede añadir los tipos de tienda que quiera. El sistema se encargará de redirigir a la ''store'' más apropiada, en función del terminal desde el que se clique el ''link''. Recuerde que si añade dos tiendas para el sistema Android (Google Play y Amazon por ejemplo), primará siempre la ''store'' oficial.

[[Archivo: Link_select_1.png]]
=== Campos opcionales ===
Puede añadir si lo desea hasta 3 campos opcionales con valores fijos para aportar mayor información al seguimiento de las descargas:
#Creando grupos de enlaces (enlaces para Facebook, descargas desde sus propias webs, etc.). Los campos y sus valores pueden repetirse o variar en cada uno de sus enlaces, en función de cómo quiera realizar el seguimiento de éstos.
#Añadiendo directamente estos campos a URLs de ''postback'' que quiera retornar a su propio sistema.

[[Archivo: Link_select_2.png]]

=== URLs Postback ===
En caso de querer retornar la información del enlace a su propio sistema, puede añadir URLs de ''postback'' al propio enlace. Si lo desea también puede añadir los campos opcionales (en caso de haber creado alguno) para que retornen como variables dentro de la URL de ''postback''.

[[Archivo: Link_select_3.png]]

== Agregación del link ==
Una vez creado el ''link'', éste aparecerá en la tabla '''Mis Links''' junto a la información correspondiente. La cadena que debe usar para añadir el ''link'' en el HTML desde el cual quiera lanzarlo (anuncio, web, imagen, etc.) es la correspondiente al campo '''Tracking Link'''.

[[Archivo: Link_select_4.png]]

Añádalo en su HTML de la siguiente forma:
<source lang="PHP">
<a href="https://referrer.mobeleader.com/api_referrer.php?a=d&r=5bacf404a21e3">Download MyFirstApp!</a>
</source>
Una vez el usuario pulse en el enlace, el sistema abrirá automáticamente la ''store'' que le corresponda, de aquellas añadidas al crearlo.
=== Variables externas del Link ===
Si desea obtener datos dinámicos desde el terminal del usuario y registrarlos posteriormente, puede hacerlo añadiendo las variables que desee al enlace. Ejemplo:
URL Postback: https://postbackserver.com/receiver.php?postback=1&userip=[IP]
Enlace: https://referrer.mobeleader.com/api_referrer.php?a=d&r=5bacf404a21e3&userip=0.0.0.0&aid=1234
En el este caso, también se añadirá la variable '''aid''' a su URL Postback, resultando: https://postbackserver.com/receiver.php?postback=1&userip=0.0.0.0&aid=1234

= Click del Link y descarga de la aplicación =
Una vez el ''link'' haya sido creado e implementado en el código correctamente, al clicar los usuarios en él, el sistema abrirá la tienda o ''store'' correspondiente en la que se mostrará la opción de descargar la aplicación.
Cada vez que se realice una descarga a través de éste proceso, el sistema registrará toda la información correspondiente a esa descarga y enviará la URL de ''postback'' en caso de que la haya. El sistema no registrará descargas realizadas desde otras URLs, o si la aplicación ya estuviera descargada y se abriera a través del enlace.
= Registro de la descarga y consulta =
== Registro de la descarga ==
Para que una aplicación pueda registrar descargas en nuestro sistema, es necesario lo siguiente:
#Haber añadido la aplicación a nuestro sistema desde la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Apps] del Panel de Mobeleader.
#Haber implementado en la aplicación la librería Referrer (Android) o el Framework Referrer (iOS). Si aún no ha completado esta parte del proceso, diríjase a la documentación para agregar la [https://panel.mobeleader.com/index.php?sec=85&id=44&tipo=4 Librería en Android] o el [https://panel.mobeleader.com/index.php?sec=85&id=49&tipo=4 Framework en iOS] , en la que se explica detalladamente cómo realizar la implementación.
Una vez implementada la librería (o ''framework''), ésta enviará al sistema la información cada vez que se realice una descarga.

== Consulta de las descargas ==
Cada enlace o ''link'' mostrará, en la columna '''Descargas''' de la tabla '''Mis Links''', las descargas totales de cada plataforma.
Si desea obtener información más detallada de las descargas, diríjase a la [https://panel.mobeleader.com/index.php?sec=67&bloque=6 sección Analytics Links] del Panel de Mobeleader. Desde esa sección podrá segmentar la información de sus descargas por aplicación, fecha, sistema operativo, etc.

Docu push exchange

2019-06-07T11:28:16Z

Deneb: /* Borrado de usuarios registrados en su aplicación */

=Introducción=
En este documento se va a mostrar como ha de ser el contenido que se mande al api-exchange 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 poder realizar la conexión a nuestro sistema. 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”'''.
 
<source lang="PHP">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$json_datos_devueltos = $conexionapi->getData('ping');
</source>

[[Archivo:Conexion_ping.png|center]]
 
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 sistema operativo al que vaya la notificación, hay unos campos que '''son obligatorios'''; son los siguientes:
#'''appHash:''' contendrá el hash de la aplicación registrada, automáticamente generado por nuestro panel.
#'''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:
##'''all:''' En este caso se notificará a todos los dispositivos que estén registrados en la aplicación sin tener en cuenta el SO.
##'''onlyAndroid:''' Solo se notificará a los terminales con '''SO Android''' que estén registrados en la aplicación.
##'''onlyIOS:''' Solo se notificará a los terminales con '''SO IOs''' que estén registrados en la aplicación.
##'''Un token de un dispositivo en concreto,''' de manera que solo se le notifique a éste.
#'''message:''' contendrá el texto de la notificación.
#'''type:''' contendrá el tipo de notificación pudiendo ser este de de diversa índole.
#*'''normal:''' este tipo será el más común, el dispositivo recibirá la notificación y no se hará mas con ésta.
#*'''openApp:''' este tipo hará que al hacer click sobre la notificación se abra la aplicación encargada de mostrar dicha notificación.
#*'''openUrl:''' este tipo hará que al hacer click sobre la notificación se abra una URL especificada en otro campo que veremos más adelante.
#*'''openAppWithextras:''' este tipo hará lo mismo que el '''“openApp”''' pudiendo ademas añadir hasta cinco variables extra para poder tratarlas a nuestro gusto en la aplicación. Cabe destacar que este tipo de notificación, nos permitirá hacer uso de otro campo no obligatorio que más adelante trataremos, el cual se llama '''"customType”''' y nos permitirá lanzar notificaciones '''“personalizadas”'''.
 
Una vez vistos los campos obligatorios, a continuación se expondrán todos los '''campos no obligatorios''' que darán forma a las notificaciones:
#'''tittle:''' contendrá el texto del título que se mostrara junto con el mensaje de la notificación.
#'''sendingId:''' en caso de querer lanzar una notificación para muchos terminales, como hemos expuesto en los campos obligatorios, inicialmente el campo '''”terminalTokens"''' deberá ser un array con dichos terminales. Debido a que la API no puede admitir un número ilimitado de tokens a la vez, deberemos '''segmentar''' dicho array en varios más pequeños y hacer tantos '''“setPush”''' como sean necesarios hasta finalizar con el número de dispositivos a notificar. Cada vez que nos conectemos a la API para hacer un '''“setPush”''' y generar una notificación, dicha conexión nos devolverá un JSON en el cual hay un campo denominado '''“sendingId”''' con el ID autonumérico generado en nuestro sistema para ese envío push. De ésta manera, si se recoge dicho ID y se pasa como campo en la posición '''“sendingId”''', los siguientes tokens que se manden en el '''”terminalTokens”''' irán asociados al primer envío realizado.
#'''sandbox:''' este campo solo se usará cuando se vaya a notificar a algún dispositivo con '''SO iOs'''. Contendrá “yes” en caso de que dicho dispositivo este en el servidor de desarrollo de Apple, y un “no” en caso de que dicho dispositivo este en el servidor de producción de Apple.
#'''isTest:''' al igual que en el campo del '''“sandbox”''', contendrá “yes” o “no” dependiendo de si el dispositivo esta en el servidor de desarrollo o el de producción de Apple.
#'''background:''' este campo solo irá en caso de ir a algún dispositivo que tenga '''SO iOs'''. Contendrá “yes” o “no”. En caso de ser afirmativo la notificación se mostrará sin hacer ruido ni vibrar. Para el caso de iOs esto generará un alert vació con el '''content-available a 1'''.
#'''silent:''' Contendrá “yes” o “no”. En caso de ser afirmativo la notificación no se mostrará pero si lanzará el evento de la librería push encargado de escuchar si se ha recibido una notificación o no. De ésta manera podremos lanzar notificaciones que no se muestren, pero si hagan algo por detrás en la APP al recibirla. Para el caso de Android solo se usará este campo cuando el '''“type”''' de la notificación sea '''“openAppWithExtras”''' y se haga uso del campo no obligatorio '''“customType”'''. Para el caso de iOs esto generará un alert vació con el '''content-available a 1''' por defecto, pudiendo ser modificado por el siguiente campo que se expone a continuación ( '''silentNumber''' ). Como en el caso de Android esto solo tendrá sentido para las notificaciones de '''“type”''' '''“openAppWithExtras”''' , puesto que al no mostrar nada, se usarán para hacer cosas por detrás mediante los campos no obligatorios '''external1, external2, external3, external4 y external5'''. A diferencia de Android, en iOs se podrá usar con '''”customType”''' o sin el.
#'''silentNumber:''' este campo solo se usará para '''SO iOs'''. Es el número que aparecerá en el '''content-available''' en caso de que el campo '''silent''' sea '''"yes"'''.
#'''customType:''' contendrá el texto del tipo de notificación personalizada que cada uno cree. Éste campo solo se podrá usar si previamente en el campo obligatorio '''“type”''' se ha puesto '''“openAppWithExtras”'''.
#'''badge:''' este campo será el número que se mostrará junto con la notificación en los dispositivos '''SO iOs'''. A partir de iOs 10 las notificaciones '''no''' levantan la aplicación en caso de estar background, por lo que esto generará un '''content-available''' con el fin de despertar la aplicación y poder actualizar el icono de notificaciones pendientes en ésta.
#'''broadcast:''' esta variable solo será útil para dispositivos con '''SO Android''', contendrá el nombre de la clase instanciada en su aplicación para que se active al recibir la notificación.
#'''direct:''' contendra "yes" o "no". En caso de ser afirmativo las notificaciones se enviarán al instante no pudiendo programarlas.
#'''whenSend:''' contendrá “immediately”, “programmatically” o “geolocation”. En caso de ser immediately el campo '''“direct”''' previamente descrito deberá ser '''“yes”'''. En caso de ser “programmatically” o “geolocation” el campo '''“direct”''' previamente descrito deberá ser '''“no”''', ademas el envío se programará según los siguientes campos no obligatorios que se le pase.
#*'''Programmatically:''' cuando la notificación se quiera programar para una fecha en concreto , deberán existir los siguientes campos no obligatorios:
##'''programmaticallyTime:''' contendrá la fecha en '''UNIXTIMESTAMP''' en la que se lanzará la notificación, si se usa este campo no obligatorio no deberemos usar los siguientes.
##'''programmaticallyCronMinutes:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronHours:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronDays:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronMonths:''' ( FUNCIONALIDAD NO DISPONIBLE )
#*'''Geolocation:''' cuando se quiera programar por geolocalización una notificación, deberán existir los siguientes campos no obligatorios:
##'''geolocationCoordinates:''' será un array en el que la posición '''cero''' será la '''latitud''' y la '''uno''' la '''longitud'''.
##'''geolocationMeters:''' contendrá los metros a los que hemos de estar de las coordenadas especificadas para que lance la notificación.
#'''languaje:''' contendrá el idioma del dispositivo. '''Ejemplo: es'''.
#'''country:''' contendrá el país del dispositivo. '''Ejemplo: ES'''.
#'''deviceType:''' contendrá el tipo de dispositivo al que se le mandará la notificación pudiendo ser:
#*'''Para Android:'''
##'''movil'''.
##'''tableta'''.
##'''reloj'''.
##'''tv'''.
#*'''Para iOs:'''
##'''iphone'''.
##'''ipad'''.
##'''iwatch'''.
##'''appletv'''.
#'''appVersion:''' contendrá la versión de la aplicación a la que esta dirigida la notificación. '''Ejemplo: 1.0.1'''.
#'''terminalVersion:''' contendrá la versión del terminal al que ira dirigida la notificación. '''Ejemplo: 6.0.1'''.
#'''urlToOpen:''' contendrá la URL a abrir al hacer click sobre una notificación de tipo '''“openUrl”'''.
#'''external1:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external2:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external3:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external4:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external5:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''androidNotyStyle:''' contendrá '''“bigPictureStyle”''' cuando queramos mostrar una imagen junto con la notificación en los dispositivos con '''SO Android'''. En caso de no querer mostrar ninguna imagen no se utilizara este campo.
#'''bigPictureStyleUrlImage:''' contendrá la URL de la imagen que se quiera mostrar en los dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle"'''. Cabe destacar que la URL deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''bigPictureStyleExpandedTitle:''' contendrá el texto que se mostrará como titulo al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''bigPictureStyleExpandedSumaryText:''' contendrá el texto que se mostrará como mensaje al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''' , siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''extra-content:''' este campo solo se usará para notificaciones dirigidas a dispositivos con '''SO iOs'''. Contendrá la URL del contenido extra que se quiere mostrar junto con la notificación. En este caso y a diferencia de '''Android ( bigPictureStyleUrlImage )''', dicho contenido podrá ser una imagen, un giff, un video o un audio. La URL también deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''channel:''' A partir de Android O, las notificaciones deberán ir por un canal de notificaciones instanciado en su aplicación. Esta variable contendrá el nombre del canal por el que han de salir.
#'''thread-id:''' A partir de iOs 12, las notificaciones pueden ser agrupadas. Para ello deberemos mandar el mismo thread-id en todas las notificaciones que queramos agrupar.

=Notificaciones Android=
En este apartado veremos los distintos tipos de notificaciones para dispositivos Android mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal+IMG';
$arr_data['message'] = 'Mensaje Noti.Normal+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenApp+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp';
$arr_data['message'] = 'Mensaje Noti.OpenApp';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenUrl+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl';
$arr_data['message'] = 'Mensaje Noti.OpenUrl';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir'

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:''' Las notificaciones personalizadas, solo lanzarán la notificación si la APP se encuentra en background, en caso de estar en foreground (primer plano), no lanzará la notificación.
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_a_extras_p.png|center]]
 
                '''Sin notificación:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.Silent';
$arr_data['message'] = 'Mensaje Noti.Silent';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['silent'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin customType:'''
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external1'] = 'variable1';
$arr_data['external3'] = 'variable3';
$arr_data['external5'] = 'variable5';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_auto_generado';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + TipoDispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + TipoDispositivo';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['deviceType'] = 'movil';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionAplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionAplicacion';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['appVersion'] = '1.0';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionTerminal';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionTerminal';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['terminalVersion'] = '6.0.1';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Notificaciones iOs=
En este apartado veremos los distintos tipos de notificaciones para dispositivos iOs mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal Imagen';
$arr_data['message'] = 'Mensaje Noti.Normal Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App Con Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir App Con Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App';
$arr_data['message'] = 'Mensaje Noti.Abrir App';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir Url Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url';
$arr_data['message'] = 'Mensaje Noti.Abrir Url';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_eleccion_desarrollador';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_i_extras_p_s.png|center]]
 
            '''Sin customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_auto_generado';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Tipo Dispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + Tipo Dispositivo';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['deviceType'] = 'iphone';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Aplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Aplicacion';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['appVersion'] = '3.4';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Terminal';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Terminal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['terminalVersion'] = '10.3';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Respuesta setPush=
La respuesta que recibiremos por parte de la API siempre será un JSON. Dicho JSON contendrá de tres a cinco posiciones/elementos:
#'''responsecode:''' determinará si la acción a realizar sobre la API ha funcionado o no. En caso de ser '''negativo''' devolverá '''“KO”''' y en caso de ser '''positivo''' será '''“OK”'''.
#'''errorcode:''' en caso de que el '''responsecode''' sea '''“KO”''', devolverá el código de error en nuestro sistema. Por el contrario, si el '''responsecode''' es '''“OK”''', devolverá un 0.
#'''errortext:''' contendrá el texto del error que se ha producido, por lo que como se deduce esto solo saldrá cuando la acción sobre la API no se haya podido ejecutar.
#'''data:''' contendrá el resultado de la acción realizada satisfactoriamente sobre la API. Si ha habido un error esta posición '''no se generará'''.
#'''timestamp:''' devolverá la fecha en timestamp en la que la acción sobre la API ha sido realizada correctamente. Si ha habido un error esta posición '''no se generará'''.
 
En resumen, si la acción a realizar sobre la API ha dado error, el JSON contendrá los elementos ( responsecode, errorcode y errortext).
 
[[Archivo:Api_exchange_error.png|center]]
 
Por el contrario si la acción ha finalizado correcta y satisfactoriamente, el JSON contendrá los elementos ( responsecode, errorcode, data y timestamp).
Para el caso de crear una notificación ( '''setPush''' ), y que haya funcionado correctamente, en la respuesta se generará algo tal que la siguiente imágen:
 
[[Archivo:Api_exchange_noerror.png|center]]
 
En el contenido del elemento '''data''', se mostrara las notificaciones que se han podido enviar, las que no se han podido enviar, el ID que se genera en nuestro sistema asociado al envío solicitado y un array con los tokens enviados ( '''deletedArray''' ) y un array con los tokens que no se han podido enviar ( '''deletedWithoutSend''' ).
 
Este último caso, el del array con los tokens que no se han podido enviar solo se informará en el caso de que al enviar la acción '''setPush''', en la posición '''terminalTokens''', se mande '''un array con los terminales en concreto que se quieren notificar'''.
 
En el caso del array con los dispositivos notificados, se apreciará una segmentación por '''SO'''. En caso de que uno de estos dispositivos no haya podido recibir la notificación por problemas como bien puede ser un token obsoleto, se borrará de nuestro sistema y el token se informará en la posición ( '''deletedTokens''' ).

=Obtención de usuarios registrados en su aplicación=
Para obtener un conteo de usuarios registrados en nuestra aplicación y los datos de estos, deberemos hacer uso de la tarea '''“getPushTokens”''' y el hash de la aplicación registrada en nuestro panel. Dicho hash podremos verlo en cualquier momento desde la sección [https://panel.mobeleader.com/index.php?sec=6 Mis Apps] de nuestro panel. Una vez obtengamos dicho hash procederemos a conectarnos a la API de la manera expuesta en la a continuación:
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';

$json_datos_devueltos = $conexionapi->getData('getPushTokens', $arr_data);
</source>
 
[[Archivo:Api_exchange_getPushTokens.png|center]]
 
Como se puede apreciar en la respuesta, '''la posición respondecode es “OK”'''. Al igual que en el caso del '''“ping”''', siempre que el '''responsecode''' sea '''”OK”''' significara que la acción a realizar sobre la API ha finalizado correctamente y que en la posición '''“data”''' vendrá los solicitado, en este caso los datos de los terminales registrados en la aplicación.

=Borrado de usuarios registrados en su aplicación=
Una vez obtenidos los datos mediante la tarea '''“getPushTokens”''', si quisiéramos borrar alguno de dichos tokens de nuestro sistema, deberemos hacer uso de la tarea '''“deletePushTokens”''' usando el hash de la aplicación de la misma manera que en la obtención de usuarios, y pasándole el token o los tokens que quisiéramos borrar. Lo haremos de la siguiente manera:
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['tokens'][] = 'token_del_usuario_registrado';

$json_datos_devueltos = $conexionapi->getData('deletePushTokens', $arr_data);
</source>

 
[[Archivo:Api_exchange_deletePushTokens.png|center]]
 
Como siempre, en caso de que el '''responsecode sea “OK”''', en la '''posición “data”''' veremos el número de tokens borrados.

Docu push exchange

2019-06-07T11:27:20Z

Deneb: /* Obtención de usuarios registrados en su aplicación */

=Introducción=
En este documento se va a mostrar como ha de ser el contenido que se mande al api-exchange 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 poder realizar la conexión a nuestro sistema. 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”'''.
 
<source lang="PHP">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$json_datos_devueltos = $conexionapi->getData('ping');
</source>

[[Archivo:Conexion_ping.png|center]]
 
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 sistema operativo al que vaya la notificación, hay unos campos que '''son obligatorios'''; son los siguientes:
#'''appHash:''' contendrá el hash de la aplicación registrada, automáticamente generado por nuestro panel.
#'''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:
##'''all:''' En este caso se notificará a todos los dispositivos que estén registrados en la aplicación sin tener en cuenta el SO.
##'''onlyAndroid:''' Solo se notificará a los terminales con '''SO Android''' que estén registrados en la aplicación.
##'''onlyIOS:''' Solo se notificará a los terminales con '''SO IOs''' que estén registrados en la aplicación.
##'''Un token de un dispositivo en concreto,''' de manera que solo se le notifique a éste.
#'''message:''' contendrá el texto de la notificación.
#'''type:''' contendrá el tipo de notificación pudiendo ser este de de diversa índole.
#*'''normal:''' este tipo será el más común, el dispositivo recibirá la notificación y no se hará mas con ésta.
#*'''openApp:''' este tipo hará que al hacer click sobre la notificación se abra la aplicación encargada de mostrar dicha notificación.
#*'''openUrl:''' este tipo hará que al hacer click sobre la notificación se abra una URL especificada en otro campo que veremos más adelante.
#*'''openAppWithextras:''' este tipo hará lo mismo que el '''“openApp”''' pudiendo ademas añadir hasta cinco variables extra para poder tratarlas a nuestro gusto en la aplicación. Cabe destacar que este tipo de notificación, nos permitirá hacer uso de otro campo no obligatorio que más adelante trataremos, el cual se llama '''"customType”''' y nos permitirá lanzar notificaciones '''“personalizadas”'''.
 
Una vez vistos los campos obligatorios, a continuación se expondrán todos los '''campos no obligatorios''' que darán forma a las notificaciones:
#'''tittle:''' contendrá el texto del título que se mostrara junto con el mensaje de la notificación.
#'''sendingId:''' en caso de querer lanzar una notificación para muchos terminales, como hemos expuesto en los campos obligatorios, inicialmente el campo '''”terminalTokens"''' deberá ser un array con dichos terminales. Debido a que la API no puede admitir un número ilimitado de tokens a la vez, deberemos '''segmentar''' dicho array en varios más pequeños y hacer tantos '''“setPush”''' como sean necesarios hasta finalizar con el número de dispositivos a notificar. Cada vez que nos conectemos a la API para hacer un '''“setPush”''' y generar una notificación, dicha conexión nos devolverá un JSON en el cual hay un campo denominado '''“sendingId”''' con el ID autonumérico generado en nuestro sistema para ese envío push. De ésta manera, si se recoge dicho ID y se pasa como campo en la posición '''“sendingId”''', los siguientes tokens que se manden en el '''”terminalTokens”''' irán asociados al primer envío realizado.
#'''sandbox:''' este campo solo se usará cuando se vaya a notificar a algún dispositivo con '''SO iOs'''. Contendrá “yes” en caso de que dicho dispositivo este en el servidor de desarrollo de Apple, y un “no” en caso de que dicho dispositivo este en el servidor de producción de Apple.
#'''isTest:''' al igual que en el campo del '''“sandbox”''', contendrá “yes” o “no” dependiendo de si el dispositivo esta en el servidor de desarrollo o el de producción de Apple.
#'''background:''' este campo solo irá en caso de ir a algún dispositivo que tenga '''SO iOs'''. Contendrá “yes” o “no”. En caso de ser afirmativo la notificación se mostrará sin hacer ruido ni vibrar. Para el caso de iOs esto generará un alert vació con el '''content-available a 1'''.
#'''silent:''' Contendrá “yes” o “no”. En caso de ser afirmativo la notificación no se mostrará pero si lanzará el evento de la librería push encargado de escuchar si se ha recibido una notificación o no. De ésta manera podremos lanzar notificaciones que no se muestren, pero si hagan algo por detrás en la APP al recibirla. Para el caso de Android solo se usará este campo cuando el '''“type”''' de la notificación sea '''“openAppWithExtras”''' y se haga uso del campo no obligatorio '''“customType”'''. Para el caso de iOs esto generará un alert vació con el '''content-available a 1''' por defecto, pudiendo ser modificado por el siguiente campo que se expone a continuación ( '''silentNumber''' ). Como en el caso de Android esto solo tendrá sentido para las notificaciones de '''“type”''' '''“openAppWithExtras”''' , puesto que al no mostrar nada, se usarán para hacer cosas por detrás mediante los campos no obligatorios '''external1, external2, external3, external4 y external5'''. A diferencia de Android, en iOs se podrá usar con '''”customType”''' o sin el.
#'''silentNumber:''' este campo solo se usará para '''SO iOs'''. Es el número que aparecerá en el '''content-available''' en caso de que el campo '''silent''' sea '''"yes"'''.
#'''customType:''' contendrá el texto del tipo de notificación personalizada que cada uno cree. Éste campo solo se podrá usar si previamente en el campo obligatorio '''“type”''' se ha puesto '''“openAppWithExtras”'''.
#'''badge:''' este campo será el número que se mostrará junto con la notificación en los dispositivos '''SO iOs'''. A partir de iOs 10 las notificaciones '''no''' levantan la aplicación en caso de estar background, por lo que esto generará un '''content-available''' con el fin de despertar la aplicación y poder actualizar el icono de notificaciones pendientes en ésta.
#'''broadcast:''' esta variable solo será útil para dispositivos con '''SO Android''', contendrá el nombre de la clase instanciada en su aplicación para que se active al recibir la notificación.
#'''direct:''' contendra "yes" o "no". En caso de ser afirmativo las notificaciones se enviarán al instante no pudiendo programarlas.
#'''whenSend:''' contendrá “immediately”, “programmatically” o “geolocation”. En caso de ser immediately el campo '''“direct”''' previamente descrito deberá ser '''“yes”'''. En caso de ser “programmatically” o “geolocation” el campo '''“direct”''' previamente descrito deberá ser '''“no”''', ademas el envío se programará según los siguientes campos no obligatorios que se le pase.
#*'''Programmatically:''' cuando la notificación se quiera programar para una fecha en concreto , deberán existir los siguientes campos no obligatorios:
##'''programmaticallyTime:''' contendrá la fecha en '''UNIXTIMESTAMP''' en la que se lanzará la notificación, si se usa este campo no obligatorio no deberemos usar los siguientes.
##'''programmaticallyCronMinutes:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronHours:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronDays:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronMonths:''' ( FUNCIONALIDAD NO DISPONIBLE )
#*'''Geolocation:''' cuando se quiera programar por geolocalización una notificación, deberán existir los siguientes campos no obligatorios:
##'''geolocationCoordinates:''' será un array en el que la posición '''cero''' será la '''latitud''' y la '''uno''' la '''longitud'''.
##'''geolocationMeters:''' contendrá los metros a los que hemos de estar de las coordenadas especificadas para que lance la notificación.
#'''languaje:''' contendrá el idioma del dispositivo. '''Ejemplo: es'''.
#'''country:''' contendrá el país del dispositivo. '''Ejemplo: ES'''.
#'''deviceType:''' contendrá el tipo de dispositivo al que se le mandará la notificación pudiendo ser:
#*'''Para Android:'''
##'''movil'''.
##'''tableta'''.
##'''reloj'''.
##'''tv'''.
#*'''Para iOs:'''
##'''iphone'''.
##'''ipad'''.
##'''iwatch'''.
##'''appletv'''.
#'''appVersion:''' contendrá la versión de la aplicación a la que esta dirigida la notificación. '''Ejemplo: 1.0.1'''.
#'''terminalVersion:''' contendrá la versión del terminal al que ira dirigida la notificación. '''Ejemplo: 6.0.1'''.
#'''urlToOpen:''' contendrá la URL a abrir al hacer click sobre una notificación de tipo '''“openUrl”'''.
#'''external1:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external2:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external3:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external4:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external5:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''androidNotyStyle:''' contendrá '''“bigPictureStyle”''' cuando queramos mostrar una imagen junto con la notificación en los dispositivos con '''SO Android'''. En caso de no querer mostrar ninguna imagen no se utilizara este campo.
#'''bigPictureStyleUrlImage:''' contendrá la URL de la imagen que se quiera mostrar en los dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle"'''. Cabe destacar que la URL deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''bigPictureStyleExpandedTitle:''' contendrá el texto que se mostrará como titulo al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''bigPictureStyleExpandedSumaryText:''' contendrá el texto que se mostrará como mensaje al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''' , siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''extra-content:''' este campo solo se usará para notificaciones dirigidas a dispositivos con '''SO iOs'''. Contendrá la URL del contenido extra que se quiere mostrar junto con la notificación. En este caso y a diferencia de '''Android ( bigPictureStyleUrlImage )''', dicho contenido podrá ser una imagen, un giff, un video o un audio. La URL también deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''channel:''' A partir de Android O, las notificaciones deberán ir por un canal de notificaciones instanciado en su aplicación. Esta variable contendrá el nombre del canal por el que han de salir.
#'''thread-id:''' A partir de iOs 12, las notificaciones pueden ser agrupadas. Para ello deberemos mandar el mismo thread-id en todas las notificaciones que queramos agrupar.

=Notificaciones Android=
En este apartado veremos los distintos tipos de notificaciones para dispositivos Android mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal+IMG';
$arr_data['message'] = 'Mensaje Noti.Normal+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenApp+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp';
$arr_data['message'] = 'Mensaje Noti.OpenApp';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenUrl+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl';
$arr_data['message'] = 'Mensaje Noti.OpenUrl';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir'

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:''' Las notificaciones personalizadas, solo lanzarán la notificación si la APP se encuentra en background, en caso de estar en foreground (primer plano), no lanzará la notificación.
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_a_extras_p.png|center]]
 
                '''Sin notificación:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.Silent';
$arr_data['message'] = 'Mensaje Noti.Silent';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['silent'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin customType:'''
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external1'] = 'variable1';
$arr_data['external3'] = 'variable3';
$arr_data['external5'] = 'variable5';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_auto_generado';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + TipoDispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + TipoDispositivo';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['deviceType'] = 'movil';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionAplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionAplicacion';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['appVersion'] = '1.0';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionTerminal';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionTerminal';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['terminalVersion'] = '6.0.1';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Notificaciones iOs=
En este apartado veremos los distintos tipos de notificaciones para dispositivos iOs mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal Imagen';
$arr_data['message'] = 'Mensaje Noti.Normal Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App Con Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir App Con Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App';
$arr_data['message'] = 'Mensaje Noti.Abrir App';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir Url Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url';
$arr_data['message'] = 'Mensaje Noti.Abrir Url';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_eleccion_desarrollador';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_i_extras_p_s.png|center]]
 
            '''Sin customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_auto_generado';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Tipo Dispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + Tipo Dispositivo';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['deviceType'] = 'iphone';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Aplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Aplicacion';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['appVersion'] = '3.4';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Terminal';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Terminal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['terminalVersion'] = '10.3';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Respuesta setPush=
La respuesta que recibiremos por parte de la API siempre será un JSON. Dicho JSON contendrá de tres a cinco posiciones/elementos:
#'''responsecode:''' determinará si la acción a realizar sobre la API ha funcionado o no. En caso de ser '''negativo''' devolverá '''“KO”''' y en caso de ser '''positivo''' será '''“OK”'''.
#'''errorcode:''' en caso de que el '''responsecode''' sea '''“KO”''', devolverá el código de error en nuestro sistema. Por el contrario, si el '''responsecode''' es '''“OK”''', devolverá un 0.
#'''errortext:''' contendrá el texto del error que se ha producido, por lo que como se deduce esto solo saldrá cuando la acción sobre la API no se haya podido ejecutar.
#'''data:''' contendrá el resultado de la acción realizada satisfactoriamente sobre la API. Si ha habido un error esta posición '''no se generará'''.
#'''timestamp:''' devolverá la fecha en timestamp en la que la acción sobre la API ha sido realizada correctamente. Si ha habido un error esta posición '''no se generará'''.
 
En resumen, si la acción a realizar sobre la API ha dado error, el JSON contendrá los elementos ( responsecode, errorcode y errortext).
 
[[Archivo:Api_exchange_error.png|center]]
 
Por el contrario si la acción ha finalizado correcta y satisfactoriamente, el JSON contendrá los elementos ( responsecode, errorcode, data y timestamp).
Para el caso de crear una notificación ( '''setPush''' ), y que haya funcionado correctamente, en la respuesta se generará algo tal que la siguiente imágen:
 
[[Archivo:Api_exchange_noerror.png|center]]
 
En el contenido del elemento '''data''', se mostrara las notificaciones que se han podido enviar, las que no se han podido enviar, el ID que se genera en nuestro sistema asociado al envío solicitado y un array con los tokens enviados ( '''deletedArray''' ) y un array con los tokens que no se han podido enviar ( '''deletedWithoutSend''' ).
 
Este último caso, el del array con los tokens que no se han podido enviar solo se informará en el caso de que al enviar la acción '''setPush''', en la posición '''terminalTokens''', se mande '''un array con los terminales en concreto que se quieren notificar'''.
 
En el caso del array con los dispositivos notificados, se apreciará una segmentación por '''SO'''. En caso de que uno de estos dispositivos no haya podido recibir la notificación por problemas como bien puede ser un token obsoleto, se borrará de nuestro sistema y el token se informará en la posición ( '''deletedTokens''' ).

=Obtención de usuarios registrados en su aplicación=
Para obtener un conteo de usuarios registrados en nuestra aplicación y los datos de estos, deberemos hacer uso de la tarea '''“getPushTokens”''' y el hash de la aplicación registrada en nuestro panel. Dicho hash podremos verlo en cualquier momento desde la sección [https://panel.mobeleader.com/index.php?sec=6 Mis Apps] de nuestro panel. Una vez obtengamos dicho hash procederemos a conectarnos a la API de la manera expuesta en la a continuación:
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';

$json_datos_devueltos = $conexionapi->getData('getPushTokens', $arr_data);
</source>
 
[[Archivo:Api_exchange_getPushTokens.png|center]]
 
Como se puede apreciar en la respuesta, '''la posición respondecode es “OK”'''. Al igual que en el caso del '''“ping”''', siempre que el '''responsecode''' sea '''”OK”''' significara que la acción a realizar sobre la API ha finalizado correctamente y que en la posición '''“data”''' vendrá los solicitado, en este caso los datos de los terminales registrados en la aplicación.

=Borrado de usuarios registrados en su aplicación=
Una vez obtenidos los datos mediante la tarea '''“getPushTokens”''', si quisiéramos borrar alguno de dichos tokens del sistema de Mobeleader, deberemos hacer uso de la tarea '''“deletePushTokens”''' usando el hash de la aplicación de la misma manera que en la obtención de usuarios, y pasándole el token o los tokens que quisiéramos borrar. Lo haremos de la siguiente manera:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['tokens'][] = 'token_del_usuario_registrado';

$json_datos_devueltos = $conexionapi->getData('deletePushTokens', $arr_data);
</source>

 
[[Archivo:Api_exchange_deletePushTokens.png|center]]
 
Como siempre, en caso de que el '''responsecode sea “OK”''', en la '''posición “data”''' veremos el número de tokens borrados.

Docu push exchange

2019-06-07T11:24:42Z

Deneb: /* Notificaciones iOs */

=Introducción=
En este documento se va a mostrar como ha de ser el contenido que se mande al api-exchange 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 poder realizar la conexión a nuestro sistema. 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”'''.
 
<source lang="PHP">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$json_datos_devueltos = $conexionapi->getData('ping');
</source>

[[Archivo:Conexion_ping.png|center]]
 
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 sistema operativo al que vaya la notificación, hay unos campos que '''son obligatorios'''; son los siguientes:
#'''appHash:''' contendrá el hash de la aplicación registrada, automáticamente generado por nuestro panel.
#'''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:
##'''all:''' En este caso se notificará a todos los dispositivos que estén registrados en la aplicación sin tener en cuenta el SO.
##'''onlyAndroid:''' Solo se notificará a los terminales con '''SO Android''' que estén registrados en la aplicación.
##'''onlyIOS:''' Solo se notificará a los terminales con '''SO IOs''' que estén registrados en la aplicación.
##'''Un token de un dispositivo en concreto,''' de manera que solo se le notifique a éste.
#'''message:''' contendrá el texto de la notificación.
#'''type:''' contendrá el tipo de notificación pudiendo ser este de de diversa índole.
#*'''normal:''' este tipo será el más común, el dispositivo recibirá la notificación y no se hará mas con ésta.
#*'''openApp:''' este tipo hará que al hacer click sobre la notificación se abra la aplicación encargada de mostrar dicha notificación.
#*'''openUrl:''' este tipo hará que al hacer click sobre la notificación se abra una URL especificada en otro campo que veremos más adelante.
#*'''openAppWithextras:''' este tipo hará lo mismo que el '''“openApp”''' pudiendo ademas añadir hasta cinco variables extra para poder tratarlas a nuestro gusto en la aplicación. Cabe destacar que este tipo de notificación, nos permitirá hacer uso de otro campo no obligatorio que más adelante trataremos, el cual se llama '''"customType”''' y nos permitirá lanzar notificaciones '''“personalizadas”'''.
 
Una vez vistos los campos obligatorios, a continuación se expondrán todos los '''campos no obligatorios''' que darán forma a las notificaciones:
#'''tittle:''' contendrá el texto del título que se mostrara junto con el mensaje de la notificación.
#'''sendingId:''' en caso de querer lanzar una notificación para muchos terminales, como hemos expuesto en los campos obligatorios, inicialmente el campo '''”terminalTokens"''' deberá ser un array con dichos terminales. Debido a que la API no puede admitir un número ilimitado de tokens a la vez, deberemos '''segmentar''' dicho array en varios más pequeños y hacer tantos '''“setPush”''' como sean necesarios hasta finalizar con el número de dispositivos a notificar. Cada vez que nos conectemos a la API para hacer un '''“setPush”''' y generar una notificación, dicha conexión nos devolverá un JSON en el cual hay un campo denominado '''“sendingId”''' con el ID autonumérico generado en nuestro sistema para ese envío push. De ésta manera, si se recoge dicho ID y se pasa como campo en la posición '''“sendingId”''', los siguientes tokens que se manden en el '''”terminalTokens”''' irán asociados al primer envío realizado.
#'''sandbox:''' este campo solo se usará cuando se vaya a notificar a algún dispositivo con '''SO iOs'''. Contendrá “yes” en caso de que dicho dispositivo este en el servidor de desarrollo de Apple, y un “no” en caso de que dicho dispositivo este en el servidor de producción de Apple.
#'''isTest:''' al igual que en el campo del '''“sandbox”''', contendrá “yes” o “no” dependiendo de si el dispositivo esta en el servidor de desarrollo o el de producción de Apple.
#'''background:''' este campo solo irá en caso de ir a algún dispositivo que tenga '''SO iOs'''. Contendrá “yes” o “no”. En caso de ser afirmativo la notificación se mostrará sin hacer ruido ni vibrar. Para el caso de iOs esto generará un alert vació con el '''content-available a 1'''.
#'''silent:''' Contendrá “yes” o “no”. En caso de ser afirmativo la notificación no se mostrará pero si lanzará el evento de la librería push encargado de escuchar si se ha recibido una notificación o no. De ésta manera podremos lanzar notificaciones que no se muestren, pero si hagan algo por detrás en la APP al recibirla. Para el caso de Android solo se usará este campo cuando el '''“type”''' de la notificación sea '''“openAppWithExtras”''' y se haga uso del campo no obligatorio '''“customType”'''. Para el caso de iOs esto generará un alert vació con el '''content-available a 1''' por defecto, pudiendo ser modificado por el siguiente campo que se expone a continuación ( '''silentNumber''' ). Como en el caso de Android esto solo tendrá sentido para las notificaciones de '''“type”''' '''“openAppWithExtras”''' , puesto que al no mostrar nada, se usarán para hacer cosas por detrás mediante los campos no obligatorios '''external1, external2, external3, external4 y external5'''. A diferencia de Android, en iOs se podrá usar con '''”customType”''' o sin el.
#'''silentNumber:''' este campo solo se usará para '''SO iOs'''. Es el número que aparecerá en el '''content-available''' en caso de que el campo '''silent''' sea '''"yes"'''.
#'''customType:''' contendrá el texto del tipo de notificación personalizada que cada uno cree. Éste campo solo se podrá usar si previamente en el campo obligatorio '''“type”''' se ha puesto '''“openAppWithExtras”'''.
#'''badge:''' este campo será el número que se mostrará junto con la notificación en los dispositivos '''SO iOs'''. A partir de iOs 10 las notificaciones '''no''' levantan la aplicación en caso de estar background, por lo que esto generará un '''content-available''' con el fin de despertar la aplicación y poder actualizar el icono de notificaciones pendientes en ésta.
#'''broadcast:''' esta variable solo será útil para dispositivos con '''SO Android''', contendrá el nombre de la clase instanciada en su aplicación para que se active al recibir la notificación.
#'''direct:''' contendra "yes" o "no". En caso de ser afirmativo las notificaciones se enviarán al instante no pudiendo programarlas.
#'''whenSend:''' contendrá “immediately”, “programmatically” o “geolocation”. En caso de ser immediately el campo '''“direct”''' previamente descrito deberá ser '''“yes”'''. En caso de ser “programmatically” o “geolocation” el campo '''“direct”''' previamente descrito deberá ser '''“no”''', ademas el envío se programará según los siguientes campos no obligatorios que se le pase.
#*'''Programmatically:''' cuando la notificación se quiera programar para una fecha en concreto , deberán existir los siguientes campos no obligatorios:
##'''programmaticallyTime:''' contendrá la fecha en '''UNIXTIMESTAMP''' en la que se lanzará la notificación, si se usa este campo no obligatorio no deberemos usar los siguientes.
##'''programmaticallyCronMinutes:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronHours:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronDays:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronMonths:''' ( FUNCIONALIDAD NO DISPONIBLE )
#*'''Geolocation:''' cuando se quiera programar por geolocalización una notificación, deberán existir los siguientes campos no obligatorios:
##'''geolocationCoordinates:''' será un array en el que la posición '''cero''' será la '''latitud''' y la '''uno''' la '''longitud'''.
##'''geolocationMeters:''' contendrá los metros a los que hemos de estar de las coordenadas especificadas para que lance la notificación.
#'''languaje:''' contendrá el idioma del dispositivo. '''Ejemplo: es'''.
#'''country:''' contendrá el país del dispositivo. '''Ejemplo: ES'''.
#'''deviceType:''' contendrá el tipo de dispositivo al que se le mandará la notificación pudiendo ser:
#*'''Para Android:'''
##'''movil'''.
##'''tableta'''.
##'''reloj'''.
##'''tv'''.
#*'''Para iOs:'''
##'''iphone'''.
##'''ipad'''.
##'''iwatch'''.
##'''appletv'''.
#'''appVersion:''' contendrá la versión de la aplicación a la que esta dirigida la notificación. '''Ejemplo: 1.0.1'''.
#'''terminalVersion:''' contendrá la versión del terminal al que ira dirigida la notificación. '''Ejemplo: 6.0.1'''.
#'''urlToOpen:''' contendrá la URL a abrir al hacer click sobre una notificación de tipo '''“openUrl”'''.
#'''external1:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external2:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external3:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external4:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external5:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''androidNotyStyle:''' contendrá '''“bigPictureStyle”''' cuando queramos mostrar una imagen junto con la notificación en los dispositivos con '''SO Android'''. En caso de no querer mostrar ninguna imagen no se utilizara este campo.
#'''bigPictureStyleUrlImage:''' contendrá la URL de la imagen que se quiera mostrar en los dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle"'''. Cabe destacar que la URL deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''bigPictureStyleExpandedTitle:''' contendrá el texto que se mostrará como titulo al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''bigPictureStyleExpandedSumaryText:''' contendrá el texto que se mostrará como mensaje al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''' , siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''extra-content:''' este campo solo se usará para notificaciones dirigidas a dispositivos con '''SO iOs'''. Contendrá la URL del contenido extra que se quiere mostrar junto con la notificación. En este caso y a diferencia de '''Android ( bigPictureStyleUrlImage )''', dicho contenido podrá ser una imagen, un giff, un video o un audio. La URL también deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''channel:''' A partir de Android O, las notificaciones deberán ir por un canal de notificaciones instanciado en su aplicación. Esta variable contendrá el nombre del canal por el que han de salir.
#'''thread-id:''' A partir de iOs 12, las notificaciones pueden ser agrupadas. Para ello deberemos mandar el mismo thread-id en todas las notificaciones que queramos agrupar.

=Notificaciones Android=
En este apartado veremos los distintos tipos de notificaciones para dispositivos Android mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal+IMG';
$arr_data['message'] = 'Mensaje Noti.Normal+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenApp+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp';
$arr_data['message'] = 'Mensaje Noti.OpenApp';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenUrl+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl';
$arr_data['message'] = 'Mensaje Noti.OpenUrl';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir'

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:''' Las notificaciones personalizadas, solo lanzarán la notificación si la APP se encuentra en background, en caso de estar en foreground (primer plano), no lanzará la notificación.
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_a_extras_p.png|center]]
 
                '''Sin notificación:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.Silent';
$arr_data['message'] = 'Mensaje Noti.Silent';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['silent'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin customType:'''
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external1'] = 'variable1';
$arr_data['external3'] = 'variable3';
$arr_data['external5'] = 'variable5';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_auto_generado';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + TipoDispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + TipoDispositivo';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['deviceType'] = 'movil';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionAplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionAplicacion';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['appVersion'] = '1.0';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionTerminal';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionTerminal';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['terminalVersion'] = '6.0.1';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Notificaciones iOs=
En este apartado veremos los distintos tipos de notificaciones para dispositivos iOs mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal Imagen';
$arr_data['message'] = 'Mensaje Noti.Normal Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App Con Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir App Con Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App';
$arr_data['message'] = 'Mensaje Noti.Abrir App';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir Url Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url';
$arr_data['message'] = 'Mensaje Noti.Abrir Url';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_eleccion_desarrollador';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_i_extras_p_s.png|center]]
 
            '''Sin customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_auto_generado';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Tipo Dispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + Tipo Dispositivo';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['deviceType'] = 'iphone';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Aplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Aplicacion';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['appVersion'] = '3.4';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Terminal';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Terminal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['terminalVersion'] = '10.3';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Respuesta setPush=
La respuesta que recibiremos por parte de la API siempre será un JSON. Dicho JSON contendrá de tres a cinco posiciones/elementos:
#'''responsecode:''' determinará si la acción a realizar sobre la API ha funcionado o no. En caso de ser '''negativo''' devolverá '''“KO”''' y en caso de ser '''positivo''' será '''“OK”'''.
#'''errorcode:''' en caso de que el '''responsecode''' sea '''“KO”''', devolverá el código de error en nuestro sistema. Por el contrario, si el '''responsecode''' es '''“OK”''', devolverá un 0.
#'''errortext:''' contendrá el texto del error que se ha producido, por lo que como se deduce esto solo saldrá cuando la acción sobre la API no se haya podido ejecutar.
#'''data:''' contendrá el resultado de la acción realizada satisfactoriamente sobre la API. Si ha habido un error esta posición '''no se generará'''.
#'''timestamp:''' devolverá la fecha en timestamp en la que la acción sobre la API ha sido realizada correctamente. Si ha habido un error esta posición '''no se generará'''.
 
En resumen, si la acción a realizar sobre la API ha dado error, el JSON contendrá los elementos ( responsecode, errorcode y errortext).
 
[[Archivo:Api_exchange_error.png|center]]
 
Por el contrario si la acción ha finalizado correcta y satisfactoriamente, el JSON contendrá los elementos ( responsecode, errorcode, data y timestamp).
Para el caso de crear una notificación ( '''setPush''' ), y que haya funcionado correctamente, en la respuesta se generará algo tal que la siguiente imágen:
 
[[Archivo:Api_exchange_noerror.png|center]]
 
En el contenido del elemento '''data''', se mostrara las notificaciones que se han podido enviar, las que no se han podido enviar, el ID que se genera en nuestro sistema asociado al envío solicitado y un array con los tokens enviados ( '''deletedArray''' ) y un array con los tokens que no se han podido enviar ( '''deletedWithoutSend''' ).
 
Este último caso, el del array con los tokens que no se han podido enviar solo se informará en el caso de que al enviar la acción '''setPush''', en la posición '''terminalTokens''', se mande '''un array con los terminales en concreto que se quieren notificar'''.
 
En el caso del array con los dispositivos notificados, se apreciará una segmentación por '''SO'''. En caso de que uno de estos dispositivos no haya podido recibir la notificación por problemas como bien puede ser un token obsoleto, se borrará de nuestro sistema y el token se informará en la posición ( '''deletedTokens''' ).

=Obtención de usuarios registrados en su aplicación=
Para obtener un conteo de usuarios registrados en nuestra aplicación y los datos de estos, deberemos hacer uso de la tarea '''“getPushTokens”''' y el hash de la aplicación registrada en el panel de Mobeleader. Dicho hash podremos verlo en cualquier momento desde la sección https://panel.mobeleader.com/index.php?sec=6. Una vez obtengamos dicho hash procederemos a conectarnos a la API de la manera expuesta en la a continuación:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';

$json_datos_devueltos = $conexionapi->getData('getPushTokens', $arr_data);
</source>
 
[[Archivo:Api_exchange_getPushTokens.png|center]]
 
Como se puede apreciar en la respuesta, '''la posición respondecode es “OK”'''. Al igual que en el caso del '''“ping”''', siempre que el '''responsecode''' sea '''”OK”''' significara que la acción a realizar sobre la API ha finalizado correctamente y que en la posición '''“data”''' vendrá los solicitado, en este caso los datos de los terminales registrados en la aplicación.

=Borrado de usuarios registrados en su aplicación=
Una vez obtenidos los datos mediante la tarea '''“getPushTokens”''', si quisiéramos borrar alguno de dichos tokens del sistema de Mobeleader, deberemos hacer uso de la tarea '''“deletePushTokens”''' usando el hash de la aplicación de la misma manera que en la obtención de usuarios, y pasándole el token o los tokens que quisiéramos borrar. Lo haremos de la siguiente manera:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['tokens'][] = 'token_del_usuario_registrado';

$json_datos_devueltos = $conexionapi->getData('deletePushTokens', $arr_data);
</source>

 
[[Archivo:Api_exchange_deletePushTokens.png|center]]
 
Como siempre, en caso de que el '''responsecode sea “OK”''', en la '''posición “data”''' veremos el número de tokens borrados.

Docu push exchange

2019-06-07T11:22:48Z

Deneb: /* Notificaciones Android */

=Introducción=
En este documento se va a mostrar como ha de ser el contenido que se mande al api-exchange 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 poder realizar la conexión a nuestro sistema. 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”'''.
 
<source lang="PHP">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$json_datos_devueltos = $conexionapi->getData('ping');
</source>

[[Archivo:Conexion_ping.png|center]]
 
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 sistema operativo al que vaya la notificación, hay unos campos que '''son obligatorios'''; son los siguientes:
#'''appHash:''' contendrá el hash de la aplicación registrada, automáticamente generado por nuestro panel.
#'''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:
##'''all:''' En este caso se notificará a todos los dispositivos que estén registrados en la aplicación sin tener en cuenta el SO.
##'''onlyAndroid:''' Solo se notificará a los terminales con '''SO Android''' que estén registrados en la aplicación.
##'''onlyIOS:''' Solo se notificará a los terminales con '''SO IOs''' que estén registrados en la aplicación.
##'''Un token de un dispositivo en concreto,''' de manera que solo se le notifique a éste.
#'''message:''' contendrá el texto de la notificación.
#'''type:''' contendrá el tipo de notificación pudiendo ser este de de diversa índole.
#*'''normal:''' este tipo será el más común, el dispositivo recibirá la notificación y no se hará mas con ésta.
#*'''openApp:''' este tipo hará que al hacer click sobre la notificación se abra la aplicación encargada de mostrar dicha notificación.
#*'''openUrl:''' este tipo hará que al hacer click sobre la notificación se abra una URL especificada en otro campo que veremos más adelante.
#*'''openAppWithextras:''' este tipo hará lo mismo que el '''“openApp”''' pudiendo ademas añadir hasta cinco variables extra para poder tratarlas a nuestro gusto en la aplicación. Cabe destacar que este tipo de notificación, nos permitirá hacer uso de otro campo no obligatorio que más adelante trataremos, el cual se llama '''"customType”''' y nos permitirá lanzar notificaciones '''“personalizadas”'''.
 
Una vez vistos los campos obligatorios, a continuación se expondrán todos los '''campos no obligatorios''' que darán forma a las notificaciones:
#'''tittle:''' contendrá el texto del título que se mostrara junto con el mensaje de la notificación.
#'''sendingId:''' en caso de querer lanzar una notificación para muchos terminales, como hemos expuesto en los campos obligatorios, inicialmente el campo '''”terminalTokens"''' deberá ser un array con dichos terminales. Debido a que la API no puede admitir un número ilimitado de tokens a la vez, deberemos '''segmentar''' dicho array en varios más pequeños y hacer tantos '''“setPush”''' como sean necesarios hasta finalizar con el número de dispositivos a notificar. Cada vez que nos conectemos a la API para hacer un '''“setPush”''' y generar una notificación, dicha conexión nos devolverá un JSON en el cual hay un campo denominado '''“sendingId”''' con el ID autonumérico generado en nuestro sistema para ese envío push. De ésta manera, si se recoge dicho ID y se pasa como campo en la posición '''“sendingId”''', los siguientes tokens que se manden en el '''”terminalTokens”''' irán asociados al primer envío realizado.
#'''sandbox:''' este campo solo se usará cuando se vaya a notificar a algún dispositivo con '''SO iOs'''. Contendrá “yes” en caso de que dicho dispositivo este en el servidor de desarrollo de Apple, y un “no” en caso de que dicho dispositivo este en el servidor de producción de Apple.
#'''isTest:''' al igual que en el campo del '''“sandbox”''', contendrá “yes” o “no” dependiendo de si el dispositivo esta en el servidor de desarrollo o el de producción de Apple.
#'''background:''' este campo solo irá en caso de ir a algún dispositivo que tenga '''SO iOs'''. Contendrá “yes” o “no”. En caso de ser afirmativo la notificación se mostrará sin hacer ruido ni vibrar. Para el caso de iOs esto generará un alert vació con el '''content-available a 1'''.
#'''silent:''' Contendrá “yes” o “no”. En caso de ser afirmativo la notificación no se mostrará pero si lanzará el evento de la librería push encargado de escuchar si se ha recibido una notificación o no. De ésta manera podremos lanzar notificaciones que no se muestren, pero si hagan algo por detrás en la APP al recibirla. Para el caso de Android solo se usará este campo cuando el '''“type”''' de la notificación sea '''“openAppWithExtras”''' y se haga uso del campo no obligatorio '''“customType”'''. Para el caso de iOs esto generará un alert vació con el '''content-available a 1''' por defecto, pudiendo ser modificado por el siguiente campo que se expone a continuación ( '''silentNumber''' ). Como en el caso de Android esto solo tendrá sentido para las notificaciones de '''“type”''' '''“openAppWithExtras”''' , puesto que al no mostrar nada, se usarán para hacer cosas por detrás mediante los campos no obligatorios '''external1, external2, external3, external4 y external5'''. A diferencia de Android, en iOs se podrá usar con '''”customType”''' o sin el.
#'''silentNumber:''' este campo solo se usará para '''SO iOs'''. Es el número que aparecerá en el '''content-available''' en caso de que el campo '''silent''' sea '''"yes"'''.
#'''customType:''' contendrá el texto del tipo de notificación personalizada que cada uno cree. Éste campo solo se podrá usar si previamente en el campo obligatorio '''“type”''' se ha puesto '''“openAppWithExtras”'''.
#'''badge:''' este campo será el número que se mostrará junto con la notificación en los dispositivos '''SO iOs'''. A partir de iOs 10 las notificaciones '''no''' levantan la aplicación en caso de estar background, por lo que esto generará un '''content-available''' con el fin de despertar la aplicación y poder actualizar el icono de notificaciones pendientes en ésta.
#'''broadcast:''' esta variable solo será útil para dispositivos con '''SO Android''', contendrá el nombre de la clase instanciada en su aplicación para que se active al recibir la notificación.
#'''direct:''' contendra "yes" o "no". En caso de ser afirmativo las notificaciones se enviarán al instante no pudiendo programarlas.
#'''whenSend:''' contendrá “immediately”, “programmatically” o “geolocation”. En caso de ser immediately el campo '''“direct”''' previamente descrito deberá ser '''“yes”'''. En caso de ser “programmatically” o “geolocation” el campo '''“direct”''' previamente descrito deberá ser '''“no”''', ademas el envío se programará según los siguientes campos no obligatorios que se le pase.
#*'''Programmatically:''' cuando la notificación se quiera programar para una fecha en concreto , deberán existir los siguientes campos no obligatorios:
##'''programmaticallyTime:''' contendrá la fecha en '''UNIXTIMESTAMP''' en la que se lanzará la notificación, si se usa este campo no obligatorio no deberemos usar los siguientes.
##'''programmaticallyCronMinutes:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronHours:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronDays:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronMonths:''' ( FUNCIONALIDAD NO DISPONIBLE )
#*'''Geolocation:''' cuando se quiera programar por geolocalización una notificación, deberán existir los siguientes campos no obligatorios:
##'''geolocationCoordinates:''' será un array en el que la posición '''cero''' será la '''latitud''' y la '''uno''' la '''longitud'''.
##'''geolocationMeters:''' contendrá los metros a los que hemos de estar de las coordenadas especificadas para que lance la notificación.
#'''languaje:''' contendrá el idioma del dispositivo. '''Ejemplo: es'''.
#'''country:''' contendrá el país del dispositivo. '''Ejemplo: ES'''.
#'''deviceType:''' contendrá el tipo de dispositivo al que se le mandará la notificación pudiendo ser:
#*'''Para Android:'''
##'''movil'''.
##'''tableta'''.
##'''reloj'''.
##'''tv'''.
#*'''Para iOs:'''
##'''iphone'''.
##'''ipad'''.
##'''iwatch'''.
##'''appletv'''.
#'''appVersion:''' contendrá la versión de la aplicación a la que esta dirigida la notificación. '''Ejemplo: 1.0.1'''.
#'''terminalVersion:''' contendrá la versión del terminal al que ira dirigida la notificación. '''Ejemplo: 6.0.1'''.
#'''urlToOpen:''' contendrá la URL a abrir al hacer click sobre una notificación de tipo '''“openUrl”'''.
#'''external1:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external2:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external3:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external4:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external5:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''androidNotyStyle:''' contendrá '''“bigPictureStyle”''' cuando queramos mostrar una imagen junto con la notificación en los dispositivos con '''SO Android'''. En caso de no querer mostrar ninguna imagen no se utilizara este campo.
#'''bigPictureStyleUrlImage:''' contendrá la URL de la imagen que se quiera mostrar en los dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle"'''. Cabe destacar que la URL deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''bigPictureStyleExpandedTitle:''' contendrá el texto que se mostrará como titulo al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''bigPictureStyleExpandedSumaryText:''' contendrá el texto que se mostrará como mensaje al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''' , siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''extra-content:''' este campo solo se usará para notificaciones dirigidas a dispositivos con '''SO iOs'''. Contendrá la URL del contenido extra que se quiere mostrar junto con la notificación. En este caso y a diferencia de '''Android ( bigPictureStyleUrlImage )''', dicho contenido podrá ser una imagen, un giff, un video o un audio. La URL también deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''channel:''' A partir de Android O, las notificaciones deberán ir por un canal de notificaciones instanciado en su aplicación. Esta variable contendrá el nombre del canal por el que han de salir.
#'''thread-id:''' A partir de iOs 12, las notificaciones pueden ser agrupadas. Para ello deberemos mandar el mismo thread-id en todas las notificaciones que queramos agrupar.

=Notificaciones Android=
En este apartado veremos los distintos tipos de notificaciones para dispositivos Android mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal+IMG';
$arr_data['message'] = 'Mensaje Noti.Normal+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenApp+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp';
$arr_data['message'] = 'Mensaje Noti.OpenApp';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenUrl+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl';
$arr_data['message'] = 'Mensaje Noti.OpenUrl';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir'

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:''' Las notificaciones personalizadas, solo lanzarán la notificación si la APP se encuentra en background, en caso de estar en foreground (primer plano), no lanzará la notificación.
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_a_extras_p.png|center]]
 
                '''Sin notificación:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.Silent';
$arr_data['message'] = 'Mensaje Noti.Silent';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['silent'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin customType:'''
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external1'] = 'variable1';
$arr_data['external3'] = 'variable3';
$arr_data['external5'] = 'variable5';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_auto_generado';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + TipoDispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + TipoDispositivo';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['deviceType'] = 'movil';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionAplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionAplicacion';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['appVersion'] = '1.0';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_auto_generado';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionTerminal';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionTerminal';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['terminalVersion'] = '6.0.1';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Notificaciones iOs=
En este apartado veremos los distintos tipos de notificaciones para dispositivos iOs mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal Imagen';
$arr_data['message'] = 'Mensaje Noti.Normal Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App Con Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir App Con Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App';
$arr_data['message'] = 'Mensaje Noti.Abrir App';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir Url Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url';
$arr_data['message'] = 'Mensaje Noti.Abrir Url';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_eleccion_desarrollador';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_i_extras_p_s.png|center]]
 
            '''Sin customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Tipo Dispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + Tipo Dispositivo';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['deviceType'] = 'iphone';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Aplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Aplicacion';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['appVersion'] = '3.4';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Terminal';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Terminal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['terminalVersion'] = '10.3';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Respuesta setPush=
La respuesta que recibiremos por parte de la API siempre será un JSON. Dicho JSON contendrá de tres a cinco posiciones/elementos:
#'''responsecode:''' determinará si la acción a realizar sobre la API ha funcionado o no. En caso de ser '''negativo''' devolverá '''“KO”''' y en caso de ser '''positivo''' será '''“OK”'''.
#'''errorcode:''' en caso de que el '''responsecode''' sea '''“KO”''', devolverá el código de error en nuestro sistema. Por el contrario, si el '''responsecode''' es '''“OK”''', devolverá un 0.
#'''errortext:''' contendrá el texto del error que se ha producido, por lo que como se deduce esto solo saldrá cuando la acción sobre la API no se haya podido ejecutar.
#'''data:''' contendrá el resultado de la acción realizada satisfactoriamente sobre la API. Si ha habido un error esta posición '''no se generará'''.
#'''timestamp:''' devolverá la fecha en timestamp en la que la acción sobre la API ha sido realizada correctamente. Si ha habido un error esta posición '''no se generará'''.
 
En resumen, si la acción a realizar sobre la API ha dado error, el JSON contendrá los elementos ( responsecode, errorcode y errortext).
 
[[Archivo:Api_exchange_error.png|center]]
 
Por el contrario si la acción ha finalizado correcta y satisfactoriamente, el JSON contendrá los elementos ( responsecode, errorcode, data y timestamp).
Para el caso de crear una notificación ( '''setPush''' ), y que haya funcionado correctamente, en la respuesta se generará algo tal que la siguiente imágen:
 
[[Archivo:Api_exchange_noerror.png|center]]
 
En el contenido del elemento '''data''', se mostrara las notificaciones que se han podido enviar, las que no se han podido enviar, el ID que se genera en nuestro sistema asociado al envío solicitado y un array con los tokens enviados ( '''deletedArray''' ) y un array con los tokens que no se han podido enviar ( '''deletedWithoutSend''' ).
 
Este último caso, el del array con los tokens que no se han podido enviar solo se informará en el caso de que al enviar la acción '''setPush''', en la posición '''terminalTokens''', se mande '''un array con los terminales en concreto que se quieren notificar'''.
 
En el caso del array con los dispositivos notificados, se apreciará una segmentación por '''SO'''. En caso de que uno de estos dispositivos no haya podido recibir la notificación por problemas como bien puede ser un token obsoleto, se borrará de nuestro sistema y el token se informará en la posición ( '''deletedTokens''' ).

=Obtención de usuarios registrados en su aplicación=
Para obtener un conteo de usuarios registrados en nuestra aplicación y los datos de estos, deberemos hacer uso de la tarea '''“getPushTokens”''' y el hash de la aplicación registrada en el panel de Mobeleader. Dicho hash podremos verlo en cualquier momento desde la sección https://panel.mobeleader.com/index.php?sec=6. Una vez obtengamos dicho hash procederemos a conectarnos a la API de la manera expuesta en la a continuación:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';

$json_datos_devueltos = $conexionapi->getData('getPushTokens', $arr_data);
</source>
 
[[Archivo:Api_exchange_getPushTokens.png|center]]
 
Como se puede apreciar en la respuesta, '''la posición respondecode es “OK”'''. Al igual que en el caso del '''“ping”''', siempre que el '''responsecode''' sea '''”OK”''' significara que la acción a realizar sobre la API ha finalizado correctamente y que en la posición '''“data”''' vendrá los solicitado, en este caso los datos de los terminales registrados en la aplicación.

=Borrado de usuarios registrados en su aplicación=
Una vez obtenidos los datos mediante la tarea '''“getPushTokens”''', si quisiéramos borrar alguno de dichos tokens del sistema de Mobeleader, deberemos hacer uso de la tarea '''“deletePushTokens”''' usando el hash de la aplicación de la misma manera que en la obtención de usuarios, y pasándole el token o los tokens que quisiéramos borrar. Lo haremos de la siguiente manera:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['tokens'][] = 'token_del_usuario_registrado';

$json_datos_devueltos = $conexionapi->getData('deletePushTokens', $arr_data);
</source>

 
[[Archivo:Api_exchange_deletePushTokens.png|center]]
 
Como siempre, en caso de que el '''responsecode sea “OK”''', en la '''posición “data”''' veremos el número de tokens borrados.

Docu push exchange

2019-06-07T11:19:29Z

Deneb: /* Campos Obligatorios y No Obligatorios para las notificaciones */

=Introducción=
En este documento se va a mostrar como ha de ser el contenido que se mande al api-exchange 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 poder realizar la conexión a nuestro sistema. 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”'''.
 
<source lang="PHP">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$json_datos_devueltos = $conexionapi->getData('ping');
</source>

[[Archivo:Conexion_ping.png|center]]
 
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 sistema operativo al que vaya la notificación, hay unos campos que '''son obligatorios'''; son los siguientes:
#'''appHash:''' contendrá el hash de la aplicación registrada, automáticamente generado por nuestro panel.
#'''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:
##'''all:''' En este caso se notificará a todos los dispositivos que estén registrados en la aplicación sin tener en cuenta el SO.
##'''onlyAndroid:''' Solo se notificará a los terminales con '''SO Android''' que estén registrados en la aplicación.
##'''onlyIOS:''' Solo se notificará a los terminales con '''SO IOs''' que estén registrados en la aplicación.
##'''Un token de un dispositivo en concreto,''' de manera que solo se le notifique a éste.
#'''message:''' contendrá el texto de la notificación.
#'''type:''' contendrá el tipo de notificación pudiendo ser este de de diversa índole.
#*'''normal:''' este tipo será el más común, el dispositivo recibirá la notificación y no se hará mas con ésta.
#*'''openApp:''' este tipo hará que al hacer click sobre la notificación se abra la aplicación encargada de mostrar dicha notificación.
#*'''openUrl:''' este tipo hará que al hacer click sobre la notificación se abra una URL especificada en otro campo que veremos más adelante.
#*'''openAppWithextras:''' este tipo hará lo mismo que el '''“openApp”''' pudiendo ademas añadir hasta cinco variables extra para poder tratarlas a nuestro gusto en la aplicación. Cabe destacar que este tipo de notificación, nos permitirá hacer uso de otro campo no obligatorio que más adelante trataremos, el cual se llama '''"customType”''' y nos permitirá lanzar notificaciones '''“personalizadas”'''.
 
Una vez vistos los campos obligatorios, a continuación se expondrán todos los '''campos no obligatorios''' que darán forma a las notificaciones:
#'''tittle:''' contendrá el texto del título que se mostrara junto con el mensaje de la notificación.
#'''sendingId:''' en caso de querer lanzar una notificación para muchos terminales, como hemos expuesto en los campos obligatorios, inicialmente el campo '''”terminalTokens"''' deberá ser un array con dichos terminales. Debido a que la API no puede admitir un número ilimitado de tokens a la vez, deberemos '''segmentar''' dicho array en varios más pequeños y hacer tantos '''“setPush”''' como sean necesarios hasta finalizar con el número de dispositivos a notificar. Cada vez que nos conectemos a la API para hacer un '''“setPush”''' y generar una notificación, dicha conexión nos devolverá un JSON en el cual hay un campo denominado '''“sendingId”''' con el ID autonumérico generado en nuestro sistema para ese envío push. De ésta manera, si se recoge dicho ID y se pasa como campo en la posición '''“sendingId”''', los siguientes tokens que se manden en el '''”terminalTokens”''' irán asociados al primer envío realizado.
#'''sandbox:''' este campo solo se usará cuando se vaya a notificar a algún dispositivo con '''SO iOs'''. Contendrá “yes” en caso de que dicho dispositivo este en el servidor de desarrollo de Apple, y un “no” en caso de que dicho dispositivo este en el servidor de producción de Apple.
#'''isTest:''' al igual que en el campo del '''“sandbox”''', contendrá “yes” o “no” dependiendo de si el dispositivo esta en el servidor de desarrollo o el de producción de Apple.
#'''background:''' este campo solo irá en caso de ir a algún dispositivo que tenga '''SO iOs'''. Contendrá “yes” o “no”. En caso de ser afirmativo la notificación se mostrará sin hacer ruido ni vibrar. Para el caso de iOs esto generará un alert vació con el '''content-available a 1'''.
#'''silent:''' Contendrá “yes” o “no”. En caso de ser afirmativo la notificación no se mostrará pero si lanzará el evento de la librería push encargado de escuchar si se ha recibido una notificación o no. De ésta manera podremos lanzar notificaciones que no se muestren, pero si hagan algo por detrás en la APP al recibirla. Para el caso de Android solo se usará este campo cuando el '''“type”''' de la notificación sea '''“openAppWithExtras”''' y se haga uso del campo no obligatorio '''“customType”'''. Para el caso de iOs esto generará un alert vació con el '''content-available a 1''' por defecto, pudiendo ser modificado por el siguiente campo que se expone a continuación ( '''silentNumber''' ). Como en el caso de Android esto solo tendrá sentido para las notificaciones de '''“type”''' '''“openAppWithExtras”''' , puesto que al no mostrar nada, se usarán para hacer cosas por detrás mediante los campos no obligatorios '''external1, external2, external3, external4 y external5'''. A diferencia de Android, en iOs se podrá usar con '''”customType”''' o sin el.
#'''silentNumber:''' este campo solo se usará para '''SO iOs'''. Es el número que aparecerá en el '''content-available''' en caso de que el campo '''silent''' sea '''"yes"'''.
#'''customType:''' contendrá el texto del tipo de notificación personalizada que cada uno cree. Éste campo solo se podrá usar si previamente en el campo obligatorio '''“type”''' se ha puesto '''“openAppWithExtras”'''.
#'''badge:''' este campo será el número que se mostrará junto con la notificación en los dispositivos '''SO iOs'''. A partir de iOs 10 las notificaciones '''no''' levantan la aplicación en caso de estar background, por lo que esto generará un '''content-available''' con el fin de despertar la aplicación y poder actualizar el icono de notificaciones pendientes en ésta.
#'''broadcast:''' esta variable solo será útil para dispositivos con '''SO Android''', contendrá el nombre de la clase instanciada en su aplicación para que se active al recibir la notificación.
#'''direct:''' contendra "yes" o "no". En caso de ser afirmativo las notificaciones se enviarán al instante no pudiendo programarlas.
#'''whenSend:''' contendrá “immediately”, “programmatically” o “geolocation”. En caso de ser immediately el campo '''“direct”''' previamente descrito deberá ser '''“yes”'''. En caso de ser “programmatically” o “geolocation” el campo '''“direct”''' previamente descrito deberá ser '''“no”''', ademas el envío se programará según los siguientes campos no obligatorios que se le pase.
#*'''Programmatically:''' cuando la notificación se quiera programar para una fecha en concreto , deberán existir los siguientes campos no obligatorios:
##'''programmaticallyTime:''' contendrá la fecha en '''UNIXTIMESTAMP''' en la que se lanzará la notificación, si se usa este campo no obligatorio no deberemos usar los siguientes.
##'''programmaticallyCronMinutes:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronHours:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronDays:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronMonths:''' ( FUNCIONALIDAD NO DISPONIBLE )
#*'''Geolocation:''' cuando se quiera programar por geolocalización una notificación, deberán existir los siguientes campos no obligatorios:
##'''geolocationCoordinates:''' será un array en el que la posición '''cero''' será la '''latitud''' y la '''uno''' la '''longitud'''.
##'''geolocationMeters:''' contendrá los metros a los que hemos de estar de las coordenadas especificadas para que lance la notificación.
#'''languaje:''' contendrá el idioma del dispositivo. '''Ejemplo: es'''.
#'''country:''' contendrá el país del dispositivo. '''Ejemplo: ES'''.
#'''deviceType:''' contendrá el tipo de dispositivo al que se le mandará la notificación pudiendo ser:
#*'''Para Android:'''
##'''movil'''.
##'''tableta'''.
##'''reloj'''.
##'''tv'''.
#*'''Para iOs:'''
##'''iphone'''.
##'''ipad'''.
##'''iwatch'''.
##'''appletv'''.
#'''appVersion:''' contendrá la versión de la aplicación a la que esta dirigida la notificación. '''Ejemplo: 1.0.1'''.
#'''terminalVersion:''' contendrá la versión del terminal al que ira dirigida la notificación. '''Ejemplo: 6.0.1'''.
#'''urlToOpen:''' contendrá la URL a abrir al hacer click sobre una notificación de tipo '''“openUrl”'''.
#'''external1:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external2:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external3:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external4:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external5:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''androidNotyStyle:''' contendrá '''“bigPictureStyle”''' cuando queramos mostrar una imagen junto con la notificación en los dispositivos con '''SO Android'''. En caso de no querer mostrar ninguna imagen no se utilizara este campo.
#'''bigPictureStyleUrlImage:''' contendrá la URL de la imagen que se quiera mostrar en los dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle"'''. Cabe destacar que la URL deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''bigPictureStyleExpandedTitle:''' contendrá el texto que se mostrará como titulo al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''bigPictureStyleExpandedSumaryText:''' contendrá el texto que se mostrará como mensaje al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''' , siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''extra-content:''' este campo solo se usará para notificaciones dirigidas a dispositivos con '''SO iOs'''. Contendrá la URL del contenido extra que se quiere mostrar junto con la notificación. En este caso y a diferencia de '''Android ( bigPictureStyleUrlImage )''', dicho contenido podrá ser una imagen, un giff, un video o un audio. La URL también deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''channel:''' A partir de Android O, las notificaciones deberán ir por un canal de notificaciones instanciado en su aplicación. Esta variable contendrá el nombre del canal por el que han de salir.
#'''thread-id:''' A partir de iOs 12, las notificaciones pueden ser agrupadas. Para ello deberemos mandar el mismo thread-id en todas las notificaciones que queramos agrupar.

=Notificaciones Android=
En este apartado veremos los distintos tipos de notificaciones para dispositivos Android mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal+IMG';
$arr_data['message'] = 'Mensaje Noti.Normal+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenApp+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp';
$arr_data['message'] = 'Mensaje Noti.OpenApp';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenUrl+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl';
$arr_data['message'] = 'Mensaje Noti.OpenUrl';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir'

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:''' Las notificaciones personalizadas, solo lanzarán la notificación si la APP se encuentra en background, en caso de estar en foreground (primer plano), no lanzará la notificación.
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_a_extras_p.png|center]]
 
                '''Sin notificación:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.Silent';
$arr_data['message'] = 'Mensaje Noti.Silent';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['silent'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin customType:'''
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external1'] = 'variable1';
$arr_data['external3'] = 'variable3';
$arr_data['external5'] = 'variable5';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + TipoDispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + TipoDispositivo';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['deviceType'] = 'movil';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionAplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionAplicacion';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['appVersion'] = '1.0';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionTerminal';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionTerminal';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['terminalVersion'] = '6.0.1';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Notificaciones iOs=
En este apartado veremos los distintos tipos de notificaciones para dispositivos iOs mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal Imagen';
$arr_data['message'] = 'Mensaje Noti.Normal Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App Con Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir App Con Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App';
$arr_data['message'] = 'Mensaje Noti.Abrir App';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir Url Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url';
$arr_data['message'] = 'Mensaje Noti.Abrir Url';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_eleccion_desarrollador';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_i_extras_p_s.png|center]]
 
            '''Sin customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Tipo Dispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + Tipo Dispositivo';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['deviceType'] = 'iphone';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Aplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Aplicacion';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['appVersion'] = '3.4';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Terminal';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Terminal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['terminalVersion'] = '10.3';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Respuesta setPush=
La respuesta que recibiremos por parte de la API siempre será un JSON. Dicho JSON contendrá de tres a cinco posiciones/elementos:
#'''responsecode:''' determinará si la acción a realizar sobre la API ha funcionado o no. En caso de ser '''negativo''' devolverá '''“KO”''' y en caso de ser '''positivo''' será '''“OK”'''.
#'''errorcode:''' en caso de que el '''responsecode''' sea '''“KO”''', devolverá el código de error en nuestro sistema. Por el contrario, si el '''responsecode''' es '''“OK”''', devolverá un 0.
#'''errortext:''' contendrá el texto del error que se ha producido, por lo que como se deduce esto solo saldrá cuando la acción sobre la API no se haya podido ejecutar.
#'''data:''' contendrá el resultado de la acción realizada satisfactoriamente sobre la API. Si ha habido un error esta posición '''no se generará'''.
#'''timestamp:''' devolverá la fecha en timestamp en la que la acción sobre la API ha sido realizada correctamente. Si ha habido un error esta posición '''no se generará'''.
 
En resumen, si la acción a realizar sobre la API ha dado error, el JSON contendrá los elementos ( responsecode, errorcode y errortext).
 
[[Archivo:Api_exchange_error.png|center]]
 
Por el contrario si la acción ha finalizado correcta y satisfactoriamente, el JSON contendrá los elementos ( responsecode, errorcode, data y timestamp).
Para el caso de crear una notificación ( '''setPush''' ), y que haya funcionado correctamente, en la respuesta se generará algo tal que la siguiente imágen:
 
[[Archivo:Api_exchange_noerror.png|center]]
 
En el contenido del elemento '''data''', se mostrara las notificaciones que se han podido enviar, las que no se han podido enviar, el ID que se genera en nuestro sistema asociado al envío solicitado y un array con los tokens enviados ( '''deletedArray''' ) y un array con los tokens que no se han podido enviar ( '''deletedWithoutSend''' ).
 
Este último caso, el del array con los tokens que no se han podido enviar solo se informará en el caso de que al enviar la acción '''setPush''', en la posición '''terminalTokens''', se mande '''un array con los terminales en concreto que se quieren notificar'''.
 
En el caso del array con los dispositivos notificados, se apreciará una segmentación por '''SO'''. En caso de que uno de estos dispositivos no haya podido recibir la notificación por problemas como bien puede ser un token obsoleto, se borrará de nuestro sistema y el token se informará en la posición ( '''deletedTokens''' ).

=Obtención de usuarios registrados en su aplicación=
Para obtener un conteo de usuarios registrados en nuestra aplicación y los datos de estos, deberemos hacer uso de la tarea '''“getPushTokens”''' y el hash de la aplicación registrada en el panel de Mobeleader. Dicho hash podremos verlo en cualquier momento desde la sección https://panel.mobeleader.com/index.php?sec=6. Una vez obtengamos dicho hash procederemos a conectarnos a la API de la manera expuesta en la a continuación:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';

$json_datos_devueltos = $conexionapi->getData('getPushTokens', $arr_data);
</source>
 
[[Archivo:Api_exchange_getPushTokens.png|center]]
 
Como se puede apreciar en la respuesta, '''la posición respondecode es “OK”'''. Al igual que en el caso del '''“ping”''', siempre que el '''responsecode''' sea '''”OK”''' significara que la acción a realizar sobre la API ha finalizado correctamente y que en la posición '''“data”''' vendrá los solicitado, en este caso los datos de los terminales registrados en la aplicación.

=Borrado de usuarios registrados en su aplicación=
Una vez obtenidos los datos mediante la tarea '''“getPushTokens”''', si quisiéramos borrar alguno de dichos tokens del sistema de Mobeleader, deberemos hacer uso de la tarea '''“deletePushTokens”''' usando el hash de la aplicación de la misma manera que en la obtención de usuarios, y pasándole el token o los tokens que quisiéramos borrar. Lo haremos de la siguiente manera:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['tokens'][] = 'token_del_usuario_registrado';

$json_datos_devueltos = $conexionapi->getData('deletePushTokens', $arr_data);
</source>

 
[[Archivo:Api_exchange_deletePushTokens.png|center]]
 
Como siempre, en caso de que el '''responsecode sea “OK”''', en la '''posición “data”''' veremos el número de tokens borrados.

Docu push exchange

2019-06-07T11:15:56Z

Deneb: /* Conectándonos a la API */

=Introducción=
En este documento se va a mostrar como ha de ser el contenido que se mande al api-exchange 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 poder realizar la conexión a nuestro sistema. 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”'''.
 
<source lang="PHP">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$json_datos_devueltos = $conexionapi->getData('ping');
</source>

[[Archivo:Conexion_ping.png|center]]
 
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:
##'''all:''' En este caso se notificará a todos los dispositivos que estén registrados en la aplicación sin tener en cuenta el SO.
##'''onlyAndroid:''' Solo se notificará a los terminales con '''SO Android''' que estén registrados en la aplicación.
##'''onlyIOS:''' Solo se notificará a los terminales con '''SO IOs''' que estén registrados en la aplicación.
##'''Un token de un dispositivo en concreto,''' de manera que solo se le notifique a éste.
#'''message:''' contendrá el texto de la notificación.
#'''type:''' contendrá el tipo de notificación pudiendo ser este de de diversa índole.
#*'''normal:''' este tipo será el más común, el dispositivo recibirá la notificación y no se hará mas con ésta.
#*'''openApp:''' este tipo hará que al hacer click sobre la notificación se abra la aplicación encargada de mostrar dicha notificación.
#*'''openUrl:''' este tipo hará que al hacer click sobre la notificación se abra una URL especificada en otro campo que veremos más adelante.
#*'''openAppWithextras:''' este tipo hará lo mismo que el '''“openApp”''' pudiendo ademas añadir hasta cinco variables extra para poder tratarlas a nuestro gusto en la aplicación. Cabe destacar que este tipo de notificación, nos permitirá hacer uso de otro campo no obligatorio que más adelante trataremos, el cual se llama '''"customType”''' y nos permitirá lanzar notificaciones '''“personalizadas”'''.
 
Una vez vistos los campos obligatorios, a continuación se expondrán todos los '''campos no obligatorios''' que darán forma a las notificaciones:
#'''tittle:''' contendrá el texto del título que se mostrara junto con el mensaje de la notificación.
#'''sendingId:''' en caso de querer lanzar una notificación para muchos terminales, como hemos expuesto en los campos obligatorios, inicialmente el campo '''”terminalTokens"''' deberá ser un array con dichos terminales. Debido a que la API no puede admitir un número ilimitado de tokens a la vez, deberemos '''segmentar''' dicho array en varios más pequeños y hacer tantos '''“setPush”''' como sean necesarios hasta finalizar con el número de dispositivos a notificar. Cada vez que nos conectemos a la API para hacer un '''“setPush”''' y generar una notificación, dicha conexión nos devolverá un JSON en el cual hay un campo denominado '''“sendingId”''' con el ID autonumérico generado en nuestro sistema para ese envío push. De ésta manera, si se recoge dicho ID y se pasa como campo en la posición '''“sendingId”''', los siguientes tokens que se manden en el '''”terminalTokens”''' irán asociados al primer envío realizado.
#'''sandbox:''' este campo solo se usará cuando se vaya a notificar a algún dispositivo con '''SO iOs'''. Contendrá “yes” en caso de que dicho dispositivo este en el servidor de desarrollo de Apple, y un “no” en caso de que dicho dispositivo este en el servidor de producción de Apple.
#'''isTest:''' al igual que en el campo del '''“sandbox”''', contendrá “yes” o “no” dependiendo de si el dispositivo esta en el servidor de desarrollo o el de producción de Apple.
#'''background:''' este campo solo irá en caso de ir a algún dispositivo que tenga '''SO iOs'''. Contendrá “yes” o “no”. En caso de ser afirmativo la notificación se mostrará sin hacer ruido ni vibrar. Para el caso de iOs esto generará un alert vació con el '''content-available a 1'''.
#'''silent:''' Contendrá “yes” o “no”. En caso de ser afirmativo la notificación no se mostrará pero si lanzará el evento de la librería push encargado de escuchar si se ha recibido una notificación o no. De ésta manera podremos lanzar notificaciones que no se muestren, pero si hagan algo por detrás en la APP al recibirla. Para el caso de Android solo se usará este campo cuando el '''“type”''' de la notificación sea '''“openAppWithExtras”''' y se haga uso del campo no obligatorio '''“customType”'''. Para el caso de iOs esto generará un alert vació con el '''content-available a 1''' por defecto, pudiendo ser modificado por el siguiente campo que se expone a continuación ( '''silentNumber''' ). Como en el caso de Android esto solo tendrá sentido para las notificaciones de '''“type”''' '''“openAppWithExtras”''' , puesto que al no mostrar nada, se usarán para hacer cosas por detrás mediante los campos no obligatorios '''external1, external2, external3, external4 y external5'''. A diferencia de Android, en iOs se podrá usar con '''”customType”''' o sin el.
#'''silentNumber:''' este campo solo se usará para '''SO iOs'''. Es el número que aparecerá en el '''content-available''' en caso de que el campo '''silent''' sea '''"yes"'''.
#'''customType:''' contendrá el texto del tipo de notificación personalizada que cada uno cree. Éste campo solo se podrá usar si previamente en el campo obligatorio '''“type”''' se ha puesto '''“openAppWithExtras”'''.
#'''badge:''' este campo será el número que se mostrará junto con la notificación en los dispositivos '''SO iOs'''. A partir de iOs 10 las notificaciones '''no''' levantan la aplicación en caso de estar background, por lo que esto generará un '''content-available''' con el fin de despertar la aplicación y poder actualizar el icono de notificaciones pendientes en ésta.
#'''broadcast:''' esta variable solo será útil para dispositivos con '''SO Android''', contendrá el nombre de la clase instanciada en su aplicación para que se active al recibir la notificación.
#'''direct:''' contendra "yes" o "no". En caso de ser afirmativo las notificaciones se enviarán al instante no pudiendo programarlas.
#'''whenSend:''' contendrá “immediately”, “programmatically” o “geolocation”. En caso de ser immediately el campo '''“direct”''' previamente descrito deberá ser '''“yes”'''. En caso de ser “programmatically” o “geolocation” el campo '''“direct”''' previamente descrito deberá ser '''“no”''', ademas el envío se programará según los siguientes campos no obligatorios que se le pase.
#*'''Programmatically:''' cuando la notificación se quiera programar para una fecha en concreto , deberán existir los siguientes campos no obligatorios:
##'''programmaticallyTime:''' contendrá la fecha en '''UNIXTIMESTAMP''' en la que se lanzará la notificación, si se usa este campo no obligatorio no deberemos usar los siguientes.
##'''programmaticallyCronMinutes:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronHours:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronDays:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronMonths:''' ( FUNCIONALIDAD NO DISPONIBLE )
#*'''Geolocation:''' cuando se quiera programar por geolocalización una notificación, deberán existir los siguientes campos no obligatorios:
##'''geolocationCoordinates:''' será un array en el que la posición '''cero''' será la '''latitud''' y la '''uno''' la '''longitud'''.
##'''geolocationMeters:''' contendrá los metros a los que hemos de estar de las coordenadas especificadas para que lance la notificación.
#'''languaje:''' contendrá el idioma del dispositivo. '''Ejemplo: es'''.
#'''country:''' contendrá el país del dispositivo. '''Ejemplo: ES'''.
#'''deviceType:''' contendrá el tipo de dispositivo al que se le mandará la notificación pudiendo ser:
#*'''Para Android:'''
##'''movil'''.
##'''tableta'''.
##'''reloj'''.
##'''tv'''.
#*'''Para iOs:'''
##'''iphone'''.
##'''ipad'''.
##'''iwatch'''.
##'''appletv'''.
#'''appVersion:''' contendrá la versión de la aplicación a la que esta dirigida la notificación. '''Ejemplo: 1.0.1'''.
#'''terminalVersion:''' contendrá la versión del terminal al que ira dirigida la notificación. '''Ejemplo: 6.0.1'''.
#'''urlToOpen:''' contendrá la URL a abrir al hacer click sobre una notificación de tipo '''“openUrl”'''.
#'''external1:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external2:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external3:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external4:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external5:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''androidNotyStyle:''' contendrá '''“bigPictureStyle”''' cuando queramos mostrar una imagen junto con la notificación en los dispositivos con '''SO Android'''. En caso de no querer mostrar ninguna imagen no se utilizara este campo.
#'''bigPictureStyleUrlImage:''' contendrá la URL de la imagen que se quiera mostrar en los dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle"'''. Cabe destacar que la URL deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''bigPictureStyleExpandedTitle:''' contendrá el texto que se mostrará como titulo al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''bigPictureStyleExpandedSumaryText:''' contendrá el texto que se mostrará como mensaje al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''' , siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''extra-content:''' este campo solo se usará para notificaciones dirigidas a dispositivos con '''SO iOs'''. Contendrá la URL del contenido extra que se quiere mostrar junto con la notificación. En este caso y a diferencia de '''Android ( bigPictureStyleUrlImage )''', dicho contenido podrá ser una imagen, un giff, un video o un audio. La URL también deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''channel:''' A partir de Android O, las notificaciones deberán ir por un canal de notificaciones instanciado en su aplicación. Esta variable contendrá el nombre del canal por el que han de salir.
#'''thread-id:''' A partir de iOs 12, las notificaciones pueden ser agrupadas. Para ello deberemos mandar el mismo thread-id en todas las notificaciones que queramos agrupar.

=Notificaciones Android=
En este apartado veremos los distintos tipos de notificaciones para dispositivos Android mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal+IMG';
$arr_data['message'] = 'Mensaje Noti.Normal+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenApp+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp';
$arr_data['message'] = 'Mensaje Noti.OpenApp';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenUrl+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl';
$arr_data['message'] = 'Mensaje Noti.OpenUrl';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir'

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:''' Las notificaciones personalizadas, solo lanzarán la notificación si la APP se encuentra en background, en caso de estar en foreground (primer plano), no lanzará la notificación.
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_a_extras_p.png|center]]
 
                '''Sin notificación:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.Silent';
$arr_data['message'] = 'Mensaje Noti.Silent';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['silent'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin customType:'''
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external1'] = 'variable1';
$arr_data['external3'] = 'variable3';
$arr_data['external5'] = 'variable5';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + TipoDispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + TipoDispositivo';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['deviceType'] = 'movil';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionAplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionAplicacion';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['appVersion'] = '1.0';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionTerminal';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionTerminal';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['terminalVersion'] = '6.0.1';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Notificaciones iOs=
En este apartado veremos los distintos tipos de notificaciones para dispositivos iOs mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal Imagen';
$arr_data['message'] = 'Mensaje Noti.Normal Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App Con Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir App Con Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App';
$arr_data['message'] = 'Mensaje Noti.Abrir App';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir Url Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url';
$arr_data['message'] = 'Mensaje Noti.Abrir Url';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_eleccion_desarrollador';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_i_extras_p_s.png|center]]
 
            '''Sin customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Tipo Dispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + Tipo Dispositivo';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['deviceType'] = 'iphone';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Aplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Aplicacion';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['appVersion'] = '3.4';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Terminal';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Terminal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['terminalVersion'] = '10.3';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Respuesta setPush=
La respuesta que recibiremos por parte de la API siempre será un JSON. Dicho JSON contendrá de tres a cinco posiciones/elementos:
#'''responsecode:''' determinará si la acción a realizar sobre la API ha funcionado o no. En caso de ser '''negativo''' devolverá '''“KO”''' y en caso de ser '''positivo''' será '''“OK”'''.
#'''errorcode:''' en caso de que el '''responsecode''' sea '''“KO”''', devolverá el código de error en nuestro sistema. Por el contrario, si el '''responsecode''' es '''“OK”''', devolverá un 0.
#'''errortext:''' contendrá el texto del error que se ha producido, por lo que como se deduce esto solo saldrá cuando la acción sobre la API no se haya podido ejecutar.
#'''data:''' contendrá el resultado de la acción realizada satisfactoriamente sobre la API. Si ha habido un error esta posición '''no se generará'''.
#'''timestamp:''' devolverá la fecha en timestamp en la que la acción sobre la API ha sido realizada correctamente. Si ha habido un error esta posición '''no se generará'''.
 
En resumen, si la acción a realizar sobre la API ha dado error, el JSON contendrá los elementos ( responsecode, errorcode y errortext).
 
[[Archivo:Api_exchange_error.png|center]]
 
Por el contrario si la acción ha finalizado correcta y satisfactoriamente, el JSON contendrá los elementos ( responsecode, errorcode, data y timestamp).
Para el caso de crear una notificación ( '''setPush''' ), y que haya funcionado correctamente, en la respuesta se generará algo tal que la siguiente imágen:
 
[[Archivo:Api_exchange_noerror.png|center]]
 
En el contenido del elemento '''data''', se mostrara las notificaciones que se han podido enviar, las que no se han podido enviar, el ID que se genera en nuestro sistema asociado al envío solicitado y un array con los tokens enviados ( '''deletedArray''' ) y un array con los tokens que no se han podido enviar ( '''deletedWithoutSend''' ).
 
Este último caso, el del array con los tokens que no se han podido enviar solo se informará en el caso de que al enviar la acción '''setPush''', en la posición '''terminalTokens''', se mande '''un array con los terminales en concreto que se quieren notificar'''.
 
En el caso del array con los dispositivos notificados, se apreciará una segmentación por '''SO'''. En caso de que uno de estos dispositivos no haya podido recibir la notificación por problemas como bien puede ser un token obsoleto, se borrará de nuestro sistema y el token se informará en la posición ( '''deletedTokens''' ).

=Obtención de usuarios registrados en su aplicación=
Para obtener un conteo de usuarios registrados en nuestra aplicación y los datos de estos, deberemos hacer uso de la tarea '''“getPushTokens”''' y el hash de la aplicación registrada en el panel de Mobeleader. Dicho hash podremos verlo en cualquier momento desde la sección https://panel.mobeleader.com/index.php?sec=6. Una vez obtengamos dicho hash procederemos a conectarnos a la API de la manera expuesta en la a continuación:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';

$json_datos_devueltos = $conexionapi->getData('getPushTokens', $arr_data);
</source>
 
[[Archivo:Api_exchange_getPushTokens.png|center]]
 
Como se puede apreciar en la respuesta, '''la posición respondecode es “OK”'''. Al igual que en el caso del '''“ping”''', siempre que el '''responsecode''' sea '''”OK”''' significara que la acción a realizar sobre la API ha finalizado correctamente y que en la posición '''“data”''' vendrá los solicitado, en este caso los datos de los terminales registrados en la aplicación.

=Borrado de usuarios registrados en su aplicación=
Una vez obtenidos los datos mediante la tarea '''“getPushTokens”''', si quisiéramos borrar alguno de dichos tokens del sistema de Mobeleader, deberemos hacer uso de la tarea '''“deletePushTokens”''' usando el hash de la aplicación de la misma manera que en la obtención de usuarios, y pasándole el token o los tokens que quisiéramos borrar. Lo haremos de la siguiente manera:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['tokens'][] = 'token_del_usuario_registrado';

$json_datos_devueltos = $conexionapi->getData('deletePushTokens', $arr_data);
</source>

 
[[Archivo:Api_exchange_deletePushTokens.png|center]]
 
Como siempre, en caso de que el '''responsecode sea “OK”''', en la '''posición “data”''' veremos el número de tokens borrados.

Docu push exchange

2019-06-07T11:03:24Z

Deneb: /* Introducción */

=Introducción=
En este documento se va a mostrar como ha de ser el contenido que se mande al api-exchange 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”'''.
 
<source lang="PHP">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$json_datos_devueltos = $conexionapi->getData('ping');
</source>

[[Archivo:Conexion_ping.png|center]]
 
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:
##'''all:''' En este caso se notificará a todos los dispositivos que estén registrados en la aplicación sin tener en cuenta el SO.
##'''onlyAndroid:''' Solo se notificará a los terminales con '''SO Android''' que estén registrados en la aplicación.
##'''onlyIOS:''' Solo se notificará a los terminales con '''SO IOs''' que estén registrados en la aplicación.
##'''Un token de un dispositivo en concreto,''' de manera que solo se le notifique a éste.
#'''message:''' contendrá el texto de la notificación.
#'''type:''' contendrá el tipo de notificación pudiendo ser este de de diversa índole.
#*'''normal:''' este tipo será el más común, el dispositivo recibirá la notificación y no se hará mas con ésta.
#*'''openApp:''' este tipo hará que al hacer click sobre la notificación se abra la aplicación encargada de mostrar dicha notificación.
#*'''openUrl:''' este tipo hará que al hacer click sobre la notificación se abra una URL especificada en otro campo que veremos más adelante.
#*'''openAppWithextras:''' este tipo hará lo mismo que el '''“openApp”''' pudiendo ademas añadir hasta cinco variables extra para poder tratarlas a nuestro gusto en la aplicación. Cabe destacar que este tipo de notificación, nos permitirá hacer uso de otro campo no obligatorio que más adelante trataremos, el cual se llama '''"customType”''' y nos permitirá lanzar notificaciones '''“personalizadas”'''.
 
Una vez vistos los campos obligatorios, a continuación se expondrán todos los '''campos no obligatorios''' que darán forma a las notificaciones:
#'''tittle:''' contendrá el texto del título que se mostrara junto con el mensaje de la notificación.
#'''sendingId:''' en caso de querer lanzar una notificación para muchos terminales, como hemos expuesto en los campos obligatorios, inicialmente el campo '''”terminalTokens"''' deberá ser un array con dichos terminales. Debido a que la API no puede admitir un número ilimitado de tokens a la vez, deberemos '''segmentar''' dicho array en varios más pequeños y hacer tantos '''“setPush”''' como sean necesarios hasta finalizar con el número de dispositivos a notificar. Cada vez que nos conectemos a la API para hacer un '''“setPush”''' y generar una notificación, dicha conexión nos devolverá un JSON en el cual hay un campo denominado '''“sendingId”''' con el ID autonumérico generado en nuestro sistema para ese envío push. De ésta manera, si se recoge dicho ID y se pasa como campo en la posición '''“sendingId”''', los siguientes tokens que se manden en el '''”terminalTokens”''' irán asociados al primer envío realizado.
#'''sandbox:''' este campo solo se usará cuando se vaya a notificar a algún dispositivo con '''SO iOs'''. Contendrá “yes” en caso de que dicho dispositivo este en el servidor de desarrollo de Apple, y un “no” en caso de que dicho dispositivo este en el servidor de producción de Apple.
#'''isTest:''' al igual que en el campo del '''“sandbox”''', contendrá “yes” o “no” dependiendo de si el dispositivo esta en el servidor de desarrollo o el de producción de Apple.
#'''background:''' este campo solo irá en caso de ir a algún dispositivo que tenga '''SO iOs'''. Contendrá “yes” o “no”. En caso de ser afirmativo la notificación se mostrará sin hacer ruido ni vibrar. Para el caso de iOs esto generará un alert vació con el '''content-available a 1'''.
#'''silent:''' Contendrá “yes” o “no”. En caso de ser afirmativo la notificación no se mostrará pero si lanzará el evento de la librería push encargado de escuchar si se ha recibido una notificación o no. De ésta manera podremos lanzar notificaciones que no se muestren, pero si hagan algo por detrás en la APP al recibirla. Para el caso de Android solo se usará este campo cuando el '''“type”''' de la notificación sea '''“openAppWithExtras”''' y se haga uso del campo no obligatorio '''“customType”'''. Para el caso de iOs esto generará un alert vació con el '''content-available a 1''' por defecto, pudiendo ser modificado por el siguiente campo que se expone a continuación ( '''silentNumber''' ). Como en el caso de Android esto solo tendrá sentido para las notificaciones de '''“type”''' '''“openAppWithExtras”''' , puesto que al no mostrar nada, se usarán para hacer cosas por detrás mediante los campos no obligatorios '''external1, external2, external3, external4 y external5'''. A diferencia de Android, en iOs se podrá usar con '''”customType”''' o sin el.
#'''silentNumber:''' este campo solo se usará para '''SO iOs'''. Es el número que aparecerá en el '''content-available''' en caso de que el campo '''silent''' sea '''"yes"'''.
#'''customType:''' contendrá el texto del tipo de notificación personalizada que cada uno cree. Éste campo solo se podrá usar si previamente en el campo obligatorio '''“type”''' se ha puesto '''“openAppWithExtras”'''.
#'''badge:''' este campo será el número que se mostrará junto con la notificación en los dispositivos '''SO iOs'''. A partir de iOs 10 las notificaciones '''no''' levantan la aplicación en caso de estar background, por lo que esto generará un '''content-available''' con el fin de despertar la aplicación y poder actualizar el icono de notificaciones pendientes en ésta.
#'''broadcast:''' esta variable solo será útil para dispositivos con '''SO Android''', contendrá el nombre de la clase instanciada en su aplicación para que se active al recibir la notificación.
#'''direct:''' contendra "yes" o "no". En caso de ser afirmativo las notificaciones se enviarán al instante no pudiendo programarlas.
#'''whenSend:''' contendrá “immediately”, “programmatically” o “geolocation”. En caso de ser immediately el campo '''“direct”''' previamente descrito deberá ser '''“yes”'''. En caso de ser “programmatically” o “geolocation” el campo '''“direct”''' previamente descrito deberá ser '''“no”''', ademas el envío se programará según los siguientes campos no obligatorios que se le pase.
#*'''Programmatically:''' cuando la notificación se quiera programar para una fecha en concreto , deberán existir los siguientes campos no obligatorios:
##'''programmaticallyTime:''' contendrá la fecha en '''UNIXTIMESTAMP''' en la que se lanzará la notificación, si se usa este campo no obligatorio no deberemos usar los siguientes.
##'''programmaticallyCronMinutes:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronHours:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronDays:''' ( FUNCIONALIDAD NO DISPONIBLE )
##'''programmaticallyCronMonths:''' ( FUNCIONALIDAD NO DISPONIBLE )
#*'''Geolocation:''' cuando se quiera programar por geolocalización una notificación, deberán existir los siguientes campos no obligatorios:
##'''geolocationCoordinates:''' será un array en el que la posición '''cero''' será la '''latitud''' y la '''uno''' la '''longitud'''.
##'''geolocationMeters:''' contendrá los metros a los que hemos de estar de las coordenadas especificadas para que lance la notificación.
#'''languaje:''' contendrá el idioma del dispositivo. '''Ejemplo: es'''.
#'''country:''' contendrá el país del dispositivo. '''Ejemplo: ES'''.
#'''deviceType:''' contendrá el tipo de dispositivo al que se le mandará la notificación pudiendo ser:
#*'''Para Android:'''
##'''movil'''.
##'''tableta'''.
##'''reloj'''.
##'''tv'''.
#*'''Para iOs:'''
##'''iphone'''.
##'''ipad'''.
##'''iwatch'''.
##'''appletv'''.
#'''appVersion:''' contendrá la versión de la aplicación a la que esta dirigida la notificación. '''Ejemplo: 1.0.1'''.
#'''terminalVersion:''' contendrá la versión del terminal al que ira dirigida la notificación. '''Ejemplo: 6.0.1'''.
#'''urlToOpen:''' contendrá la URL a abrir al hacer click sobre una notificación de tipo '''“openUrl”'''.
#'''external1:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external2:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external3:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external4:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''external5:''' variable extra que contendrá lo que el usuario quiera para tratar en las notificaciones de tipo '''“openAppWithExtras”''' y/o '''“openAppWithExtras” con “customType”'''.
#'''androidNotyStyle:''' contendrá '''“bigPictureStyle”''' cuando queramos mostrar una imagen junto con la notificación en los dispositivos con '''SO Android'''. En caso de no querer mostrar ninguna imagen no se utilizara este campo.
#'''bigPictureStyleUrlImage:''' contendrá la URL de la imagen que se quiera mostrar en los dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle"'''. Cabe destacar que la URL deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''bigPictureStyleExpandedTitle:''' contendrá el texto que se mostrará como titulo al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''', siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''bigPictureStyleExpandedSumaryText:''' contendrá el texto que se mostrará como mensaje al expandir una notificación que contenga una imagen en dispositivos con '''SO Android''' , siempre habiendo hecho uso del campo previamente expuesto '''“androidNotyStyle”''' con el contenido '''“bigPictureStyle”'''.
#'''extra-content:''' este campo solo se usará para notificaciones dirigidas a dispositivos con '''SO iOs'''. Contendrá la URL del contenido extra que se quiere mostrar junto con la notificación. En este caso y a diferencia de '''Android ( bigPictureStyleUrlImage )''', dicho contenido podrá ser una imagen, un giff, un video o un audio. La URL también deberá ser segura ( https ) y deberá contener la extension del contenido en dicha URL.
#'''channel:''' A partir de Android O, las notificaciones deberán ir por un canal de notificaciones instanciado en su aplicación. Esta variable contendrá el nombre del canal por el que han de salir.
#'''thread-id:''' A partir de iOs 12, las notificaciones pueden ser agrupadas. Para ello deberemos mandar el mismo thread-id en todas las notificaciones que queramos agrupar.

=Notificaciones Android=
En este apartado veremos los distintos tipos de notificaciones para dispositivos Android mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal+IMG';
$arr_data['message'] = 'Mensaje Noti.Normal+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenApp+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.OpenApp';
$arr_data['message'] = 'Mensaje Noti.OpenApp';
$arr_data['terminalTokens'] = 'onlyAndroid';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenUrl+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['title'] = 'Titulo Noti.OpenUrl';
$arr_data['message'] = 'Mensaje Noti.OpenUrl';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['urlToOpen'] = 'url_pagina_abrir'

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:''' Las notificaciones personalizadas, solo lanzarán la notificación si la APP se encuentra en background, en caso de estar en foreground (primer plano), no lanzará la notificación.
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['silent'] = 'no';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_a_extras_p.png|center]]
 
                '''Sin notificación:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_personalizado';
$arr_data['title'] = 'Titulo Noti.Silent';
$arr_data['message'] = 'Mensaje Noti.Silent';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['silent'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin customType:'''
 
                '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras+IMG';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras+IMG';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external4'] = 'variable4';
$arr_data['androidNotyStyle'] = 'bigPictureStyle';
$arr_data['bigPictureStyleUrlImage'] = 'url_image';
$arr_data['bigPictureStypeExpandedTittle'] = 'Titulo Noti.Expandida';
$arr_data['bigPictureStyleExpandedSumaryText'] = 'Mensaje Noti.Expandida';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
                '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['title'] = 'Titulo Noti.OpenAppWithExtras';
$arr_data['message'] = 'Mensaje Noti.OpenAppWithExtras';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['external1'] = 'variable1';
$arr_data['external3'] = 'variable3';
$arr_data['external5'] = 'variable5';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + TipoDispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + TipoDispositivo';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['deviceType'] = 'movil';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionAplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionAplicacion';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['appVersion'] = '1.0';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + VersionTerminal';
$arr_data['message'] = 'Mensaje Noti.Normal + VersionTerminal';
$arr_data['terminalTokens'] = 'onlyAndroid';
$arr_data['terminalVersion'] = '6.0.1';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Notificaciones iOs=
En este apartado veremos los distintos tipos de notificaciones para dispositivos iOs mas detalladamente complementándolo con ejemplos funcionales:
#'''normal:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal Imagen';
$arr_data['message'] = 'Mensaje Noti.Normal Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal';
$arr_data['message'] = 'Mensaje Noti.Normal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApp:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App Con Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir App Con Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openApp';
$arr_data['title'] = 'Titulo Noti.Abrir App';
$arr_data['message'] = 'Mensaje Noti.Abrir App';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openUrl:'''
            '''Con imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url Imagen';
$arr_data['message'] = 'Mensaje Noti.Abrir Url Imagen';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';
$arr_data['extra_content'] = 'https://.....';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''Sin imagen:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openUrl';
$arr_data['urlToOpen'] = 'https://....';
$arr_data['title'] = 'Titulo Noti.Abrir Url';
$arr_data['message'] = 'Mensaje Noti.Abrir Url';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['sandbox'] = 'yes';
$arr_data['isTest'] = 'yes';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''openApppWithExtras:'''
            '''Con customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['customType'] = 'tipo_eleccion_desarrollador';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
[[Archivo:Push_i_extras_p_s.png|center]]
 
            '''Sin customType:'''
 
                '''Silenciosa:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'openAppWithExtras';
$arr_data['external_1'] = 'variable_extra_1';
$arr_data['external_2'] = 'variable_extra_2';
$arr_data['title'] = 'SilentPush';
$arr_data['message'] = 'SilentPush';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['silent'] = 'yes';
$arr_data['silentNumber'] = '6';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
#'''Independientemente de los anteriores tipos:'''
            '''sendingId:'''
 
<source lang="php">
$token_exchange = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token_exchange);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + sendingId';
$arr_data['message'] = 'Mensaje Noti.Normal + sendingId';

$array_tokens = array(); // ARRAY CON TODOS LOS USUARIOS QUE QUEREMOS QUE RECIBAN LA NOTIFICACION
$array_tokens_enviar = array(); // ARRAY QUE SE USA PARA MANDAR DE 500 EN 500
$contador = 0; // VARIABLE DE CONTROL PARA ENVIAR 500 USUARIOS
$json_datos_devueltos = array(); // ARRAY QUE CONTENDRA LA RESPUESTA RECIBIDA DE LA API

foreach( $array_tokens as $token ){ // 1.- MANDAMOS A LA API DE 500 EN 500 PARA NO SATURARLA

if( $contador >= 500 ){

$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$conexionapi = new spsapiXchange($token_exchange);
$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

if ( isset($json_datos_devueltos['data']['sendingId']) AND !empty($json_datos_devueltos['data']['sendingId']) ){ // ESTO SE OBTENDRA DESPUES DE LANZAR LOS PRIMEROS 500 USUARIOS

$arr_data['sendingId'] = $json_datos_devueltos['data']['sendingId'];

}

$contador = 0;
$array_tokens_enviar = array();

}

$array_tokens_enviar[] = $token['token_del_usuario']; // EN NUESTRO CASO LA VARIABLE $token ES UN ARRAY CON MAS DATOS
$contador += 1;

}

if( count($array_tokens_enviar) > 0 ) { // 2.- MANDAMOS LOS QUE FALTEN, LOS RESTOS QUE NO HAYAN LLEGADO A 500

$conexionapi = new spsapiXchange($token_exchange);
$arr_data['terminalTokens'] = $array_tokens_enviar; // ASIGNAMOS LOS USUARIOS A ENVIAR

$json_datos_devueltos = json_decode($conexionapi->getData('setPush', $arr_data), true);

}
</source>
 
            '''language:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Idioma';
$arr_data['message'] = 'Mensaje Noti.Normal + Idioma';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['language'] = 'es';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''country:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Pais';
$arr_data['message'] = 'Mensaje Noti.Normal + Pais';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['country'] = 'ES';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''deviceType:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Tipo Dispositivo';
$arr_data['message'] = 'Mensaje Noti.Normal + Tipo Dispositivo';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['deviceType'] = 'iphone';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''appVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Aplicacion';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Aplicacion';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['appVersion'] = '3.4';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>
 
            '''terminalVersion:'''
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['direct'] = "yes";
$arr_data['whenSend'] = "inmediately";
$arr_data['type'] = 'normal';
$arr_data['title'] = 'Titulo Noti.Normal + Version Terminal';
$arr_data['message'] = 'Mensaje Noti.Normal + Version Terminal';
$arr_data['terminalTokens'] = 'onlyIOS';
$arr_data['terminalVersion'] = '10.3';

$json_datos_devueltos = $conexionapi->getData('setPush', $arr_data);
</source>

=Respuesta setPush=
La respuesta que recibiremos por parte de la API siempre será un JSON. Dicho JSON contendrá de tres a cinco posiciones/elementos:
#'''responsecode:''' determinará si la acción a realizar sobre la API ha funcionado o no. En caso de ser '''negativo''' devolverá '''“KO”''' y en caso de ser '''positivo''' será '''“OK”'''.
#'''errorcode:''' en caso de que el '''responsecode''' sea '''“KO”''', devolverá el código de error en nuestro sistema. Por el contrario, si el '''responsecode''' es '''“OK”''', devolverá un 0.
#'''errortext:''' contendrá el texto del error que se ha producido, por lo que como se deduce esto solo saldrá cuando la acción sobre la API no se haya podido ejecutar.
#'''data:''' contendrá el resultado de la acción realizada satisfactoriamente sobre la API. Si ha habido un error esta posición '''no se generará'''.
#'''timestamp:''' devolverá la fecha en timestamp en la que la acción sobre la API ha sido realizada correctamente. Si ha habido un error esta posición '''no se generará'''.
 
En resumen, si la acción a realizar sobre la API ha dado error, el JSON contendrá los elementos ( responsecode, errorcode y errortext).
 
[[Archivo:Api_exchange_error.png|center]]
 
Por el contrario si la acción ha finalizado correcta y satisfactoriamente, el JSON contendrá los elementos ( responsecode, errorcode, data y timestamp).
Para el caso de crear una notificación ( '''setPush''' ), y que haya funcionado correctamente, en la respuesta se generará algo tal que la siguiente imágen:
 
[[Archivo:Api_exchange_noerror.png|center]]
 
En el contenido del elemento '''data''', se mostrara las notificaciones que se han podido enviar, las que no se han podido enviar, el ID que se genera en nuestro sistema asociado al envío solicitado y un array con los tokens enviados ( '''deletedArray''' ) y un array con los tokens que no se han podido enviar ( '''deletedWithoutSend''' ).
 
Este último caso, el del array con los tokens que no se han podido enviar solo se informará en el caso de que al enviar la acción '''setPush''', en la posición '''terminalTokens''', se mande '''un array con los terminales en concreto que se quieren notificar'''.
 
En el caso del array con los dispositivos notificados, se apreciará una segmentación por '''SO'''. En caso de que uno de estos dispositivos no haya podido recibir la notificación por problemas como bien puede ser un token obsoleto, se borrará de nuestro sistema y el token se informará en la posición ( '''deletedTokens''' ).

=Obtención de usuarios registrados en su aplicación=
Para obtener un conteo de usuarios registrados en nuestra aplicación y los datos de estos, deberemos hacer uso de la tarea '''“getPushTokens”''' y el hash de la aplicación registrada en el panel de Mobeleader. Dicho hash podremos verlo en cualquier momento desde la sección https://panel.mobeleader.com/index.php?sec=6. Una vez obtengamos dicho hash procederemos a conectarnos a la API de la manera expuesta en la a continuación:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';

$json_datos_devueltos = $conexionapi->getData('getPushTokens', $arr_data);
</source>
 
[[Archivo:Api_exchange_getPushTokens.png|center]]
 
Como se puede apreciar en la respuesta, '''la posición respondecode es “OK”'''. Al igual que en el caso del '''“ping”''', siempre que el '''responsecode''' sea '''”OK”''' significara que la acción a realizar sobre la API ha finalizado correctamente y que en la posición '''“data”''' vendrá los solicitado, en este caso los datos de los terminales registrados en la aplicación.

=Borrado de usuarios registrados en su aplicación=
Una vez obtenidos los datos mediante la tarea '''“getPushTokens”''', si quisiéramos borrar alguno de dichos tokens del sistema de Mobeleader, deberemos hacer uso de la tarea '''“deletePushTokens”''' usando el hash de la aplicación de la misma manera que en la obtención de usuarios, y pasándole el token o los tokens que quisiéramos borrar. Lo haremos de la siguiente manera:
 
<source lang="php">
$token = 'token_generado_por_mobeleader';
$conexionapi = new spsapiXchange($token);

$arr_data = array();
$arr_data['appHash'] = 'token_de_la_aplicacion_registrada';
$arr_data['tokens'][] = 'token_del_usuario_registrado';

$json_datos_devueltos = $conexionapi->getData('deletePushTokens', $arr_data);
</source>

 
[[Archivo:Api_exchange_deletePushTokens.png|center]]
 
Como siempre, en caso de que el '''responsecode sea “OK”''', en la '''posición “data”''' veremos el número de tokens borrados.

Documentación API Analytics

2019-06-07T11:02:09Z

Deneb: /* Error en la petición de estadísticas */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] de nuestro panel.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] de nuestro panel.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>

==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] de nuestro panel.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] denuestro panel.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T11:00:56Z

Deneb: /* Link Tracking */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] de nuestro panel.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] de nuestro panel.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>

==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] de nuestro panel.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] denuestro panel.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:56:54Z

Deneb: /* Push */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] de nuestro panel.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] de nuestro panel.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>

==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] de nuestro panel.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] denuestro panel.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:55:29Z

Deneb: /* NickCenter */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] de nuestro panel.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] de nuestro panel.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>

==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] de nuestro panel.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] denuestro panel.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] de nuestro panel. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:54:16Z

Deneb: /* Developer */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] de nuestro panel.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] de nuestro panel.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>

==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] de nuestro panel.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] denuestro panel.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:53:46Z

Deneb: /* Developer */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] de nuestro panel.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] de nuestro panel.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>

==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] de nuestro panel.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] denuestro panel.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] de nuestro panel.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] denuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:52:41Z

Deneb: /* Miner */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] de nuestro panel.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] de nuestro panel.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>

==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] de nuestro panel.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] denuestro panel.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:51:36Z

Deneb: /* Marketing */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] de nuestro panel.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] de nuestro panel.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>

==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] del Panel de Mobeleader.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] del Panel de Mobeleader.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:49:29Z

Deneb: /* Mailing */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro de nuestro panel. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] de nuestro panel.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] denuestro panel.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] de nuestro panel. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing de nuestro panel.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] del Panel de Mobeleader.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] del Panel de Mobeleader.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>
==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] del Panel de Mobeleader.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] del Panel de Mobeleader.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:44:14Z

Deneb: /* Tipos */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en nuestro panel.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en nuestro panel.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en nuestro panel.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en nuestro panel.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en nuestro panel.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de nuestro sistema. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en nuestro panel.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en nuestro panel.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] del Panel de Mobeleader.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] del Panel de Mobeleader.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] del Panel de Mobeleader.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] del Panel de Mobeleader. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] del Panel de Mobeleader.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] del Panel de Mobeleader.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>
==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] del Panel de Mobeleader.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] del Panel de Mobeleader.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:42:07Z

Deneb: /* Conexión con la API */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] de nuestro panel.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en el Panel de Mobeleader.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en el Panel de Mobeleader.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en el Panel de Mobeleader.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en el Panel de Mobeleader.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en el Panel de Mobeleader.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de Mobeleader. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en el Panel de Mobeleader.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en el Panel de Mobeleader.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] del Panel de Mobeleader.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] del Panel de Mobeleader.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] del Panel de Mobeleader.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] del Panel de Mobeleader. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] del Panel de Mobeleader.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] del Panel de Mobeleader.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>
==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] del Panel de Mobeleader.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] del Panel de Mobeleader.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:40:12Z

Deneb: /* Registro de usuario */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection''' creada por Mobeleader. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en el Panel de Mobeleader.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en el Panel de Mobeleader.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en el Panel de Mobeleader.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en el Panel de Mobeleader.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en el Panel de Mobeleader.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de Mobeleader. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en el Panel de Mobeleader.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en el Panel de Mobeleader.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] del Panel de Mobeleader.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] del Panel de Mobeleader.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] del Panel de Mobeleader.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] del Panel de Mobeleader. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] del Panel de Mobeleader.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] del Panel de Mobeleader.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>
==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] del Panel de Mobeleader.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] del Panel de Mobeleader.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Documentación API Analytics

2019-06-07T10:38:24Z

Deneb: /* Introduccion */

=Introduccion=
La '''API Analytics''' es la plataforma a través de la cual obtener las estadísticas de un usuario. Los datos obtenidos corresponderán a los datos que se obtendrían en las secciones de Analytics de nuestro panel. Las estadísticas serán devueltas en formato JSON.

Para poder utilizar la '''API Analytics''' y poder obtener tanto el identificador de usuario como las claves RSA, deberá solicitarlo a su administrador.

En esta documentación se explicará cómo conectar con la API y cómo preparar los datos para realizar la petición de las estadísticas. Los ejemplos ofrecidos están en lenguaje PHP.

=Registro de usuario=
Al solicitar el acceso a la '''API Analytics''', es necesario reportar las direcciones IP desde las que se realizarán las peticiones de estadísticas. Así mismo, el usuario deberá actualizar el registro de direcciones IP cuando éstas cambien. El sistema de Mobeleader registrará las direcciones IP junto al identificador del usuario, por lo que no permitirá al usuario realizar peticiones si éste no está asociado a las direcciones IP registradas.

=Conexión con la API=
La conexión con la API para realizar la petición de estadísticas se puede realizar de dos maneras:
#Mediante llamada directa a la API. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection''' creada por Mobeleader. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa a la API==
Si desea realizar la petición a la API sin la necesidad de usar la clase '''analyticsConnection''', deberá conectarse mediante POST a la siguiente URL: ''https://panel.mobeleader.com/webservices/analytics/api_analytics.php'', añadiendo los parámetros '''data''' (JSON con los datos de la petición) y '''user''' (string o cadena con el identificador del usuario). En el apartado '''Petición de estadísticas''' se explicará como obtener el identificador de usuario y como construir el JSON de la petición.
:*''Ejemplo de petición directa:''
<source lang="PHP">
$url = 'https://panel.mobeleader.com/webservices/analytics/api_analytics.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode($requestJson).'&user='.$userIdString);
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en su carpeta vendor, lo primero que deberá hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Tras modificar la ruta, para poder instanciar la clase, será necesario obtener la clave '''RSA KEY Privada''', accesible desde la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader.

[[Archivo: Boton_rsa_keys.png]]

Pulsando en '''Ver claves RSA''', se abrirá un popup en el que podrá obtener las claves RSA.

[[Archivo: Rsa_keys.png]]

Ha de copiar la cadena perteneciente al campo '''Private RSA key'''. Es necesario copiar la cadena completa, incluyendo -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----. Se añadirá la cadena como parámetro (string) del constructor de la clase '''spsApiConnection''', tal y como se muestra en el ejemplo siguiente:
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
</source>
 
Una vez realizadas correctamente la instalación de la librería, la modificación de la ruta de acceso a ésta, y la inserción en el código de la '''RSA KEY Privada''', las llamadas a la API se realizarán a través de la función '''getApiData()''' de la clase '''spsApiConnection''', añadiendo el JSON con los datos de la petición y la cadena con el identificador del usuario. La función '''getApiData()''' será la encargada de realizar todas las conexiones a la API, de cifrar los datos que se envíen a ésta y de descifrar los datos que devuelva.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$apiconnection = new spsApiConnection([RSA_PRIVATE_KEY]);
$responseJson = $apiconnection->getApiData($userIdString, $requestJson)
</source>
 
En el apartado '''Petición de estadísticas''' se explica cómo obtenerla cadena con el identificador de usuario y cómo construir el JSON de la petición

=Petición de estadísticas=
Para que la petición de estadísticas se realice correctamente, es necesario enviar, dentro de la petición, su identificador de usuario y un JSON en el cual especificar las estadísticas que quiera obtener (campos de las estadísticas, filtros, fechas, etc.).

'''Las peticiones a la API son limitadas'''. Una vez recibida la respuesta de estadísticas (a excepción de haber devuelto un error), deberá esperar un minuto para hacer la siguiente consulta.

==Identificador de usuario==
Para realizar la petición de estadísticas a la '''API Analytics''', lo primero que debe hacer es obtener el identificador de usuario. Para ello diríjase a la [https://panel.mobeleader.com/index.php?sec=2 sección Mis Datos] del Panel de Mobeleader y pulse en '''Ver claves RSA'''. Una vez dentro del popup, copie la cadena perteneciente al campo '''Public Identifier'''.

[[Archivo: Public_id.png]]

==JSON de petición de estadísticas==
Para obtener las estadísticas deseadas, es necesario crear un JSON en el que se especifique:
#El tipo de petición, especificado en el campo '''type''': minería, desarrollo, etc.
#Los elementos de los cuales quiera obtener las estadísticas, especificados en el campo '''require''': por anuncio, por app, por sistema operativo, etc.
#Las estadísticas que quiera mostrar, especificadas en el campo '''fields''': impresiones, descargas, hashes minados, etc.
#Los filtros o elementos concretos de los que quiera obtener las estadísticas, especificados en el campo '''filters''': determinadas apps, bases de datos, etc.
#Las fechas entre las que quiera delimitar la petición, especificadas en el campo '''dates'''.

==Tipos==
Cada tipo de petición devolverá un tipo de estadísticas, en función del tipo de usuario que realice la petición, así como los permisos que le hayan sido otorgados. El tipo de petición se especificará en el campo '''type''' del JSON. Los diferentes valores para el tipo de petición son:
*'''mailing:''' Devuelve las estadísticas de los envíos de Mailing. El usuario ha de tener acceso a las secciones de '''Mailing''' en el Panel de Mobeleader.
*'''marketing:''' Devuelve las estadísticas de los anuncios. El usuario ha de tener acceso a las secciones de '''Agencias''' en el Panel de Mobeleader.
*'''miner:''' Devuelve las estadísticas minería. El usuario ha de tener acceso a las secciones de '''Minería''' en el Panel de Mobeleader.
*'''developer:''' Devuelve las estadísticas de las aplicaciones. El usuario ha de tener acceso a las secciones de '''Desarrolladores''' en el Panel de Mobeleader.
*'''nickcenter:''' Devuelve las estadísticas de los registros realizados a través de '''NickCenter'''. El usuario ha de tener acceso a las secciones de '''NickCenter''' en el Panel de Mobeleader.
*'''push:''' Devuelve las estadísticas generadas por las '''notificaciones Push''' de sus aplicaciones enviadas a través de Mobeleader. El usuario ha de tener acceso a las secciones de '''Notificaciones Push''' en el Panel de Mobeleader.
*'''linkTracking:''' Devuelve las estadísticas de descargas por URL tracking. El usuario ha de tener acceso a las sección '''Link Management''' en el Panel de Mobeleader.

==Mailing==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''db:''' Devolverá las estadísticas por '''Base de datos'''.
**'''mail:''' Devolverá las estadísticas por '''envío'''.
**'''campaign:''' Devolverá las estadísticas por '''campaña'''.
**'''domain:''' Devolverá las estadísticas por '''dominio'''.
**'''sender:''' Devolverá las estadísticas por '''sender''' (enviador).
**'''emailAdress:''' Devolverá las estadísticas por '''dirección de email''' desde la que se hayan realizado los envíos.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''sent:''' emails enviados.
**'''views:''' impresiones totales obtenidas.
**'''unique_views:''' impresiones únicas.
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''leads:''' registros totales realizados.
**'''unique_leads:''' registros únicos.
**'''unsubscribes:''' bajas ejecutadas.
**'''soft_bounces:''' soft bonces devueltos.
**'''hard_bounces:''' hard bonces devueltos.
**'''or:''' tasa de aperturas.
**'''cr:''' tasa de clicks.
**'''ur:''' tasa de bajas.
**'''br:''' tasa de bonces o rebotados.
**'''rr:''' tasa de reactividad.
**'''dr:''' tasa de entregabilidad.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''senders:''' Array que especifica los '''senders''' o enviadores de los que se quieren obtener las estadísticas. Puede añadir los identificadores 'MailingCP' y 'AmazonSES'.
**'''dataBases:''' Array que especifica las bases de datos de las que se quieren obtener las estadísticas. Los identificadores de sus bases de datos los podrá obtener en la columna '''Id''' correspondiente a cada base de datos en la [https://panel.mobeleader.com/index.php?sec=105 sección BBDD] del Panel de Mobeleader.
**'''campaigns:''' Array que especifica las campañas de las que se quieren obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=135 sección Campañas] del Panel de Mobeleader.
**'''domains:''' Array que especifica los dominios de los que se quieren obtener las estadísticas. Los identificadores de sus dominios los podrá obtener en la columna '''Id''' correspondiente a cada dominio en la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] del Panel de Mobeleader.
**'''campaignType:''' Valor que especifica el tipo de campaña de la que se quiere obtener las estadísticas. Puede elegir entre uno de los siguientes tipos:
***'''transactional:''' Para envíos transaccionales.
***'''autoresponder:''' Para envíos automáticos.
***'''newsletter:''' Para envíos boletín.
***'''transactional:''' Para envíos de marketing.
**'''emails:''' Array que especifica las direcciones de email de las que se quieren obtener las estadísticas. Para obtener los identificadores de sus direcciones de email deberá dirigirse a la [https://panel.mobeleader.com/index.php?sec=126 sección Dominios] del Panel de Mobeleader. Una vez ahí, pulse en el icono '''Ver emails''' en la columna '''Emails'''. Dentro del popup en el que se muestran las direcciones de email del dominio seleccionado, podrá obtener el identificador en la columna '''Id''' correspondiente a cada dirección de email.
**'''mailings:''' Array que especifica los envíos de los que se quieren obtener las estadísticas. Los identificadores de sus envíos los podrá obtener en la columna '''Id''' correspondiente a cada envío en la [https://panel.mobeleader.com/index.php?sec=134 sección Envíos Transaccionales] para los envíos transaccionales, en la [https://panel.mobeleader.com/index.php?sec=148 sección Envíos Auto-Responder] para los envíos autoresponder, en la [https://panel.mobeleader.com/index.php?sec=139 sección Envíos Boletín] para los envíos boletín y en la [https://panel.mobeleader.com/index.php?sec=138 sección Envíos Marketing] para los envíos de marketing del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por campaña con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"campaign",
"fields":["sent","views","unique_views","clicks","unique_clicks","leads","unique_leads","unsubscribes","soft_bounces","hard_bounces","or","cr","ur","br","rr","dr"],
"filters":{
"senders":["MailingCP"],
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"newsletter",
"domains":[3,25,27],
"emails":[59,162],
"mailings":[324,17835]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-02"
}
}

</source>

*''Ejemplo de petición de estadísticas por envío con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"mailing",
"require":"mail",
"fields":["sent","views","clicks","leads","unsubscribes"],
"filters":{
"dataBases":[1,3,4],
"campaigns":[221,302,357],
"campaignType":"marketing",
"emails":[59,162],
"mailings":[17835]
},
"dates":{
"firstDate":"2018-09-01"
}
}

</source>

==Marketing==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''ad:''' Devolverá las estadísticas por '''Anuncio''' o '''Campaña'''.
**'''domain:''' Devolverá las estadísticas por '''Web'''.
**'''creativity:''' Devolverá las estadísticas por '''Creatividad'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''clicks:''' clicks totales realizados.
**'''unique_clicks:''' clicks únicos.
**'''ctr:''' CTR.
**'''validated_leads:''' registros validados.
**'''pending_leads:''' registros pendientes.
**'''total_leads:''' registros totales.
**'''rejected_leads:''' registros rechazados.
**'''validated_expenditures:''' gastos validados.
**'''pending_expenditures:''' gastos pendientes.
**'''total_expenditures:''' gastos totales.
**'''validated_profits:''' beneficios validados.
**'''pending_profits:''' beneficios pendientes.
**'''total_profits:''' beneficios totales.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''campaigns:''' Array que especifica los anuncios o campañas de las que se quiere obtener las estadísticas. Los identificadores de sus campañas los podrá obtener en la columna '''Id''' correspondiente a cada campaña en la [https://panel.mobeleader.com/index.php?sec=9 sección Mis Anuncios] del Panel de Mobeleader.
**'''domains:''' Array que especifica las webs de las que se quiere obtener las estadísticas. Los identificadores de sus webs los podrá obtener en la columna '''Id''' correspondiente a cada web en la [https://panel.mobeleader.com/index.php?sec=17 sección Mis Webs] del Panel de Mobeleader.
**'''creativities:''' Array que especifica las creatividades de las que se quiere obtener las estadísticas. Los identificadores de sus creatividades los podrá obtener en la columna '''Id''' correspondiente a cada creatividad en la [https://panel.mobeleader.com/index.php?sec=173 sección Mis Creatividades] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain","creativity","date"],
"fields":["clicks","unique_clicks","ctr","validated_leads","pending_leads","total_leads","rejected_leads","validated_expenditures","pending_expenditures","total_expenditures","validated_profits","pending_profits","total_profits"],
"filters":{
"campaigns":[3,125,408],
"domains":[95,512],
"creativities":[27,135]
},
"dates":{
"firstDate":"2018-09-03",
"lastDate":"2018-09-11"
}
}

</source>

*''Ejemplo de petición de estadísticas por campaña y web, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"marketing",
"require":["ad","domain"],
"fields":["clicks","unique_clicks","total_leads","total_expenditures","total_profits"],
"filters":{
"campaigns":[3],"domains":[95,512]
},
"dates":{
"firstDate":"2018-09-03"
}
}

</source>
==Miner==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''worker:''' Devolverá las estadísticas por '''worker'''.
**'''wallet:''' Devolverá las estadísticas por '''wallet'''.
**'''workerType:''' Devolverá las estadísticas por '''tipo de worker''' (app, web, link, etc).
**'''coin:''' Devolverá las estadísticas por '''divisa'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''payout:''' pago estimado.
**'''hashes:''' hashes minados.
**'''shares:''' hashes validados.
**'''hashrate:''' hashes por segundo.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''workers:''' Array que especifica los workers de los que se quiere obtener las estadísticas. Los identificadores de sus workers los podrá obtener en la columna '''Id''' correspondiente a cada workers en la [https://panel.mobeleader.com/index.php?sec=5 sección Mis Workers] del Panel de Mobeleader.
**'''wallets:''' Array que especifica los wallets de los que se quiere obtener las estadísticas. Los identificadores de sus wallets los podrá obtener en la columna '''Id''' correspondiente a cada wallet en la [https://panel.mobeleader.com/index.php?sec=1 sección Mis Wallets] del Panel de Mobeleader.
**'''coins:''' Array que especifica las divisas de las que se quiere obtener las estadísticas. Puede añadir las siguientes divisas:
***'''bcn:''' Bytecoin.
***'''xmr:''' Monero.
**'''workerTypes:''' Array que especifica los diferentes tipos de workers de los que se quiere obtener las estadísticas. Puede añadir los siguientes tipos:
***'''app:''' aplicación.
***'''web:''' web.
***'''wallet:''' wallet.
***'''link:''' link de redireccionamiento.
***'''captcha:''' captcha de validación.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet","coin","workerType","date"],
"fields":["payout","hashes","shares","hashrate"],
"filters":{
"workers":[39,62],
"wallets":[1,5,6],
"workerTypes":["app","web","wallet","link","captcha"],
"coins":["bcn","xmr"]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-30"
}
}

</source>

*''Ejemplo de petición de estadísticas por worker y wallet, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"miner",
"require":["worker","wallet"],
"fields":["hashes","hashrate"],
"filters":{
"workers":[39,62],
"workerTypes":["app","web"],
"coins":["xmr"]
}
}

</source>

==Developer==
*El campo '''require''' es obligatorio, e indica el tipo de elemento del que se quiere obtener las estadísticas:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''place:''' Devolverá las estadísticas por '''espacio'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''osVersion:''' Devolverá las estadísticas por '''versión del sistema operativo'''.
**'''brand:''' Devolverá las estadísticas por '''marca del terminal'''.
**'''country:''' Devolverá las estadísticas por '''país'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''views:''' impresiones obtenidas.
**'''clicks:''' clicks realizados.
**'''downloads:''' descargas obtenidas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quieren obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''oss:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''places:''' Array que especifica los espacios de los que se quiere obtener las estadísticas. Los identificadores de sus espacios los podrá obtener en la columna '''Id''' correspondiente a cada espacio en la [https://panel.mobeleader.com/index.php?sec=34 sección Mis Espacios] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación con todos los campos y los filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"app",
"fields":["views","clicks","downloads"],
"filters":{
"oss":"android",
"apps":[13,63],
"places":[85,125,198]
},
"dates":{
"firstDate":"2018-09-01",
"lastDate":"2018-09-07"
}
}

</source>

*''Ejemplo de petición de estadísticas por país con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"developer",
"require":"country",
"fields":["views","clicks"],
"filters":{
"apps":[63],
"places":[85,125,198]
},
"dates":{
"lastDate":"2018-09-07"
}
}

</source>

==NickCenter==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''. Este campo solo podrá ser requerido por aquellos usuarios con acceso al '''Link Management'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''users:''' Usuarios dados de alta en cada aplicación. Solo contabiliza el primer registro en NickCenter, no contabiliza otro registro del mismo usuario en otras aplicaciones.
**'''total:''' Todos los usuarios registrados en base dentro de las fechas seleccionadas, incluidos los que se hayan dado de baja.
**'''registered:''' Usuarios que están registrados en la base de datos.
**'''valid:''' Usuarios que están registrados en la base de datos, con todos los campos requeridos completados correctamente.
**'''unsubscribes:''' Usuarios que estuvieron registrados en la base de datos y que se dieron de baja dentro de las fechas seleccionadas.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader. Este filtro solo ser á válido para aquellos usuarios con acceso al '''Link Management'''.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo y fecha, con todos los filtros, excepto links:''

<source lang="PHP">
{
"type":"nickcenter",
"require":["app","os","date"],
"fields":["users","total","registered","valid","unsubscribes"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","US"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"nickcenter",
"fields":["users","total"],
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Push==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse, exceptuando los campos '''notification''' y '''app''' (solo podrá seleccionar uno de estos dos campos en una consulta). Si selecciona el campo '''notification''', deberá establecer una app en el campo '''apps''' de los filtros. Los valore son los siguientes:
**'''notification:''' Devolverá las estadísticas por cada '''notificación Push'''.
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''status:''' Devolverá las estadísticas por '''estado''' de la notificación.
**'''date:''' Devolverá las estadísticas por '''fecha'''.

*El campo '''fields''' es obligatorio, e indica qué valores de las estadísticas se quieren obtener. Los valores del campo '''fields''' irán especificados dentro de un array y podrán ser los siguientes:
**'''total:''' el total de los mensajes enviados de la notificación.
**'''sent:''' mensajes enviados correctamente.
**'''failed:''' mensajes enviados y que no han llegado al terminal de destino.
**'''erased:''' mensajes borrados.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Especifique una única aplicación en caso de haber seleccionado el campo '''notification''' en los filtros. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''countries:''' Array que especifica los países de los que se quiere obtener las estadísticas. Ha de añadir el código del país que desee. Puede consultar los códigos en el [https://wiki.mobeleader.com/index.php?title=Apendice_paises apéndice de países].
**'''status:''' Array que especifica los estados de las notificaciones de los que se quiere obtener las estadísticas.
***'''ready:''' indica que la notificación ha sido creada correctamente y está en espera de ser verificada.
***'''starting:''' indica que la notificación ha sido verificada y va ser enviada.
***'''sending:''' indica que la notificación está siendo enviada.
***'''finished:''' indica que el envío de la notificación ha finalizado.
***'''stoped:''' indica que el envío de la notificación ha sido detenido.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, estado y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"push",
"require":["app","os","status","date"],
"fields":["total","sent","failed","erased"],
"filters":{
"apps":[13,63],
"os":"android",
"countries":["ES","FR"],
"estados":["sending","finished"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por notificación y estado, con algunos de los campos y filtros (en el filtro de '''apps''' solo establece una aplicación):''

<source lang="PHP">
{
"type":"push",
"require":["notification","status"],
"fields":["total","sent","failed"],
"filters":{
"apps":[13]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

==Link Tracking==
*El campo '''require''' es obligatorio, e indica los elementos de los que se quiere obtener las estadísticas. Los valores del campo '''require''' irán especificados dentro de un array y podrán combinarse. No puede combinarse el campo '''link''' con los campos '''field''' y '''value''', por lo que si decide incluir el campo '''link''' no se mostrarán las estadísticas por '''field''' y '''value'''. Los valore son los siguientes:
**'''app:''' Devolverá las estadísticas por '''aplicación'''.
**'''os:''' Devolverá las estadísticas por '''sistema operativo'''.
**'''date:''' Devolverá las estadísticas por '''fecha'''.
**'''link:''' Devolverá las estadísticas por '''link'''.
**'''field:''' Devolverá las estadísticas por '''campo'''.
**'''value:''' Devolverá las estadísticas por '''valor'''.

*El campo '''filters''' es opcional, e indica los elementos concretos de los que se quiere obtener las estadísticas. Los valores del campo '''filters''' irán especificados dentro de un array y corresponderán al identificador de cada elemento dentro del Panel de Mobeleader. Podrán ser los siguientes:
**'''apps:''' Array que especifica las aplicaciones de las que se quiere obtener las estadísticas. Los identificadores de sus aplicaciones los podrá obtener en la columna '''Id''' correspondiente a cada aplicación en la [https://panel.mobeleader.com/index.php?sec=6 sección Mis Aplicaciones] del Panel de Mobeleader.
**'''links:''' Array que especifica los links de los que se quiere obtener las estadísticas. Los identificadores de sus links los podrá obtener en la columna '''Id''' correspondiente a cada link en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''os:''' Array que especifica los '''sistemas operativos''' de los que se quiere obtener las estadísticas. Puede añadir los identificadores 'android' e 'ios'.
**'''fields:''' Array que especifica los campos de los que se quiere obtener las estadísticas. Los nombres de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.
**'''values:''' Array que especifica los valores de los campos de los que se quiere obtener las estadísticas. Los valores de cada campo los podrá obtener en el recuadro '''Campos opcionales''' correspondiente a cada link (en caso de haber sido configurados) en la [https://panel.mobeleader.com/index.php?sec=45 sección Link Management] del Panel de Mobeleader.

*El campo '''dates''' es opcional, e indica las fechas entre las cuales queremos obtener las estadísticas. Los valores del campo '''dates''' irán especificados dentro de un array, en formato 'YYYY-MM-DD' y podrán ser los siguientes:
**'''firstDate:''' fecha de inicio.
**'''lastDate:''' fecha de fin.

*''Ejemplo de petición de estadísticas por aplicación, sistema operativo, campo, valor y fecha, con todos los filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","os","field","value","date"],
"filters":{
"apps":[13,63],
"links":[2,10],
"os":"android",
"fields":["campo1","campo2"],
"values":["valor1","valor2"]
},
"dates":{
"firstDate":"2018-10-01",
"lastDate":"2018-10-12"
}
}

</source>

*''Ejemplo de petición de estadísticas por aplicación y link, con algunos de los campos y filtros:''

<source lang="PHP">
{
"type":"linkTracking",
"require":["app","link"],
"filters":{
"apps":[13,63],
"links":[2,10],
"values":["valor1"]
},
"dates":{
"lastDate":"2018-10-12"
}
}

</source>

=Resultado de las estadísticas=
Una vez realizada la conexión con la API correctamente, ésta devolverá una respuesta en formato JSON. La respuesta puede contener:
*Un resultado sin estadísticas.
*Las estadísticas resultantes de la petición.
*Un mensaje de error.
==Resultado vacío==
Si la petición se ha realizado correctamente, pero la API no ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el siguiente resultado:

<source lang="PHP">
{"result":"No result for this request."}

</source>

==Resultado con estadísticas==
Si la petición se ha realizado correctamente, y la API ha encontrado estadísticas para los valores requeridos, devolverá, dentro del campo '''result''', el resultado de las estadísticas desglosado por campo, en función de los valores indicados en los campos '''require''' y '''fields'''. Si además se ha establecido el valor 'date' en el campo '''require''', el resultado vendrá desglosado por campo y fecha.

*''Ejemplo de resultado de estadísticas sin fechas:''

<source lang="PHP">
{
"result":{
"0":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"5",
"field3":"20"
},
"1":{
"require1":"require1 value",
"require2":"require2 value",
"field1":"23",
"field2":"7",
"field3":"18"
},
"total":{
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

*''Ejemplo de resultado de las mismas estadísticas por fecha:''

<source lang="PHP">
{
"result":{
"2018-10-10":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"5",
"field2":"2",
"field3":"7"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"7",
"field2":"3",
"field3":"10"
}
],
"2018-10-03":[
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"10",
"field2":"4",
"field3":"12"
},
{
"require1":"require1 value",
"require2":"require2 value",
"field1":"11",
"field2":"3",
"field3":"9"
}
],
"total":{
"date":2,
"require1":"require1 total",
"require2":"require2 total",
"field1":"33",
"field2":"12",
"field3":"38"
}
}
}

</source>

==Error en la petición de estadísticas==
Si la petición no se ha realizado correctamente, la API devolverá un mensaje, dentro del campo '''error''', indicando la causa de error en la petición. A continuación se muestra los diferentes errores que la API puede devolver:
<source lang="PHP">
{"error":"This is not a valid IP address. Please ask your account manager for a valid IP."}

</source>

Indica que la IP no está registrada en el sistema de Mobeleader.

<source lang="PHP">
{"error":"This is not a valid IP address for the user key sent. Please check and set 'user' parameter properly."}

</source>

Indica que la dirección IP desde la que se realiza la petición es correcta, pero no está registrada para el usuario introducido.

<source lang="PHP">
{"error":"No request user found. Please set user parameter properly."}

</source>

Indica que el parámetro '''user''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"No data post field found. Please set data post field."}

</source>

Indica que el parámetro '''data''' no se ha enviado.

<source lang="PHP">
{"error":"No request data found. Please fill your request with proper parameters."}

</source>

Indica que el parámetro '''data''' está vacío.

<source lang="PHP">
{"error":"No request type found. Please set type parameter properly."}

</source>

Indica que el parámetro '''type''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Wrong type set, 'type_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''type''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"Wrong user set, 'user_key_for_error_test' is not a valid type."}

</source>

Indica que el parámetro '''user''' se ha introducido incorrectamente.

<source lang="PHP">
{"error":"No request fields found. Please set the fields you want to check."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"User has no permission for this request."}

</source>

Indica que el usuario introducido no tiene permisos para realizar ese tipo de consulta.

<source lang="PHP">
{"error":"User must wait at least 1 minute for the next request."}

</source>

Indica que el usuario ha de esperar al menos un minuto desde la última consulta hasta la siguiente.

<source lang="PHP">
{"error":"Request require parameter not found or not properly set. Please set require parameter in your request."}

</source>

Indica que el parámetro '''fields''' está vacío o no se ha enviado.

<source lang="PHP">
{"error":"Request require parameter not properly set, 'require_value_for_error_test' is not a valid require. Please set a valid require parameter in your request."}

</source>

Indica que el valor indicado del parámetro '''require''' no es correcto para la consulta deseada.

<source lang="PHP">
{"error":"Some required fields are not correct. 'fields_value_for_error_test' is not a valid field. Please set the required fields properly."}

</source>

Indica que el valor indicado del parámetro '''fields''' no es correcto para la consulta deseada.

==Error en las claves RSA==
Si las claves RSA no han sido configuradas correctamente, el sistema mostrará los siguientes errores:

<source lang="PHP">
Error 000d - Missing public RSA Key for user key 'my_user_key'.

</source>

Indica que el sistema no ha podido verificar las claves RSA del usuario.

<source lang="PHP">
Error 000c - Empty or invalid user key.

</source>

Indica que el parámetro '''user''' no se ha enviado correctamente.

Panel:Desarrolladores:AppExchange

2019-06-07T10:35:23Z

Deneb: /* App Exchange: intercambio de espacios publicitarios */

== App Exchange: intercambio de espacios publicitarios ==

La librería o framework '''SPS''' permite monetizar sus aplicaciones mostrando banners publicitarios dentro de éstas. Con el '''App Exchange''' usted puede convertirse en '''Anunciante''' de sus propias aplicaciones. Usando el servicio de '''App Exchange''', sus aplicaciones aparecerán anunciadas en los ''banners'' publicitarios, tanto de su aplicaciones, como de aplicaciones externas.

La esencia del '''App Exchange''' es el '''intercambio de espacios publicitarios entre los desarrolladores''', de tal manera que pueda anunciar sus aplicaciones en los espacios de aplicaciones de otros desarrolladores, a la vez que ellos puedan publicitar sus aplicaciones en los de usted.

El anuncio de una de sus aplicaciones aparecerá en un ''banner'' publicitario como una creatividad en formato HTML, a la que denominaremos '''auto-promoción'''.

== Sistema de puntos ==

El sistema de '''puntos''' o '''Saldo de App Exchange''' establece una relación equitativa de las auto-promociones. Es necesaria la incorporación de la '''librería Referrer''' para poder obtener las estadísticas de descargas.

Cada vez que una de sus auto-promociones se muestre en una aplicación que no sea de su propiedad, si el usuario clica en el anuncio para dirigirse a la URL de la tienda (Google Play, Apple Store, etc.) o web, y descarga la aplicación, '''disminuirá''' su '''saldo de App Exchange en 1 punto'''. Por el contrario, en caso de que se realice la descarga de una aplicación externa a través de una auto-promoción suya, '''aumentará''' su '''saldo de App Exchange en 1 punto'''.
Si tanto la aplicación que ha mostrado la auto-promoción como la aplicación descargada son suyas, el saldo no cambiará.

[[Archivo: Puntos.png |center]]

La primera vez que active el '''App Exchange''' se le serán asignados 30 puntos. Este saldo irá aumentando o disminuyendo en función de si son sus aplicaciones las descargadas o son las aplicaciones de otros desarrolladores. Si su saldo es '''0''' no se mostrarán sus auto-promociones en las aplicaciones que no sean suyas.

== Activación del servicio ==

Para poder utilizar el '''servicio App Exchange''' en una de sus aplicaciones, debe instalar previamente las [http://panel.mobeleader.com/index.php?sec=82 librerías SPS y Referrer], así como tener creado al menos un [http://panel.mobeleader.com/index.php?sec=34 espacio] para poder mostrar la publicidad.

Si ya tiene un espacio creado previamente diríjase a la sección [http://panel.mobeleader.com/index.php?sec=34 Mis Espacios] y pulse en el icono '''Editar espacio'''.

[[Archivo: Editar_espacio.png |center]]

Si aún no ha creado un espacio para mostrar publicidad hágalo pulsando el botón '''Crear Espacio''' en la sección [http://panel.mobeleader.com/index.php?sec=34 Mis Espacios].

[[Archivo: Crear_espacio.png |center]]

Antes de finalizar la configuración del espacio encontrará la opción '''Activar soporte para App Exchange'''.

[[Archivo: Appex_no.png |center]]

Si pulsa en el ''checkbox'', '''activará el App Exchange''' para el espacio que está siendo configurado y se desplegarán las diferentes opciones de configuración del '''App Exchange'''.

[[Archivo: Appex_si.png |center]]

== Configuración del servicio ==

Una vez activado el '''App Exchange''' para el espacio, podrá configurarlo in situ, o más adelante desde la sección [http://panel.mobeleader.com/index.php?sec=78 Configuración del App Exchange] pulsando en el botón '''Configurar App Exchange''' en la aplicación correspondiente.

[[Archivo: Config_appex.png |center]]

=== Porcentaje del App Exchange ===

Establece la relación entre el número de veces que aparecerán auto-promociones respecto al resto de anuncios. Si por ejemplo seleccionara un porcentaje de 20 se mostraría una auto-promoción por cada 5 impresiones en un espacio. Este porcentaje no podrá ser superior al 60%.

[[Archivo: Config_appex_1.png |center]]

=== Activación de aplicaciones propias ===

Si tiene auto-promociones de otras aplicaciones de su propiedad, active esta opción si quiere que se muestren dentro del espacio.

[[Archivo: Config_appex_2.png |center]]

=== Activación de aplicaciones externas ===

Si desea intercambiar sus auto-promociones con aplicaciones de otros desarrolladores active esta opción. Recuerde que su saldo ha de ser mayor de 0 para que esta condición se cumpla.

[[Archivo: Config_appex_3.png |center]]

=== Porcentaje de intercambio entre aplicaciones externas e internas ===

Puede especificar el porcentaje de veces que quiere que aparezcan auto-promociones propias respecto a las de aplicaciones de otros desarrolladores. Si seleccionara un porcentaje de 100 en esta opción se mostrarían únicamente sus propias auto-promociones. Por el contrario, si seleccionara un 0%, todas las auto-promociones mostradas en su espacio serían de aplicaciones de otros desarrolladores. Seleccionando un porcentaje de 20, por cada 5 auto-promociones mostradas en el espacio, 1 sería de su propiedad y 4 externas.

[[Archivo: Config_appex_4.png |center]]

== Auto-promociones ==
Una vez activado y configurado el '''App Exchange''' en el espacio deseado, cree la auto-promoción de su aplicación. En la sección [http://panel.mobeleader.com/index.php?sec=66 App Exchange], pulse el botón '''Crear auto-promoción'''.

[[Archivo: Boton_2.png |center]]

Siga los pasos que se indican para configurar su auto-promoción y automáticamente se creará una creatividad HTML de 320 x 50 ''pixels''. Podrá ver una ''preview'' de la auto-promoción en la tabla '''Mis auto-promociones''' de la sección [http://panel.mobeleader.com/index.php?sec=66 App Exchange] pulsando en '''Ver preview'''.

[[Archivo: Autoad preview.png |center]]

== Lanzamiento de una auto-promoción ==

El lanzamiento de de las auto-promociones se realiza a través de la '''librería SPS'''. Las auto-promociones son creatividades con un tamaño de '''320 x 50''', por lo que si quiere que se muestren en su espacio éste debe ser del tipo '''"BANNER"'''.

Si ha seguido los pasos previamente indicados y el espacio esté correctamente configurado para mostrar anuncios y auto-promociones, éstas se mostrarán con la frecuencia establecida en los porcentajes de configuración.

== Estadísticas del App Exchange ==

En la sección [http://panel.mobeleader.com/index.php?sec=66 App Exchange], la tabla '''Aplicaciones con App Exchange''' le mostrará las estadísticas de acciones de sus aplicaciones.

*'''Impresiones entregadas''': impresiones o visualizaciones de auto-promociones en los espacios de la aplicación.
*'''Impresiones recibidas''': visualizaciones de auto-promociones de la aplicación mostradas en otras aplicaciones.
*'''Clicks entregados''': clicks realizados en las Impresiones entregadas.
*'''Clicks recibidos''': clicks realizados en las Impresiones recibidas.
*'''Descargas entregadas''': descargas de otras aplicaciones a través de sus auto-promociones.
*'''Descargas recibidas''': descargas de sus aplicaciones a través de auto-promociones de otros desarrolladores.

[[Archivo: Appex_stat.png |center]]

En cada campo de estadísticas se mostrarán, si es que lo hay, el número total de acciones, el valor del número de acciones que corresponden a auto-promociones de aplicaciones externas, así como el valor correspondiente a cada aplicación propia.

Documentación Webservice NickCenter

2019-06-07T10:31:34Z

Deneb: /* Campos y Formatos */

=Introduccion=
En ésta documentación se expondrá como deberemos hacer uso del Webservice de NickCenter, de manera que emule la propia librería de NickCenter y así no haya la necesidad de usarla ni implementarla en las aplicaciones. A pesar de ello, la configuración en nuestro panel será la misma, siendo necesario dar de alta la aplicación en éste, y configurandola para el uso de NickCenter. Podremos hacer uso de dicho Webservice de dos maneras:
#Llamada directa al Webservice. Ésta opción será menos segura debido a que los datos irán sin cifrar.
#Usando la clase '''spsApiNickcenter'''. Esta opción será mas segura ya que cuenta con un cifrado mediante RSA Keys generadas en nuestro sistema.

=Conexión con el Webservice=
La conexión con el Webservice se puede realizar de dos maneras:
#Mediante llamada directa al Webservice. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa==
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''analyticsConnection''', esta será la URL a la que deberemos conectarnos mediante POST ''https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=''. Más adelante se expondrán que tareas hay disponibles y como hay que mandar los datos para su ejecución.
:*''Ejemplo de petición directa con task (tarea) '''checkActive''', una app concreta (añadiendo el hash que le correspondiera) y country (país) '''ES''' (España):''
<source lang="PHP">
$url = 'https://nickcenter.mobeleader.com/webservice_nickcenter.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode('task=checkActive&app=my_app_hash&country=ES'));
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en nuestra carpeta vendor, lo primero que debemos hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Una vez modificada la ruta, para poder instanciar la clase deberemos coger la cadena de la '''RSA KEY Privada''', accesible desde [https://panel.mobeleader.com/index.php?sec=6 nuestro panel], y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
</source>
 
Si la instalación de la librería es correcta, la ruta de acceso a ésta ha sido cambiada y es correcta, y la '''RSA KEY Privada''' es correcta, para realizar las llamadas al Webservice usaremos la funcion '''getWebserviceData()''' de la clase '''spsApiConnection'''. Dicha función será la encargada de realizar todas las conexiones al Webservice, de cifrar los datos que enviaremos a éste y de descifrar los que datos que nos retorne.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getWebserviceData(tarea, array_datos)
</source>
 
A continuación se exponen cuales son las distintas tareas ejecutables, y como ha de ser el array de datos para posibilitar dicha ejecución.

=Tareas=
La clase '''spsApiConnection''' consta de la función ''getData('''tarea, array_datos''')'', con la que ejecutaremos las distintas operaciones que el Webservice permite y a la que le deberemos mandar los siguientes parámetros:
#'''tarea:''' Sera la propia tarea a realizar, puediendo ser:
##'''checkActive'''.
##'''requestFields'''.
##'''register'''.
##'''update'''.
##'''login'''.
##'''rescuePassword'''.
#'''array_datos:''' Contendrá un array con los datos necesarios para la ejecución de la tarea.
===Llamadas al Webservice===
''Recuerde reemplazar el contenido de los ejemplos por los valores reales''.
*'''checkActive:''' Esta tarea comprobará que la aplicación tenga NickCenter activo, independientemente de usarla directamente o no, el resto de tareas harán uso de ella antes de realizar sus operaciones propias.
:*'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
:*'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=checkActive&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('checkActive', $array_datos);
</source>
 
*'''requestFields:''' Mediante ésta tarea obtendremos la configuración de campos y traducciones para una determinada vista.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''view:''' Indicará los campos de que vista solicitamos.
***'''register:''' Pantalla inicial del registro.
***'''login:''' Pantalla de login.
***'''rescue:''' Pantalla de recuperación de contraseña.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones y las configuraciones de los campos que se retornarán.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=requestFields&app=[hash aplicacion, ej: 1234567890ABCDEF]&view=[vista, ej: register]&country=[código país, ej: ES]&language=[código idioma, ej: es]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['view'] = [vista, ej: register];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('requestFields', $array_datos);
</source>
 
*'''register:''' Esta tarea servirá para registrar un usuario en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=register&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a registrar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a registrar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('register', $array_datos);
</source>
 
*'''update:''' Esta tarea servirá para actualizar un usuario que previamente haya sido registrado en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=update&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a actualizar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a actualizar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('update', $array_datos);
</source>
 
*'''login:''' Esta tarea servirá para hacer login en las aplicaciones registradas en NickCenter, con usuarios previamente registrados en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=login&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información necesaria para el login]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información necesaria para el login];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('login', $array_datos);
</source>
 
*'''rescuePassword:''' Mediante ésta tarea restauraremos la contraseña de usuarios previamente registrados en nuestro sistema y que no esten dados de baja.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones que se retornarán.
**'''email:''' Email al que hay que restaurar la contraseña.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=rescuePassword&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]&language=[código idioma, ej: es]&email=[email a recuperar, ej: prueba@prueba.com]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];
$array_datos['email'] = [email a recuperar, ej: prueba@prueba.com];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('rescuePassword', $array_datos);
</source>

===Retornos del Webservice===
Cada tarea tendrá su propio JSON de retorno:
*'''checkActive:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''active:''' Indicará si la aplicación esta activa o no.
 
*'''requestFields:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''general:''' En caso de no haber ningún error devolverá un array con todas las traducciones generales para el idioma seleccionado.
**'''fields:''' En caso de no haber ningún error devolverá un array con todos los campos y sus traducciones para el idioma seleccionado.
 
*'''register:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que el registro se ha completado.
 
*'''update:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha actualizado correctamente.
 
*'''login:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha logeado correctamente.
 
*'''rescuePassword:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de que no haya habido un error, se mandará una cadena en el idioma seleccionado, con las instrucciones para recuperar la contraseña.

=Campos y Formatos=
*'''jsonDevice:'''
**'''ua:''' User Agent. Es la cadena de texto que identifica al usuario ante el servidor que se esta conectando mediante HTTP. '''Campo obligatorio.'''
**'''lmt:''' Limit Ad Tracking. Indicará si esta permitido el acceso al ifa del dispositivo. '''Campo obligatorio.'''
***'''0:''' Inactivo/Permitido.
***'''1:''' Activo/No permitido.
**'''devicetype:''' Tipo de dispositivo. '''Campo obligatorio.'''
***'''4:''' Smartphone.
***'''5:''' Tablet/iPad.
**'''make:''' Marca del dispositivo. ''Ejemplo: bq''. '''Campo obligatorio.'''
**'''model:''' Modelo del dispositivo. ''Ejemplo: Aquaris E5''. '''Campo obligatorio.'''
**'''os:''' Sistema operativo. '''Campo obligatorio.'''
***'''Android:''' Android.
***'''iOs:''' ios.
**'''osv:''' Version del sistema operativo. ''Ejemplo: 6.0.1''. '''Campo obligatorio.'''
**'''hwv:''' Version del hardware. ''Ejemplo: Aquaris_E5''. '''Campo obligatorio.'''
**'''h:''' Altura de pantalla. ''Ejemplo: 1920''. '''Campo obligatorio.'''
**'''w:''' Anchura de pantalla. ''Ejemplo: 1080''. '''Campo obligatorio.'''
**'''ppi:''' Pixeles por pulgada. ''Ejemplo: 480''. '''Campo obligatorio.'''
**'''pxratio:''' Densidad de pixeles. ''Ejemplo: 3''. '''Campo obligatorio.'''
**'''inches:''' Pulgadas. ''Ejemplo: 4.9''. '''Campo obligatorio.'''
**'''js:''' Soporte para JavaScript. '''Campo obligatorio.'''
***'''0:''' No.
***'''1:''' Si.
**'''connectiontype:''' Tipo de conexión. '''Campo obligatorio.'''
***'''0:''' Unknown.
***'''1:''' Ethernet.
***'''2:''' WiFI.
***'''3:''' Cellular Network - Unkown Generation.
***'''4:''' Cellular Network - 2G.
***'''5:''' Cellular Network - 3G.
***'''6:''' Cellular Network - 4G.
**'''ifa:''' Identificador para la publicidad. '''Campo obligatorio, debe de estar o el ifa o el uuid.'''
***'''Android:''' Google AID (Google Advertising Identifier). ''Ejemplo: 38400000-8cf0-11bd-b23e-10b96e40000d''.
***'''iOs:''' iOS IFA (Apple Identifier for Advertiser). ''Ejemplo: AAAAAAAAA-BBBB-CCCC-1111-222222220000''.
**'''uuid:''' Identificador único universal. ''Ejemplo: 550e8400-e29b-41d4-a716-446655440000''. '''Campo obligatorio, debe estar el uuid o el ifa.'''
**'''language:''' Idioma del dispositivo ( locale ). ''Ejemplo: es''. '''Campo obligatorio.'''
**'''country:''' Pais del dispositivo ( locale ). ''Ejemplo: ES''. '''Campo obligatorio.'''
**'''carrier:''' Operador Telefónico del dispositivo. ''Ejemplo: Movistar''.
**'''carriercode:''' Código del operador telefónico. ''Ejemplo: 21407''.
**'''carriercountry:''' País del operador telefónico. ''Ejemplo: ES''.
**'''mac: ( Solo para Android )''' Mac del dispositivo. ''Ejemplo: 00:1B:44:11:3A:B7''.
**'''imsi: ( Solo para Android )''' Identidad Internacional del Abonado Móvil. ''Ejemplo: 7160652952503786''.
**'''did: ( Solo para Android )''' Identificador Direct inward dialing (DID).
**'''dpid: ( Solo para Android )''' Plataform device id (Android id).
 
*'''jsonUser:'''
**'''name:''' Nombre del usuario. Máximo 100 caracteres. ''Ejemplo: John''.
**'''surname:''' Apellido del usuario. Máximo 100 caracteres. ''Ejemplo: Smith''.
**'''email:''' Email del usuario. Máximo 250 caracteres. ''Ejemplo: xxxx@xxx.com''.
**'''password:''' Password del usuario. Deberá ir en md5(). Máximo 50 caracteres. ''Ejemplo: e10adc3949ba59abbe56e057f20f883e''.
**'''nick:''' Nick del usuario. Máximo 50 caracteres. ''Ejemplo: CocoNilo''.
**'''phone:''' Teléfono móvil del usuario. Máximo 15 caracteres. ''Ejemplo: 6XX XXX XXX''.
**'''birthDate:''' Fecha de nacimiento del usuario. ''Ejemplo : 1992-01-12''.
**'''gender:''' Sexo del usuario.
***'''Masculino:''' M.
***'''Femenino:''' F.
**'''allowsCommercials:''' Termino de privacidad con el que el usuario permite recibir comunicaciones comerciales.
***'''Permite:''' yes.
***'''Deniega:''' no.
**'''allowsCession:''' Termino de privacidad con el que el usuario permite que sus datos sean cedidos a terceras empresas relacionadas con el sector.
***'''Permite:''' yes.
***'''Deniega:''' no.
**Dependiendo de la tarea que estemos ejecutando los campos obligatorios variarán:
***'''register:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, como mínimo siempre será obligatorio el '''email''' y el '''password'''.
***'''update:''' El único campo obligatorio para las actualizaciones será el '''email''', el resto de campos que se añadan serán los campos a actualizar.
***'''login:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, será obligatorio el '''email''' o el '''nick''', junto con el '''password'''. En cualquiera de los casos el '''password''' siempre será obligatorio.
 
*'''jsonApp''': Todos los campos son obligatorios
**'''name''': Nombre de la aplicación dada de alta en nuestro panel. ''Ejemplo: MyApp''.
**'''bundle''': Nombre del paquete de la aplicación. ''Ejemplo: com.mypackage''.
**'''version''': Version de la aplicación. ''Ejemplo: 1.0''.
**'''versioncode''': Código de versión de la aplicación. ''Ejemplo: 1''.

=Códigos de Errores=
A continuación se expondrá una lista con los posibles errores que devolverá el Webservice en caso de que los datos no sean correctos:

*'''Errores generales:''' Estos errores se deben a un mal uso de la clase '''spsApiNickcenter''' y/o su cifrado, por lo que al no poder devolver la cadena cifrada con la RSA Key pública que le corresponde a la aplicación, se mandarán en texto plano sin cifrar y sin formato JSON.
**Error 000a - Failure decrypting
**Error 000b - Invalid Task
**Error 000c - Empty or invalid app hash
**Error 000d - Missing public RSA Key for app hash X
 
*'''Tarea checkActive:'''
**Error 001a - Failure checking app active
**Error 001b - Failure checking app active
**Error 001c - Failure checking app active
 
*'''Tarea rescuePassword:'''
**Error 002a - Failure on rescuePassword
**Error 002b - Failure on rescuePassword
 
*'''Tarea requestFields:'''
**Error 003a - Failure on requestFields
**Error 003b - Failure on requestFields
**Error 003c - Failure on requestFields
 
*'''Tarea register/update/login:'''
**Error 004a - Failure validating user json, there are no fields configured in your application
**Error 004b - Failure validating user json, incorrect json format
**Error 004c - Failure validating user json
**Error 004d - X is missing or empty in user json.
**Error 004e - Invalid format for X field in user json.
 
*'''Tarea register/update/login:'''
**Error 005a - Failure validating device json, incorrect json format
**Error 005b - Failure validating device json
**Error 005c - Field X is missing or empty in device json
**Error 005c - Field ifa/uuid are missing or empty in device json, one of them must be informed
 
*'''Tarea register/update/login:'''
**Error 006a - Failure validating app json, incorrect json format
**Error 006b - Field X is empty in app json
**Error 006c - The bundle X for os Y, does not exist
**Error 006c - Invalid X in app json, it must be numeric
 
*'''Tarea register/update/login:'''
**Error 007a - Failure generating library json, incorrect device json format
**Error 007b - Failure generating library json, wrong os in device json
**Error 007c - Failure generating library json, wrong os in device json
 
*'''Tarea register:'''
**Error 008a - Failure registering
**Error 008b - Failure registering
**Error 008c - Email already exists
**Error 008c - Nick already exists
 
*'''Tarea login:'''
**Error 009 - Failure on login
 
*'''Tarea update:'''
**Error 010 - Failure updating
 
*'''Sin tarea/Tarea erronea:'''
**Error 011a - Empty Task
**Error 011b - Invalid Task

Documentación Webservice NickCenter

2019-06-07T10:29:41Z

Deneb: /* Llamadas al Webservice */

=Introduccion=
En ésta documentación se expondrá como deberemos hacer uso del Webservice de NickCenter, de manera que emule la propia librería de NickCenter y así no haya la necesidad de usarla ni implementarla en las aplicaciones. A pesar de ello, la configuración en nuestro panel será la misma, siendo necesario dar de alta la aplicación en éste, y configurandola para el uso de NickCenter. Podremos hacer uso de dicho Webservice de dos maneras:
#Llamada directa al Webservice. Ésta opción será menos segura debido a que los datos irán sin cifrar.
#Usando la clase '''spsApiNickcenter'''. Esta opción será mas segura ya que cuenta con un cifrado mediante RSA Keys generadas en nuestro sistema.

=Conexión con el Webservice=
La conexión con el Webservice se puede realizar de dos maneras:
#Mediante llamada directa al Webservice. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa==
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''analyticsConnection''', esta será la URL a la que deberemos conectarnos mediante POST ''https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=''. Más adelante se expondrán que tareas hay disponibles y como hay que mandar los datos para su ejecución.
:*''Ejemplo de petición directa con task (tarea) '''checkActive''', una app concreta (añadiendo el hash que le correspondiera) y country (país) '''ES''' (España):''
<source lang="PHP">
$url = 'https://nickcenter.mobeleader.com/webservice_nickcenter.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode('task=checkActive&app=my_app_hash&country=ES'));
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en nuestra carpeta vendor, lo primero que debemos hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Una vez modificada la ruta, para poder instanciar la clase deberemos coger la cadena de la '''RSA KEY Privada''', accesible desde [https://panel.mobeleader.com/index.php?sec=6 nuestro panel], y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
</source>
 
Si la instalación de la librería es correcta, la ruta de acceso a ésta ha sido cambiada y es correcta, y la '''RSA KEY Privada''' es correcta, para realizar las llamadas al Webservice usaremos la funcion '''getWebserviceData()''' de la clase '''spsApiConnection'''. Dicha función será la encargada de realizar todas las conexiones al Webservice, de cifrar los datos que enviaremos a éste y de descifrar los que datos que nos retorne.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getWebserviceData(tarea, array_datos)
</source>
 
A continuación se exponen cuales son las distintas tareas ejecutables, y como ha de ser el array de datos para posibilitar dicha ejecución.

=Tareas=
La clase '''spsApiConnection''' consta de la función ''getData('''tarea, array_datos''')'', con la que ejecutaremos las distintas operaciones que el Webservice permite y a la que le deberemos mandar los siguientes parámetros:
#'''tarea:''' Sera la propia tarea a realizar, puediendo ser:
##'''checkActive'''.
##'''requestFields'''.
##'''register'''.
##'''update'''.
##'''login'''.
##'''rescuePassword'''.
#'''array_datos:''' Contendrá un array con los datos necesarios para la ejecución de la tarea.
===Llamadas al Webservice===
''Recuerde reemplazar el contenido de los ejemplos por los valores reales''.
*'''checkActive:''' Esta tarea comprobará que la aplicación tenga NickCenter activo, independientemente de usarla directamente o no, el resto de tareas harán uso de ella antes de realizar sus operaciones propias.
:*'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
:*'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=checkActive&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('checkActive', $array_datos);
</source>
 
*'''requestFields:''' Mediante ésta tarea obtendremos la configuración de campos y traducciones para una determinada vista.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''view:''' Indicará los campos de que vista solicitamos.
***'''register:''' Pantalla inicial del registro.
***'''login:''' Pantalla de login.
***'''rescue:''' Pantalla de recuperación de contraseña.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones y las configuraciones de los campos que se retornarán.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=requestFields&app=[hash aplicacion, ej: 1234567890ABCDEF]&view=[vista, ej: register]&country=[código país, ej: ES]&language=[código idioma, ej: es]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['view'] = [vista, ej: register];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('requestFields', $array_datos);
</source>
 
*'''register:''' Esta tarea servirá para registrar un usuario en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=register&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a registrar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a registrar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('register', $array_datos);
</source>
 
*'''update:''' Esta tarea servirá para actualizar un usuario que previamente haya sido registrado en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=update&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a actualizar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a actualizar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('update', $array_datos);
</source>
 
*'''login:''' Esta tarea servirá para hacer login en las aplicaciones registradas en NickCenter, con usuarios previamente registrados en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=login&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información necesaria para el login]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información necesaria para el login];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('login', $array_datos);
</source>
 
*'''rescuePassword:''' Mediante ésta tarea restauraremos la contraseña de usuarios previamente registrados en nuestro sistema y que no esten dados de baja.
**'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones que se retornarán.
**'''email:''' Email al que hay que restaurar la contraseña.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=rescuePassword&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]&language=[código idioma, ej: es]&email=[email a recuperar, ej: prueba@prueba.com]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];
$array_datos['email'] = [email a recuperar, ej: prueba@prueba.com];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('rescuePassword', $array_datos);
</source>

===Retornos del Webservice===
Cada tarea tendrá su propio JSON de retorno:
*'''checkActive:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''active:''' Indicará si la aplicación esta activa o no.
 
*'''requestFields:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''general:''' En caso de no haber ningún error devolverá un array con todas las traducciones generales para el idioma seleccionado.
**'''fields:''' En caso de no haber ningún error devolverá un array con todos los campos y sus traducciones para el idioma seleccionado.
 
*'''register:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que el registro se ha completado.
 
*'''update:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha actualizado correctamente.
 
*'''login:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha logeado correctamente.
 
*'''rescuePassword:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de que no haya habido un error, se mandará una cadena en el idioma seleccionado, con las instrucciones para recuperar la contraseña.

=Campos y Formatos=
*'''jsonDevice:'''
**'''ua:''' User Agent. Es la cadena de texto que identifica al usuario ante el servidor que se esta conectando mediante HTTP. '''Campo obligatorio.'''
**'''lmt:''' Limit Ad Tracking. Indicará si esta permitido el acceso al ifa del dispositivo. '''Campo obligatorio.'''
***'''0:''' Inactivo/Permitido.
***'''1:''' Activo/No permitido.
**'''devicetype:''' Tipo de dispositivo. '''Campo obligatorio.'''
***'''4:''' Smartphone.
***'''5:''' Tablet/iPad.
**'''make:''' Marca del dispositivo. ''Ejemplo: bq''. '''Campo obligatorio.'''
**'''model:''' Modelo del dispositivo. ''Ejemplo: Aquaris E5''. '''Campo obligatorio.'''
**'''os:''' Sistema operativo. '''Campo obligatorio.'''
***'''Android:''' Android.
***'''iOs:''' ios.
**'''osv:''' Version del sistema operativo. ''Ejemplo: 6.0.1''. '''Campo obligatorio.'''
**'''hwv:''' Version del hardware. ''Ejemplo: Aquaris_E5''. '''Campo obligatorio.'''
**'''h:''' Altura de pantalla. ''Ejemplo: 1920''. '''Campo obligatorio.'''
**'''w:''' Anchura de pantalla. ''Ejemplo: 1080''. '''Campo obligatorio.'''
**'''ppi:''' Pixeles por pulgada. ''Ejemplo: 480''. '''Campo obligatorio.'''
**'''pxratio:''' Densidad de pixeles. ''Ejemplo: 3''. '''Campo obligatorio.'''
**'''inches:''' Pulgadas. ''Ejemplo: 4.9''. '''Campo obligatorio.'''
**'''js:''' Soporte para JavaScript. '''Campo obligatorio.'''
***'''0:''' No.
***'''1:''' Si.
**'''connectiontype:''' Tipo de conexión. '''Campo obligatorio.'''
***'''0:''' Unknown.
***'''1:''' Ethernet.
***'''2:''' WiFI.
***'''3:''' Cellular Network - Unkown Generation.
***'''4:''' Cellular Network - 2G.
***'''5:''' Cellular Network - 3G.
***'''6:''' Cellular Network - 4G.
**'''ifa:''' Identificador para la publicidad. '''Campo obligatorio, debe de estar o el ifa o el uuid.'''
***'''Android:''' Google AID (Google Advertising Identifier). ''Ejemplo: 38400000-8cf0-11bd-b23e-10b96e40000d''.
***'''iOs:''' iOS IFA (Apple Identifier for Advertiser). ''Ejemplo: AAAAAAAAA-BBBB-CCCC-1111-222222220000''.
**'''uuid:''' Identificador único universal. ''Ejemplo: 550e8400-e29b-41d4-a716-446655440000''. '''Campo obligatorio, debe estar el uuid o el ifa.'''
**'''language:''' Idioma del dispositivo ( locale ). ''Ejemplo: es''. '''Campo obligatorio.'''
**'''country:''' Pais del dispositivo ( locale ). ''Ejemplo: ES''. '''Campo obligatorio.'''
**'''carrier:''' Operador Telefónico del dispositivo. ''Ejemplo: Movistar''.
**'''carriercode:''' Código del operador telefónico. ''Ejemplo: 21407''.
**'''carriercountry:''' País del operador telefónico. ''Ejemplo: ES''.
**'''mac: ( Solo para Android )''' Mac del dispositivo. ''Ejemplo: 00:1B:44:11:3A:B7''.
**'''imsi: ( Solo para Android )''' Identidad Internacional del Abonado Móvil. ''Ejemplo: 7160652952503786''.
**'''did: ( Solo para Android )''' Identificador Direct inward dialing (DID).
**'''dpid: ( Solo para Android )''' Plataform device id (Android id).
 
*'''jsonUser:'''
**'''name:''' Nombre del usuario. Máximo 100 caracteres. ''Ejemplo: Kevin''.
**'''surname:''' Apellido del usuario. Máximo 100 caracteres. ''Ejemplo: Lancharro''.
**'''email:''' Email del usuario. Máximo 250 caracteres. ''Ejemplo: xxxx@xxx.com''.
**'''password:''' Password del usuario. Deberá ir en md5(). Máximo 50 caracteres. ''Ejemplo: e10adc3949ba59abbe56e057f20f883e''.
**'''nick:''' Nick del usuario. Máximo 50 caracteres. ''Ejemplo: CocoNilo''.
**'''phone:''' Teléfono móvil del usuario. Máximo 15 caracteres. ''Ejemplo: 6XX XXX XXX''.
**'''birthDate:''' Fecha de nacimiento del usuario. ''Ejemplo : 1992-01-12''.
**'''gender:''' Sexo del usuario.
***'''Masculino:''' M.
***'''Femenino:''' F.
**'''allowsCommercials:''' Termino de privacidad con el que el usuario permite recibir comunicaciones comerciales.
***'''Permite:''' yes.
***'''Deniega:''' no.
**'''allowsCession:''' Termino de privacidad con el que el usuario permite que sus datos sean cedidos a terceras empresas relacionadas con el sector.
***'''Permite:''' yes.
***'''Deniega:''' no.
**Dependiendo de la tarea que estemos ejecutando los campos obligatorios variarán:
***'''register:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, como mínimo siempre será obligatorio el '''email''' y el '''password'''.
***'''update:''' El único campo obligatorio para las actualizaciones será el '''email''', el resto de campos que se añadan serán los campos a actualizar.
***'''login:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, será obligatorio el '''email''' o el '''nick''', junto con el '''password'''. En cualquiera de los casos el '''password''' siempre será obligatorio.
 
*'''jsonApp''': Todos los campos son obligatorios
**'''name''': Nombre de la aplicación dada de alta en el panel de Mobeleader. ''Ejemplo: Mobeleader''.
**'''bundle''': Nombre del paquete de la aplicación. ''Ejemplo: com.mobeleader''.
**'''version''': Version de la aplicación. ''Ejemplo: 1.0''.
**'''versioncode''': Código de versión de la aplicación. ''Ejemplo: 1''.

=Códigos de Errores=
A continuación se expondrá una lista con los posibles errores que devolverá el Webservice en caso de que los datos no sean correctos:

*'''Errores generales:''' Estos errores se deben a un mal uso de la clase '''spsApiNickcenter''' y/o su cifrado, por lo que al no poder devolver la cadena cifrada con la RSA Key pública que le corresponde a la aplicación, se mandarán en texto plano sin cifrar y sin formato JSON.
**Error 000a - Failure decrypting
**Error 000b - Invalid Task
**Error 000c - Empty or invalid app hash
**Error 000d - Missing public RSA Key for app hash X
 
*'''Tarea checkActive:'''
**Error 001a - Failure checking app active
**Error 001b - Failure checking app active
**Error 001c - Failure checking app active
 
*'''Tarea rescuePassword:'''
**Error 002a - Failure on rescuePassword
**Error 002b - Failure on rescuePassword
 
*'''Tarea requestFields:'''
**Error 003a - Failure on requestFields
**Error 003b - Failure on requestFields
**Error 003c - Failure on requestFields
 
*'''Tarea register/update/login:'''
**Error 004a - Failure validating user json, there are no fields configured in your application
**Error 004b - Failure validating user json, incorrect json format
**Error 004c - Failure validating user json
**Error 004d - X is missing or empty in user json.
**Error 004e - Invalid format for X field in user json.
 
*'''Tarea register/update/login:'''
**Error 005a - Failure validating device json, incorrect json format
**Error 005b - Failure validating device json
**Error 005c - Field X is missing or empty in device json
**Error 005c - Field ifa/uuid are missing or empty in device json, one of them must be informed
 
*'''Tarea register/update/login:'''
**Error 006a - Failure validating app json, incorrect json format
**Error 006b - Field X is empty in app json
**Error 006c - The bundle X for os Y, does not exist
**Error 006c - Invalid X in app json, it must be numeric
 
*'''Tarea register/update/login:'''
**Error 007a - Failure generating library json, incorrect device json format
**Error 007b - Failure generating library json, wrong os in device json
**Error 007c - Failure generating library json, wrong os in device json
 
*'''Tarea register:'''
**Error 008a - Failure registering
**Error 008b - Failure registering
**Error 008c - Email already exists
**Error 008c - Nick already exists
 
*'''Tarea login:'''
**Error 009 - Failure on login
 
*'''Tarea update:'''
**Error 010 - Failure updating
 
*'''Sin tarea/Tarea erronea:'''
**Error 011a - Empty Task
**Error 011b - Invalid Task

Documentación Webservice NickCenter

2019-06-07T10:27:54Z

Deneb: /* Llamadas al Webservice */

=Introduccion=
En ésta documentación se expondrá como deberemos hacer uso del Webservice de NickCenter, de manera que emule la propia librería de NickCenter y así no haya la necesidad de usarla ni implementarla en las aplicaciones. A pesar de ello, la configuración en nuestro panel será la misma, siendo necesario dar de alta la aplicación en éste, y configurandola para el uso de NickCenter. Podremos hacer uso de dicho Webservice de dos maneras:
#Llamada directa al Webservice. Ésta opción será menos segura debido a que los datos irán sin cifrar.
#Usando la clase '''spsApiNickcenter'''. Esta opción será mas segura ya que cuenta con un cifrado mediante RSA Keys generadas en nuestro sistema.

=Conexión con el Webservice=
La conexión con el Webservice se puede realizar de dos maneras:
#Mediante llamada directa al Webservice. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa==
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''analyticsConnection''', esta será la URL a la que deberemos conectarnos mediante POST ''https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=''. Más adelante se expondrán que tareas hay disponibles y como hay que mandar los datos para su ejecución.
:*''Ejemplo de petición directa con task (tarea) '''checkActive''', una app concreta (añadiendo el hash que le correspondiera) y country (país) '''ES''' (España):''
<source lang="PHP">
$url = 'https://nickcenter.mobeleader.com/webservice_nickcenter.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode('task=checkActive&app=my_app_hash&country=ES'));
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en nuestra carpeta vendor, lo primero que debemos hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Una vez modificada la ruta, para poder instanciar la clase deberemos coger la cadena de la '''RSA KEY Privada''', accesible desde [https://panel.mobeleader.com/index.php?sec=6 nuestro panel], y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
</source>
 
Si la instalación de la librería es correcta, la ruta de acceso a ésta ha sido cambiada y es correcta, y la '''RSA KEY Privada''' es correcta, para realizar las llamadas al Webservice usaremos la funcion '''getWebserviceData()''' de la clase '''spsApiConnection'''. Dicha función será la encargada de realizar todas las conexiones al Webservice, de cifrar los datos que enviaremos a éste y de descifrar los que datos que nos retorne.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getWebserviceData(tarea, array_datos)
</source>
 
A continuación se exponen cuales son las distintas tareas ejecutables, y como ha de ser el array de datos para posibilitar dicha ejecución.

=Tareas=
La clase '''spsApiConnection''' consta de la función ''getData('''tarea, array_datos''')'', con la que ejecutaremos las distintas operaciones que el Webservice permite y a la que le deberemos mandar los siguientes parámetros:
#'''tarea:''' Sera la propia tarea a realizar, puediendo ser:
##'''checkActive'''.
##'''requestFields'''.
##'''register'''.
##'''update'''.
##'''login'''.
##'''rescuePassword'''.
#'''array_datos:''' Contendrá un array con los datos necesarios para la ejecución de la tarea.
===Llamadas al Webservice===
''Recuerde reemplazar el contenido de los ejemplos por los valores reales''.
*'''checkActive:''' Esta tarea comprobará que la aplicación tenga NickCenter activo, independientemente de usarla directamente o no, el resto de tareas harán uso de ella antes de realizar sus operaciones propias.
:*'''app:''' Contendrá el hash de la aplicación dada de alta en nuestro panel.
:*'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=checkActive&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('checkActive', $array_datos);
</source>
 
*'''requestFields:''' Mediante ésta tarea obtendremos la configuración de campos y traducciones para una determinada vista.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''view:''' Indicará los campos de que vista solicitamos.
***'''register:''' Pantalla inicial del registro.
***'''login:''' Pantalla de login.
***'''rescue:''' Pantalla de recuperación de contraseña.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones y las configuraciones de los campos que se retornarán.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=requestFields&app=[hash aplicacion, ej: 1234567890ABCDEF]&view=[vista, ej: register]&country=[código país, ej: ES]&language=[código idioma, ej: es]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['view'] = [vista, ej: register];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('requestFields', $array_datos);
</source>
 
*'''register:''' Esta tarea servirá para registrar un usuario en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=register&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a registrar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a registrar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('register', $array_datos);
</source>
 
*'''update:''' Esta tarea servirá para actualizar un usuario que previamente haya sido registrado en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=update&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a actualizar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a actualizar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('update', $array_datos);
</source>
 
*'''login:''' Esta tarea servirá para hacer login en las aplicaciones registradas en NickCenter, con usuarios previamente registrados en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta el panel de en Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=login&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información necesaria para el login]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información necesaria para el login];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('login', $array_datos);
</source>
 
*'''rescuePassword:''' Mediante ésta tarea restauraremos la contraseña de usuarios previamente registrados en nuestro sistema y que no esten dados de baja.
**'''app:''' Contendrá el hash de la aplicación dada de alta el panel de en Mobeleader.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones que se retornarán.
**'''email:''' Email al que hay que restaurar la contraseña.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=rescuePassword&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]&language=[código idioma, ej: es]&email=[email a recuperar, ej: prueba@prueba.com]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];
$array_datos['email'] = [email a recuperar, ej: prueba@prueba.com];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('rescuePassword', $array_datos);
</source>

===Retornos del Webservice===
Cada tarea tendrá su propio JSON de retorno:
*'''checkActive:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''active:''' Indicará si la aplicación esta activa o no.
 
*'''requestFields:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''general:''' En caso de no haber ningún error devolverá un array con todas las traducciones generales para el idioma seleccionado.
**'''fields:''' En caso de no haber ningún error devolverá un array con todos los campos y sus traducciones para el idioma seleccionado.
 
*'''register:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que el registro se ha completado.
 
*'''update:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha actualizado correctamente.
 
*'''login:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha logeado correctamente.
 
*'''rescuePassword:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de que no haya habido un error, se mandará una cadena en el idioma seleccionado, con las instrucciones para recuperar la contraseña.

=Campos y Formatos=
*'''jsonDevice:'''
**'''ua:''' User Agent. Es la cadena de texto que identifica al usuario ante el servidor que se esta conectando mediante HTTP. '''Campo obligatorio.'''
**'''lmt:''' Limit Ad Tracking. Indicará si esta permitido el acceso al ifa del dispositivo. '''Campo obligatorio.'''
***'''0:''' Inactivo/Permitido.
***'''1:''' Activo/No permitido.
**'''devicetype:''' Tipo de dispositivo. '''Campo obligatorio.'''
***'''4:''' Smartphone.
***'''5:''' Tablet/iPad.
**'''make:''' Marca del dispositivo. ''Ejemplo: bq''. '''Campo obligatorio.'''
**'''model:''' Modelo del dispositivo. ''Ejemplo: Aquaris E5''. '''Campo obligatorio.'''
**'''os:''' Sistema operativo. '''Campo obligatorio.'''
***'''Android:''' Android.
***'''iOs:''' ios.
**'''osv:''' Version del sistema operativo. ''Ejemplo: 6.0.1''. '''Campo obligatorio.'''
**'''hwv:''' Version del hardware. ''Ejemplo: Aquaris_E5''. '''Campo obligatorio.'''
**'''h:''' Altura de pantalla. ''Ejemplo: 1920''. '''Campo obligatorio.'''
**'''w:''' Anchura de pantalla. ''Ejemplo: 1080''. '''Campo obligatorio.'''
**'''ppi:''' Pixeles por pulgada. ''Ejemplo: 480''. '''Campo obligatorio.'''
**'''pxratio:''' Densidad de pixeles. ''Ejemplo: 3''. '''Campo obligatorio.'''
**'''inches:''' Pulgadas. ''Ejemplo: 4.9''. '''Campo obligatorio.'''
**'''js:''' Soporte para JavaScript. '''Campo obligatorio.'''
***'''0:''' No.
***'''1:''' Si.
**'''connectiontype:''' Tipo de conexión. '''Campo obligatorio.'''
***'''0:''' Unknown.
***'''1:''' Ethernet.
***'''2:''' WiFI.
***'''3:''' Cellular Network - Unkown Generation.
***'''4:''' Cellular Network - 2G.
***'''5:''' Cellular Network - 3G.
***'''6:''' Cellular Network - 4G.
**'''ifa:''' Identificador para la publicidad. '''Campo obligatorio, debe de estar o el ifa o el uuid.'''
***'''Android:''' Google AID (Google Advertising Identifier). ''Ejemplo: 38400000-8cf0-11bd-b23e-10b96e40000d''.
***'''iOs:''' iOS IFA (Apple Identifier for Advertiser). ''Ejemplo: AAAAAAAAA-BBBB-CCCC-1111-222222220000''.
**'''uuid:''' Identificador único universal. ''Ejemplo: 550e8400-e29b-41d4-a716-446655440000''. '''Campo obligatorio, debe estar el uuid o el ifa.'''
**'''language:''' Idioma del dispositivo ( locale ). ''Ejemplo: es''. '''Campo obligatorio.'''
**'''country:''' Pais del dispositivo ( locale ). ''Ejemplo: ES''. '''Campo obligatorio.'''
**'''carrier:''' Operador Telefónico del dispositivo. ''Ejemplo: Movistar''.
**'''carriercode:''' Código del operador telefónico. ''Ejemplo: 21407''.
**'''carriercountry:''' País del operador telefónico. ''Ejemplo: ES''.
**'''mac: ( Solo para Android )''' Mac del dispositivo. ''Ejemplo: 00:1B:44:11:3A:B7''.
**'''imsi: ( Solo para Android )''' Identidad Internacional del Abonado Móvil. ''Ejemplo: 7160652952503786''.
**'''did: ( Solo para Android )''' Identificador Direct inward dialing (DID).
**'''dpid: ( Solo para Android )''' Plataform device id (Android id).
 
*'''jsonUser:'''
**'''name:''' Nombre del usuario. Máximo 100 caracteres. ''Ejemplo: Kevin''.
**'''surname:''' Apellido del usuario. Máximo 100 caracteres. ''Ejemplo: Lancharro''.
**'''email:''' Email del usuario. Máximo 250 caracteres. ''Ejemplo: xxxx@xxx.com''.
**'''password:''' Password del usuario. Deberá ir en md5(). Máximo 50 caracteres. ''Ejemplo: e10adc3949ba59abbe56e057f20f883e''.
**'''nick:''' Nick del usuario. Máximo 50 caracteres. ''Ejemplo: CocoNilo''.
**'''phone:''' Teléfono móvil del usuario. Máximo 15 caracteres. ''Ejemplo: 6XX XXX XXX''.
**'''birthDate:''' Fecha de nacimiento del usuario. ''Ejemplo : 1992-01-12''.
**'''gender:''' Sexo del usuario.
***'''Masculino:''' M.
***'''Femenino:''' F.
**'''allowsCommercials:''' Termino de privacidad con el que el usuario permite recibir comunicaciones comerciales.
***'''Permite:''' yes.
***'''Deniega:''' no.
**'''allowsCession:''' Termino de privacidad con el que el usuario permite que sus datos sean cedidos a terceras empresas relacionadas con el sector.
***'''Permite:''' yes.
***'''Deniega:''' no.
**Dependiendo de la tarea que estemos ejecutando los campos obligatorios variarán:
***'''register:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, como mínimo siempre será obligatorio el '''email''' y el '''password'''.
***'''update:''' El único campo obligatorio para las actualizaciones será el '''email''', el resto de campos que se añadan serán los campos a actualizar.
***'''login:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, será obligatorio el '''email''' o el '''nick''', junto con el '''password'''. En cualquiera de los casos el '''password''' siempre será obligatorio.
 
*'''jsonApp''': Todos los campos son obligatorios
**'''name''': Nombre de la aplicación dada de alta en el panel de Mobeleader. ''Ejemplo: Mobeleader''.
**'''bundle''': Nombre del paquete de la aplicación. ''Ejemplo: com.mobeleader''.
**'''version''': Version de la aplicación. ''Ejemplo: 1.0''.
**'''versioncode''': Código de versión de la aplicación. ''Ejemplo: 1''.

=Códigos de Errores=
A continuación se expondrá una lista con los posibles errores que devolverá el Webservice en caso de que los datos no sean correctos:

*'''Errores generales:''' Estos errores se deben a un mal uso de la clase '''spsApiNickcenter''' y/o su cifrado, por lo que al no poder devolver la cadena cifrada con la RSA Key pública que le corresponde a la aplicación, se mandarán en texto plano sin cifrar y sin formato JSON.
**Error 000a - Failure decrypting
**Error 000b - Invalid Task
**Error 000c - Empty or invalid app hash
**Error 000d - Missing public RSA Key for app hash X
 
*'''Tarea checkActive:'''
**Error 001a - Failure checking app active
**Error 001b - Failure checking app active
**Error 001c - Failure checking app active
 
*'''Tarea rescuePassword:'''
**Error 002a - Failure on rescuePassword
**Error 002b - Failure on rescuePassword
 
*'''Tarea requestFields:'''
**Error 003a - Failure on requestFields
**Error 003b - Failure on requestFields
**Error 003c - Failure on requestFields
 
*'''Tarea register/update/login:'''
**Error 004a - Failure validating user json, there are no fields configured in your application
**Error 004b - Failure validating user json, incorrect json format
**Error 004c - Failure validating user json
**Error 004d - X is missing or empty in user json.
**Error 004e - Invalid format for X field in user json.
 
*'''Tarea register/update/login:'''
**Error 005a - Failure validating device json, incorrect json format
**Error 005b - Failure validating device json
**Error 005c - Field X is missing or empty in device json
**Error 005c - Field ifa/uuid are missing or empty in device json, one of them must be informed
 
*'''Tarea register/update/login:'''
**Error 006a - Failure validating app json, incorrect json format
**Error 006b - Field X is empty in app json
**Error 006c - The bundle X for os Y, does not exist
**Error 006c - Invalid X in app json, it must be numeric
 
*'''Tarea register/update/login:'''
**Error 007a - Failure generating library json, incorrect device json format
**Error 007b - Failure generating library json, wrong os in device json
**Error 007c - Failure generating library json, wrong os in device json
 
*'''Tarea register:'''
**Error 008a - Failure registering
**Error 008b - Failure registering
**Error 008c - Email already exists
**Error 008c - Nick already exists
 
*'''Tarea login:'''
**Error 009 - Failure on login
 
*'''Tarea update:'''
**Error 010 - Failure updating
 
*'''Sin tarea/Tarea erronea:'''
**Error 011a - Empty Task
**Error 011b - Invalid Task

Documentación Webservice NickCenter

2019-06-07T10:26:44Z

Deneb: /* Conexión con el Webservice */

=Introduccion=
En ésta documentación se expondrá como deberemos hacer uso del Webservice de NickCenter, de manera que emule la propia librería de NickCenter y así no haya la necesidad de usarla ni implementarla en las aplicaciones. A pesar de ello, la configuración en nuestro panel será la misma, siendo necesario dar de alta la aplicación en éste, y configurandola para el uso de NickCenter. Podremos hacer uso de dicho Webservice de dos maneras:
#Llamada directa al Webservice. Ésta opción será menos segura debido a que los datos irán sin cifrar.
#Usando la clase '''spsApiNickcenter'''. Esta opción será mas segura ya que cuenta con un cifrado mediante RSA Keys generadas en nuestro sistema.

=Conexión con el Webservice=
La conexión con el Webservice se puede realizar de dos maneras:
#Mediante llamada directa al Webservice. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection'''. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa==
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''analyticsConnection''', esta será la URL a la que deberemos conectarnos mediante POST ''https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=''. Más adelante se expondrán que tareas hay disponibles y como hay que mandar los datos para su ejecución.
:*''Ejemplo de petición directa con task (tarea) '''checkActive''', una app concreta (añadiendo el hash que le correspondiera) y country (país) '''ES''' (España):''
<source lang="PHP">
$url = 'https://nickcenter.mobeleader.com/webservice_nickcenter.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode('task=checkActive&app=my_app_hash&country=ES'));
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en nuestra carpeta vendor, lo primero que debemos hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Una vez modificada la ruta, para poder instanciar la clase deberemos coger la cadena de la '''RSA KEY Privada''', accesible desde [https://panel.mobeleader.com/index.php?sec=6 nuestro panel], y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
</source>
 
Si la instalación de la librería es correcta, la ruta de acceso a ésta ha sido cambiada y es correcta, y la '''RSA KEY Privada''' es correcta, para realizar las llamadas al Webservice usaremos la funcion '''getWebserviceData()''' de la clase '''spsApiConnection'''. Dicha función será la encargada de realizar todas las conexiones al Webservice, de cifrar los datos que enviaremos a éste y de descifrar los que datos que nos retorne.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getWebserviceData(tarea, array_datos)
</source>
 
A continuación se exponen cuales son las distintas tareas ejecutables, y como ha de ser el array de datos para posibilitar dicha ejecución.

=Tareas=
La clase '''spsApiConnection''' consta de la función ''getData('''tarea, array_datos''')'', con la que ejecutaremos las distintas operaciones que el Webservice permite y a la que le deberemos mandar los siguientes parámetros:
#'''tarea:''' Sera la propia tarea a realizar, puediendo ser:
##'''checkActive'''.
##'''requestFields'''.
##'''register'''.
##'''update'''.
##'''login'''.
##'''rescuePassword'''.
#'''array_datos:''' Contendrá un array con los datos necesarios para la ejecución de la tarea.
===Llamadas al Webservice===
''Recuerde reemplazar el contenido de los ejemplos por los valores reales''.
*'''checkActive:''' Esta tarea comprobará que la aplicación tenga NickCenter activo, independientemente de usarla directamente o no, el resto de tareas harán uso de ella antes de realizar sus operaciones propias.
:*'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
:*'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=checkActive&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('checkActive', $array_datos);
</source>
 
*'''requestFields:''' Mediante ésta tarea obtendremos la configuración de campos y traducciones para una determinada vista.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''view:''' Indicará los campos de que vista solicitamos.
***'''register:''' Pantalla inicial del registro.
***'''login:''' Pantalla de login.
***'''rescue:''' Pantalla de recuperación de contraseña.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones y las configuraciones de los campos que se retornarán.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=requestFields&app=[hash aplicacion, ej: 1234567890ABCDEF]&view=[vista, ej: register]&country=[código país, ej: ES]&language=[código idioma, ej: es]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['view'] = [vista, ej: register];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('requestFields', $array_datos);
</source>
 
*'''register:''' Esta tarea servirá para registrar un usuario en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=register&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a registrar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a registrar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('register', $array_datos);
</source>
 
*'''update:''' Esta tarea servirá para actualizar un usuario que previamente haya sido registrado en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=update&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a actualizar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a actualizar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('update', $array_datos);
</source>
 
*'''login:''' Esta tarea servirá para hacer login en las aplicaciones registradas en NickCenter, con usuarios previamente registrados en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta el panel de en Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=login&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información necesaria para el login]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información necesaria para el login];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('login', $array_datos);
</source>
 
*'''rescuePassword:''' Mediante ésta tarea restauraremos la contraseña de usuarios previamente registrados en nuestro sistema y que no esten dados de baja.
**'''app:''' Contendrá el hash de la aplicación dada de alta el panel de en Mobeleader.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones que se retornarán.
**'''email:''' Email al que hay que restaurar la contraseña.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=rescuePassword&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]&language=[código idioma, ej: es]&email=[email a recuperar, ej: prueba@prueba.com]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];
$array_datos['email'] = [email a recuperar, ej: prueba@prueba.com];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('rescuePassword', $array_datos);
</source>

===Retornos del Webservice===
Cada tarea tendrá su propio JSON de retorno:
*'''checkActive:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''active:''' Indicará si la aplicación esta activa o no.
 
*'''requestFields:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''general:''' En caso de no haber ningún error devolverá un array con todas las traducciones generales para el idioma seleccionado.
**'''fields:''' En caso de no haber ningún error devolverá un array con todos los campos y sus traducciones para el idioma seleccionado.
 
*'''register:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que el registro se ha completado.
 
*'''update:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha actualizado correctamente.
 
*'''login:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha logeado correctamente.
 
*'''rescuePassword:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de que no haya habido un error, se mandará una cadena en el idioma seleccionado, con las instrucciones para recuperar la contraseña.

=Campos y Formatos=
*'''jsonDevice:'''
**'''ua:''' User Agent. Es la cadena de texto que identifica al usuario ante el servidor que se esta conectando mediante HTTP. '''Campo obligatorio.'''
**'''lmt:''' Limit Ad Tracking. Indicará si esta permitido el acceso al ifa del dispositivo. '''Campo obligatorio.'''
***'''0:''' Inactivo/Permitido.
***'''1:''' Activo/No permitido.
**'''devicetype:''' Tipo de dispositivo. '''Campo obligatorio.'''
***'''4:''' Smartphone.
***'''5:''' Tablet/iPad.
**'''make:''' Marca del dispositivo. ''Ejemplo: bq''. '''Campo obligatorio.'''
**'''model:''' Modelo del dispositivo. ''Ejemplo: Aquaris E5''. '''Campo obligatorio.'''
**'''os:''' Sistema operativo. '''Campo obligatorio.'''
***'''Android:''' Android.
***'''iOs:''' ios.
**'''osv:''' Version del sistema operativo. ''Ejemplo: 6.0.1''. '''Campo obligatorio.'''
**'''hwv:''' Version del hardware. ''Ejemplo: Aquaris_E5''. '''Campo obligatorio.'''
**'''h:''' Altura de pantalla. ''Ejemplo: 1920''. '''Campo obligatorio.'''
**'''w:''' Anchura de pantalla. ''Ejemplo: 1080''. '''Campo obligatorio.'''
**'''ppi:''' Pixeles por pulgada. ''Ejemplo: 480''. '''Campo obligatorio.'''
**'''pxratio:''' Densidad de pixeles. ''Ejemplo: 3''. '''Campo obligatorio.'''
**'''inches:''' Pulgadas. ''Ejemplo: 4.9''. '''Campo obligatorio.'''
**'''js:''' Soporte para JavaScript. '''Campo obligatorio.'''
***'''0:''' No.
***'''1:''' Si.
**'''connectiontype:''' Tipo de conexión. '''Campo obligatorio.'''
***'''0:''' Unknown.
***'''1:''' Ethernet.
***'''2:''' WiFI.
***'''3:''' Cellular Network - Unkown Generation.
***'''4:''' Cellular Network - 2G.
***'''5:''' Cellular Network - 3G.
***'''6:''' Cellular Network - 4G.
**'''ifa:''' Identificador para la publicidad. '''Campo obligatorio, debe de estar o el ifa o el uuid.'''
***'''Android:''' Google AID (Google Advertising Identifier). ''Ejemplo: 38400000-8cf0-11bd-b23e-10b96e40000d''.
***'''iOs:''' iOS IFA (Apple Identifier for Advertiser). ''Ejemplo: AAAAAAAAA-BBBB-CCCC-1111-222222220000''.
**'''uuid:''' Identificador único universal. ''Ejemplo: 550e8400-e29b-41d4-a716-446655440000''. '''Campo obligatorio, debe estar el uuid o el ifa.'''
**'''language:''' Idioma del dispositivo ( locale ). ''Ejemplo: es''. '''Campo obligatorio.'''
**'''country:''' Pais del dispositivo ( locale ). ''Ejemplo: ES''. '''Campo obligatorio.'''
**'''carrier:''' Operador Telefónico del dispositivo. ''Ejemplo: Movistar''.
**'''carriercode:''' Código del operador telefónico. ''Ejemplo: 21407''.
**'''carriercountry:''' País del operador telefónico. ''Ejemplo: ES''.
**'''mac: ( Solo para Android )''' Mac del dispositivo. ''Ejemplo: 00:1B:44:11:3A:B7''.
**'''imsi: ( Solo para Android )''' Identidad Internacional del Abonado Móvil. ''Ejemplo: 7160652952503786''.
**'''did: ( Solo para Android )''' Identificador Direct inward dialing (DID).
**'''dpid: ( Solo para Android )''' Plataform device id (Android id).
 
*'''jsonUser:'''
**'''name:''' Nombre del usuario. Máximo 100 caracteres. ''Ejemplo: Kevin''.
**'''surname:''' Apellido del usuario. Máximo 100 caracteres. ''Ejemplo: Lancharro''.
**'''email:''' Email del usuario. Máximo 250 caracteres. ''Ejemplo: xxxx@xxx.com''.
**'''password:''' Password del usuario. Deberá ir en md5(). Máximo 50 caracteres. ''Ejemplo: e10adc3949ba59abbe56e057f20f883e''.
**'''nick:''' Nick del usuario. Máximo 50 caracteres. ''Ejemplo: CocoNilo''.
**'''phone:''' Teléfono móvil del usuario. Máximo 15 caracteres. ''Ejemplo: 6XX XXX XXX''.
**'''birthDate:''' Fecha de nacimiento del usuario. ''Ejemplo : 1992-01-12''.
**'''gender:''' Sexo del usuario.
***'''Masculino:''' M.
***'''Femenino:''' F.
**'''allowsCommercials:''' Termino de privacidad con el que el usuario permite recibir comunicaciones comerciales.
***'''Permite:''' yes.
***'''Deniega:''' no.
**'''allowsCession:''' Termino de privacidad con el que el usuario permite que sus datos sean cedidos a terceras empresas relacionadas con el sector.
***'''Permite:''' yes.
***'''Deniega:''' no.
**Dependiendo de la tarea que estemos ejecutando los campos obligatorios variarán:
***'''register:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, como mínimo siempre será obligatorio el '''email''' y el '''password'''.
***'''update:''' El único campo obligatorio para las actualizaciones será el '''email''', el resto de campos que se añadan serán los campos a actualizar.
***'''login:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, será obligatorio el '''email''' o el '''nick''', junto con el '''password'''. En cualquiera de los casos el '''password''' siempre será obligatorio.
 
*'''jsonApp''': Todos los campos son obligatorios
**'''name''': Nombre de la aplicación dada de alta en el panel de Mobeleader. ''Ejemplo: Mobeleader''.
**'''bundle''': Nombre del paquete de la aplicación. ''Ejemplo: com.mobeleader''.
**'''version''': Version de la aplicación. ''Ejemplo: 1.0''.
**'''versioncode''': Código de versión de la aplicación. ''Ejemplo: 1''.

=Códigos de Errores=
A continuación se expondrá una lista con los posibles errores que devolverá el Webservice en caso de que los datos no sean correctos:

*'''Errores generales:''' Estos errores se deben a un mal uso de la clase '''spsApiNickcenter''' y/o su cifrado, por lo que al no poder devolver la cadena cifrada con la RSA Key pública que le corresponde a la aplicación, se mandarán en texto plano sin cifrar y sin formato JSON.
**Error 000a - Failure decrypting
**Error 000b - Invalid Task
**Error 000c - Empty or invalid app hash
**Error 000d - Missing public RSA Key for app hash X
 
*'''Tarea checkActive:'''
**Error 001a - Failure checking app active
**Error 001b - Failure checking app active
**Error 001c - Failure checking app active
 
*'''Tarea rescuePassword:'''
**Error 002a - Failure on rescuePassword
**Error 002b - Failure on rescuePassword
 
*'''Tarea requestFields:'''
**Error 003a - Failure on requestFields
**Error 003b - Failure on requestFields
**Error 003c - Failure on requestFields
 
*'''Tarea register/update/login:'''
**Error 004a - Failure validating user json, there are no fields configured in your application
**Error 004b - Failure validating user json, incorrect json format
**Error 004c - Failure validating user json
**Error 004d - X is missing or empty in user json.
**Error 004e - Invalid format for X field in user json.
 
*'''Tarea register/update/login:'''
**Error 005a - Failure validating device json, incorrect json format
**Error 005b - Failure validating device json
**Error 005c - Field X is missing or empty in device json
**Error 005c - Field ifa/uuid are missing or empty in device json, one of them must be informed
 
*'''Tarea register/update/login:'''
**Error 006a - Failure validating app json, incorrect json format
**Error 006b - Field X is empty in app json
**Error 006c - The bundle X for os Y, does not exist
**Error 006c - Invalid X in app json, it must be numeric
 
*'''Tarea register/update/login:'''
**Error 007a - Failure generating library json, incorrect device json format
**Error 007b - Failure generating library json, wrong os in device json
**Error 007c - Failure generating library json, wrong os in device json
 
*'''Tarea register:'''
**Error 008a - Failure registering
**Error 008b - Failure registering
**Error 008c - Email already exists
**Error 008c - Nick already exists
 
*'''Tarea login:'''
**Error 009 - Failure on login
 
*'''Tarea update:'''
**Error 010 - Failure updating
 
*'''Sin tarea/Tarea erronea:'''
**Error 011a - Empty Task
**Error 011b - Invalid Task

Documentación Webservice NickCenter

2019-06-07T10:26:02Z

Deneb: /* Introduccion */

=Introduccion=
En ésta documentación se expondrá como deberemos hacer uso del Webservice de NickCenter, de manera que emule la propia librería de NickCenter y así no haya la necesidad de usarla ni implementarla en las aplicaciones. A pesar de ello, la configuración en nuestro panel será la misma, siendo necesario dar de alta la aplicación en éste, y configurandola para el uso de NickCenter. Podremos hacer uso de dicho Webservice de dos maneras:
#Llamada directa al Webservice. Ésta opción será menos segura debido a que los datos irán sin cifrar.
#Usando la clase '''spsApiNickcenter'''. Esta opción será mas segura ya que cuenta con un cifrado mediante RSA Keys generadas en nuestro sistema.

=Conexión con el Webservice=
La conexión con el Webservice se puede realizar de dos maneras:
#Mediante llamada directa al Webservice. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection''' creada por Mobeleader. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa==
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''analyticsConnection''', esta será la URL a la que deberemos conectarnos mediante POST ''https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=''. Más adelante se expondrán que tareas hay disponibles y como hay que mandar los datos para su ejecución.
:*''Ejemplo de petición directa con task (tarea) '''checkActive''', una app concreta (añadiendo el hash que le correspondiera) y country (país) '''ES''' (España):''
<source lang="PHP">
$url = 'https://nickcenter.mobeleader.com/webservice_nickcenter.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode('task=checkActive&app=my_app_hash&country=ES'));
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en nuestra carpeta vendor, lo primero que debemos hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Una vez modificada la ruta, para poder instanciar la clase deberemos coger la cadena de la '''RSA KEY Privada''', accesible desde [https://panel.mobeleader.com/index.php?sec=6 nuestro panel], y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
</source>
 
Si la instalación de la librería es correcta, la ruta de acceso a ésta ha sido cambiada y es correcta, y la '''RSA KEY Privada''' es correcta, para realizar las llamadas al Webservice usaremos la funcion '''getWebserviceData()''' de la clase '''spsApiConnection'''. Dicha función será la encargada de realizar todas las conexiones al Webservice, de cifrar los datos que enviaremos a éste y de descifrar los que datos que nos retorne.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getWebserviceData(tarea, array_datos)
</source>
 
A continuación se exponen cuales son las distintas tareas ejecutables, y como ha de ser el array de datos para posibilitar dicha ejecución.

=Tareas=
La clase '''spsApiConnection''' consta de la función ''getData('''tarea, array_datos''')'', con la que ejecutaremos las distintas operaciones que el Webservice permite y a la que le deberemos mandar los siguientes parámetros:
#'''tarea:''' Sera la propia tarea a realizar, puediendo ser:
##'''checkActive'''.
##'''requestFields'''.
##'''register'''.
##'''update'''.
##'''login'''.
##'''rescuePassword'''.
#'''array_datos:''' Contendrá un array con los datos necesarios para la ejecución de la tarea.
===Llamadas al Webservice===
''Recuerde reemplazar el contenido de los ejemplos por los valores reales''.
*'''checkActive:''' Esta tarea comprobará que la aplicación tenga NickCenter activo, independientemente de usarla directamente o no, el resto de tareas harán uso de ella antes de realizar sus operaciones propias.
:*'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
:*'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=checkActive&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('checkActive', $array_datos);
</source>
 
*'''requestFields:''' Mediante ésta tarea obtendremos la configuración de campos y traducciones para una determinada vista.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''view:''' Indicará los campos de que vista solicitamos.
***'''register:''' Pantalla inicial del registro.
***'''login:''' Pantalla de login.
***'''rescue:''' Pantalla de recuperación de contraseña.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones y las configuraciones de los campos que se retornarán.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=requestFields&app=[hash aplicacion, ej: 1234567890ABCDEF]&view=[vista, ej: register]&country=[código país, ej: ES]&language=[código idioma, ej: es]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['view'] = [vista, ej: register];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('requestFields', $array_datos);
</source>
 
*'''register:''' Esta tarea servirá para registrar un usuario en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=register&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a registrar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a registrar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('register', $array_datos);
</source>
 
*'''update:''' Esta tarea servirá para actualizar un usuario que previamente haya sido registrado en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=update&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a actualizar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a actualizar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('update', $array_datos);
</source>
 
*'''login:''' Esta tarea servirá para hacer login en las aplicaciones registradas en NickCenter, con usuarios previamente registrados en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta el panel de en Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=login&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información necesaria para el login]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información necesaria para el login];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('login', $array_datos);
</source>
 
*'''rescuePassword:''' Mediante ésta tarea restauraremos la contraseña de usuarios previamente registrados en nuestro sistema y que no esten dados de baja.
**'''app:''' Contendrá el hash de la aplicación dada de alta el panel de en Mobeleader.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones que se retornarán.
**'''email:''' Email al que hay que restaurar la contraseña.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=rescuePassword&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]&language=[código idioma, ej: es]&email=[email a recuperar, ej: prueba@prueba.com]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];
$array_datos['email'] = [email a recuperar, ej: prueba@prueba.com];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('rescuePassword', $array_datos);
</source>

===Retornos del Webservice===
Cada tarea tendrá su propio JSON de retorno:
*'''checkActive:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''active:''' Indicará si la aplicación esta activa o no.
 
*'''requestFields:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''general:''' En caso de no haber ningún error devolverá un array con todas las traducciones generales para el idioma seleccionado.
**'''fields:''' En caso de no haber ningún error devolverá un array con todos los campos y sus traducciones para el idioma seleccionado.
 
*'''register:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que el registro se ha completado.
 
*'''update:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha actualizado correctamente.
 
*'''login:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha logeado correctamente.
 
*'''rescuePassword:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de que no haya habido un error, se mandará una cadena en el idioma seleccionado, con las instrucciones para recuperar la contraseña.

=Campos y Formatos=
*'''jsonDevice:'''
**'''ua:''' User Agent. Es la cadena de texto que identifica al usuario ante el servidor que se esta conectando mediante HTTP. '''Campo obligatorio.'''
**'''lmt:''' Limit Ad Tracking. Indicará si esta permitido el acceso al ifa del dispositivo. '''Campo obligatorio.'''
***'''0:''' Inactivo/Permitido.
***'''1:''' Activo/No permitido.
**'''devicetype:''' Tipo de dispositivo. '''Campo obligatorio.'''
***'''4:''' Smartphone.
***'''5:''' Tablet/iPad.
**'''make:''' Marca del dispositivo. ''Ejemplo: bq''. '''Campo obligatorio.'''
**'''model:''' Modelo del dispositivo. ''Ejemplo: Aquaris E5''. '''Campo obligatorio.'''
**'''os:''' Sistema operativo. '''Campo obligatorio.'''
***'''Android:''' Android.
***'''iOs:''' ios.
**'''osv:''' Version del sistema operativo. ''Ejemplo: 6.0.1''. '''Campo obligatorio.'''
**'''hwv:''' Version del hardware. ''Ejemplo: Aquaris_E5''. '''Campo obligatorio.'''
**'''h:''' Altura de pantalla. ''Ejemplo: 1920''. '''Campo obligatorio.'''
**'''w:''' Anchura de pantalla. ''Ejemplo: 1080''. '''Campo obligatorio.'''
**'''ppi:''' Pixeles por pulgada. ''Ejemplo: 480''. '''Campo obligatorio.'''
**'''pxratio:''' Densidad de pixeles. ''Ejemplo: 3''. '''Campo obligatorio.'''
**'''inches:''' Pulgadas. ''Ejemplo: 4.9''. '''Campo obligatorio.'''
**'''js:''' Soporte para JavaScript. '''Campo obligatorio.'''
***'''0:''' No.
***'''1:''' Si.
**'''connectiontype:''' Tipo de conexión. '''Campo obligatorio.'''
***'''0:''' Unknown.
***'''1:''' Ethernet.
***'''2:''' WiFI.
***'''3:''' Cellular Network - Unkown Generation.
***'''4:''' Cellular Network - 2G.
***'''5:''' Cellular Network - 3G.
***'''6:''' Cellular Network - 4G.
**'''ifa:''' Identificador para la publicidad. '''Campo obligatorio, debe de estar o el ifa o el uuid.'''
***'''Android:''' Google AID (Google Advertising Identifier). ''Ejemplo: 38400000-8cf0-11bd-b23e-10b96e40000d''.
***'''iOs:''' iOS IFA (Apple Identifier for Advertiser). ''Ejemplo: AAAAAAAAA-BBBB-CCCC-1111-222222220000''.
**'''uuid:''' Identificador único universal. ''Ejemplo: 550e8400-e29b-41d4-a716-446655440000''. '''Campo obligatorio, debe estar el uuid o el ifa.'''
**'''language:''' Idioma del dispositivo ( locale ). ''Ejemplo: es''. '''Campo obligatorio.'''
**'''country:''' Pais del dispositivo ( locale ). ''Ejemplo: ES''. '''Campo obligatorio.'''
**'''carrier:''' Operador Telefónico del dispositivo. ''Ejemplo: Movistar''.
**'''carriercode:''' Código del operador telefónico. ''Ejemplo: 21407''.
**'''carriercountry:''' País del operador telefónico. ''Ejemplo: ES''.
**'''mac: ( Solo para Android )''' Mac del dispositivo. ''Ejemplo: 00:1B:44:11:3A:B7''.
**'''imsi: ( Solo para Android )''' Identidad Internacional del Abonado Móvil. ''Ejemplo: 7160652952503786''.
**'''did: ( Solo para Android )''' Identificador Direct inward dialing (DID).
**'''dpid: ( Solo para Android )''' Plataform device id (Android id).
 
*'''jsonUser:'''
**'''name:''' Nombre del usuario. Máximo 100 caracteres. ''Ejemplo: Kevin''.
**'''surname:''' Apellido del usuario. Máximo 100 caracteres. ''Ejemplo: Lancharro''.
**'''email:''' Email del usuario. Máximo 250 caracteres. ''Ejemplo: xxxx@xxx.com''.
**'''password:''' Password del usuario. Deberá ir en md5(). Máximo 50 caracteres. ''Ejemplo: e10adc3949ba59abbe56e057f20f883e''.
**'''nick:''' Nick del usuario. Máximo 50 caracteres. ''Ejemplo: CocoNilo''.
**'''phone:''' Teléfono móvil del usuario. Máximo 15 caracteres. ''Ejemplo: 6XX XXX XXX''.
**'''birthDate:''' Fecha de nacimiento del usuario. ''Ejemplo : 1992-01-12''.
**'''gender:''' Sexo del usuario.
***'''Masculino:''' M.
***'''Femenino:''' F.
**'''allowsCommercials:''' Termino de privacidad con el que el usuario permite recibir comunicaciones comerciales.
***'''Permite:''' yes.
***'''Deniega:''' no.
**'''allowsCession:''' Termino de privacidad con el que el usuario permite que sus datos sean cedidos a terceras empresas relacionadas con el sector.
***'''Permite:''' yes.
***'''Deniega:''' no.
**Dependiendo de la tarea que estemos ejecutando los campos obligatorios variarán:
***'''register:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, como mínimo siempre será obligatorio el '''email''' y el '''password'''.
***'''update:''' El único campo obligatorio para las actualizaciones será el '''email''', el resto de campos que se añadan serán los campos a actualizar.
***'''login:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, será obligatorio el '''email''' o el '''nick''', junto con el '''password'''. En cualquiera de los casos el '''password''' siempre será obligatorio.
 
*'''jsonApp''': Todos los campos son obligatorios
**'''name''': Nombre de la aplicación dada de alta en el panel de Mobeleader. ''Ejemplo: Mobeleader''.
**'''bundle''': Nombre del paquete de la aplicación. ''Ejemplo: com.mobeleader''.
**'''version''': Version de la aplicación. ''Ejemplo: 1.0''.
**'''versioncode''': Código de versión de la aplicación. ''Ejemplo: 1''.

=Códigos de Errores=
A continuación se expondrá una lista con los posibles errores que devolverá el Webservice en caso de que los datos no sean correctos:

*'''Errores generales:''' Estos errores se deben a un mal uso de la clase '''spsApiNickcenter''' y/o su cifrado, por lo que al no poder devolver la cadena cifrada con la RSA Key pública que le corresponde a la aplicación, se mandarán en texto plano sin cifrar y sin formato JSON.
**Error 000a - Failure decrypting
**Error 000b - Invalid Task
**Error 000c - Empty or invalid app hash
**Error 000d - Missing public RSA Key for app hash X
 
*'''Tarea checkActive:'''
**Error 001a - Failure checking app active
**Error 001b - Failure checking app active
**Error 001c - Failure checking app active
 
*'''Tarea rescuePassword:'''
**Error 002a - Failure on rescuePassword
**Error 002b - Failure on rescuePassword
 
*'''Tarea requestFields:'''
**Error 003a - Failure on requestFields
**Error 003b - Failure on requestFields
**Error 003c - Failure on requestFields
 
*'''Tarea register/update/login:'''
**Error 004a - Failure validating user json, there are no fields configured in your application
**Error 004b - Failure validating user json, incorrect json format
**Error 004c - Failure validating user json
**Error 004d - X is missing or empty in user json.
**Error 004e - Invalid format for X field in user json.
 
*'''Tarea register/update/login:'''
**Error 005a - Failure validating device json, incorrect json format
**Error 005b - Failure validating device json
**Error 005c - Field X is missing or empty in device json
**Error 005c - Field ifa/uuid are missing or empty in device json, one of them must be informed
 
*'''Tarea register/update/login:'''
**Error 006a - Failure validating app json, incorrect json format
**Error 006b - Field X is empty in app json
**Error 006c - The bundle X for os Y, does not exist
**Error 006c - Invalid X in app json, it must be numeric
 
*'''Tarea register/update/login:'''
**Error 007a - Failure generating library json, incorrect device json format
**Error 007b - Failure generating library json, wrong os in device json
**Error 007c - Failure generating library json, wrong os in device json
 
*'''Tarea register:'''
**Error 008a - Failure registering
**Error 008b - Failure registering
**Error 008c - Email already exists
**Error 008c - Nick already exists
 
*'''Tarea login:'''
**Error 009 - Failure on login
 
*'''Tarea update:'''
**Error 010 - Failure updating
 
*'''Sin tarea/Tarea erronea:'''
**Error 011a - Empty Task
**Error 011b - Invalid Task

Documentación Webservice NickCenter

2019-06-07T10:24:50Z

Deneb: /* Clase spsApiConnection */

=Introduccion=
En ésta documentación se expondrá como deberemos hacer uso del Webservice de NickCenter, de manera que emule la propia librería de NickCenter y así no haya la necesidad de usarla ni implementarla en las aplicaciones. A pesar de ello, la configuración en el panel de Mobeleader será la misma, siendo necesario dar de alta la aplicación en éste, y configurandola para el uso de NickCenter. Podremos hacer uso de dicho Webservice de dos maneras:
#Llamada directa al Webservice. Ésta opción será menos segura debido a que los datos irán sin cifrar.
#Usando la clase '''spsApiNickcenter''' creada por Mobeleader. Esta opción será mas segura ya que cuenta con un cifrado mediante RSA Keys generadas en nuestro sistema.

=Conexión con el Webservice=
La conexión con el Webservice se puede realizar de dos maneras:
#Mediante llamada directa al Webservice. Esta opción será menos segura debido a que los datos de la petición irán sin cifrar.
#Usando la clase '''spsApiConnection''' creada por Mobeleader. Esta opción será mas segura ya que cuenta con un cifrado mediante claves RSA generadas en nuestro sistema.

==Llamada directa==
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''analyticsConnection''', esta será la URL a la que deberemos conectarnos mediante POST ''https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=''. Más adelante se expondrán que tareas hay disponibles y como hay que mandar los datos para su ejecución.
:*''Ejemplo de petición directa con task (tarea) '''checkActive''', una app concreta (añadiendo el hash que le correspondiera) y country (país) '''ES''' (España):''
<source lang="PHP">
$url = 'https://nickcenter.mobeleader.com/webservice_nickcenter.php';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/x-www-form-urlencoded') );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_POSTFIELDS, 'data='.urlencode('task=checkActive&app=my_app_hash&country=ES'));
$responseJson = curl_exec($curl);
</source>

{{:APIs_webservices:clase_api_connection}}

===Clase spsApiConnection ===
Una vez instalada la librería '''PHPSECLIB''' en nuestra carpeta vendor, lo primero que debemos hacer es abrir la clase y modificar la ruta de acceso a dicha carpeta.
 
<source lang="PHP">
require_once 'PATH..../vendor/autoload.php';
</source>
 
Una vez modificada la ruta, para poder instanciar la clase deberemos coger la cadena de la '''RSA KEY Privada''', accesible desde [https://panel.mobeleader.com/index.php?sec=6 nuestro panel], y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
</source>
 
Si la instalación de la librería es correcta, la ruta de acceso a ésta ha sido cambiada y es correcta, y la '''RSA KEY Privada''' es correcta, para realizar las llamadas al Webservice usaremos la funcion '''getWebserviceData()''' de la clase '''spsApiConnection'''. Dicha función será la encargada de realizar todas las conexiones al Webservice, de cifrar los datos que enviaremos a éste y de descifrar los que datos que nos retorne.
 
<source lang="PHP">
require_once "PATH..../api_connection_class.php";
$conexionapi = new spsApiConnection([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getWebserviceData(tarea, array_datos)
</source>
 
A continuación se exponen cuales son las distintas tareas ejecutables, y como ha de ser el array de datos para posibilitar dicha ejecución.

=Tareas=
La clase '''spsApiConnection''' consta de la función ''getData('''tarea, array_datos''')'', con la que ejecutaremos las distintas operaciones que el Webservice permite y a la que le deberemos mandar los siguientes parámetros:
#'''tarea:''' Sera la propia tarea a realizar, puediendo ser:
##'''checkActive'''.
##'''requestFields'''.
##'''register'''.
##'''update'''.
##'''login'''.
##'''rescuePassword'''.
#'''array_datos:''' Contendrá un array con los datos necesarios para la ejecución de la tarea.
===Llamadas al Webservice===
''Recuerde reemplazar el contenido de los ejemplos por los valores reales''.
*'''checkActive:''' Esta tarea comprobará que la aplicación tenga NickCenter activo, independientemente de usarla directamente o no, el resto de tareas harán uso de ella antes de realizar sus operaciones propias.
:*'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
:*'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=checkActive&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('checkActive', $array_datos);
</source>
 
*'''requestFields:''' Mediante ésta tarea obtendremos la configuración de campos y traducciones para una determinada vista.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''view:''' Indicará los campos de que vista solicitamos.
***'''register:''' Pantalla inicial del registro.
***'''login:''' Pantalla de login.
***'''rescue:''' Pantalla de recuperación de contraseña.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones y las configuraciones de los campos que se retornarán.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=requestFields&app=[hash aplicacion, ej: 1234567890ABCDEF]&view=[vista, ej: register]&country=[código país, ej: ES]&language=[código idioma, ej: es]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['view'] = [vista, ej: register];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('requestFields', $array_datos);
</source>
 
*'''register:''' Esta tarea servirá para registrar un usuario en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=register&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a registrar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a registrar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('register', $array_datos);
</source>
 
*'''update:''' Esta tarea servirá para actualizar un usuario que previamente haya sido registrado en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta en el panel de Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=update&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información a actualizar del usuario]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información a actualizar del usuario];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('update', $array_datos);
</source>
 
*'''login:''' Esta tarea servirá para hacer login en las aplicaciones registradas en NickCenter, con usuarios previamente registrados en nuestro sistema.
**'''app:''' Contendrá el hash de la aplicación dada de alta el panel de en Mobeleader.
**'''jsonDevice:''' Contendrá los datos del dispositivo. Más adelante se exponen que campos son obligatorios.
**'''jsonApp:''' Contendrá los datos de la aplicación. Más adelante se exponen que campos son obligatorios.
**'''jsonUser:''' Contendrá los datos del usuario. Más adelante se exponen que campos son obligatorios.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=login&app=[hash aplicacion, ej: 1234567890ABCDEF]&jsonDevice=[json con toda la información del dispositivo]&jsonApp=[json con toda la información de la app]&jsonUser=[json con toda la información necesaria para el login]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['jsonDevice'] = [json con toda la información del dispositivo];
$array_datos['jsonApp'] = [json con toda la información de la app];
$array_datos['jsonUser'] = [json con toda la información necesaria para el login];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('login', $array_datos);
</source>
 
*'''rescuePassword:''' Mediante ésta tarea restauraremos la contraseña de usuarios previamente registrados en nuestro sistema y que no esten dados de baja.
**'''app:''' Contendrá el hash de la aplicación dada de alta el panel de en Mobeleader.
**'''country:''' Contendrá el país del dispositivo, necesario para comprobar si NickCenter esta activo para esa aplicación en ese país.
**'''language:''' Idioma del dispositivo, necesario para las traducciones que se retornarán.
**'''email:''' Email al que hay que restaurar la contraseña.
:*''Ejemplo llamada directa:''
<source lang="PHP">
https://nickcenter.mobeleader.com/webservice_nickcenter.php?data=task=rescuePassword&app=[hash aplicacion, ej: 1234567890ABCDEF]&country=[código país, ej: ES]&language=[código idioma, ej: es]&email=[email a recuperar, ej: prueba@prueba.com]
</source>
:*''Ejemplo spsApiNickcenter:''
<source lang="PHP">
$array_datos = array();
$array_datos['app'] = [hash aplicacion, ej: 1234567890ABCDEF];
$array_datos['country'] = [código país, ej: ES];
$array_datos['language'] = [código idioma, ej: es];
$array_datos['email'] = [email a recuperar, ej: prueba@prueba.com];

$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA asociada a su aplicación]);
$json_datos_devueltos = $conexionapi->getData('rescuePassword', $array_datos);
</source>

===Retornos del Webservice===
Cada tarea tendrá su propio JSON de retorno:
*'''checkActive:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''active:''' Indicará si la aplicación esta activa o no.
 
*'''requestFields:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''general:''' En caso de no haber ningún error devolverá un array con todas las traducciones generales para el idioma seleccionado.
**'''fields:''' En caso de no haber ningún error devolverá un array con todos los campos y sus traducciones para el idioma seleccionado.
 
*'''register:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que el registro se ha completado.
 
*'''update:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha actualizado correctamente.
 
*'''login:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de no haber error indicará que se ha logeado correctamente.
 
*'''rescuePassword:'''
**'''error:''' Indicará si ha habido un error o no.
**'''errorTxt:''' En caso de haber un error indicará a que se debe dicho error.
**'''okTxt:''' En caso de que no haya habido un error, se mandará una cadena en el idioma seleccionado, con las instrucciones para recuperar la contraseña.

=Campos y Formatos=
*'''jsonDevice:'''
**'''ua:''' User Agent. Es la cadena de texto que identifica al usuario ante el servidor que se esta conectando mediante HTTP. '''Campo obligatorio.'''
**'''lmt:''' Limit Ad Tracking. Indicará si esta permitido el acceso al ifa del dispositivo. '''Campo obligatorio.'''
***'''0:''' Inactivo/Permitido.
***'''1:''' Activo/No permitido.
**'''devicetype:''' Tipo de dispositivo. '''Campo obligatorio.'''
***'''4:''' Smartphone.
***'''5:''' Tablet/iPad.
**'''make:''' Marca del dispositivo. ''Ejemplo: bq''. '''Campo obligatorio.'''
**'''model:''' Modelo del dispositivo. ''Ejemplo: Aquaris E5''. '''Campo obligatorio.'''
**'''os:''' Sistema operativo. '''Campo obligatorio.'''
***'''Android:''' Android.
***'''iOs:''' ios.
**'''osv:''' Version del sistema operativo. ''Ejemplo: 6.0.1''. '''Campo obligatorio.'''
**'''hwv:''' Version del hardware. ''Ejemplo: Aquaris_E5''. '''Campo obligatorio.'''
**'''h:''' Altura de pantalla. ''Ejemplo: 1920''. '''Campo obligatorio.'''
**'''w:''' Anchura de pantalla. ''Ejemplo: 1080''. '''Campo obligatorio.'''
**'''ppi:''' Pixeles por pulgada. ''Ejemplo: 480''. '''Campo obligatorio.'''
**'''pxratio:''' Densidad de pixeles. ''Ejemplo: 3''. '''Campo obligatorio.'''
**'''inches:''' Pulgadas. ''Ejemplo: 4.9''. '''Campo obligatorio.'''
**'''js:''' Soporte para JavaScript. '''Campo obligatorio.'''
***'''0:''' No.
***'''1:''' Si.
**'''connectiontype:''' Tipo de conexión. '''Campo obligatorio.'''
***'''0:''' Unknown.
***'''1:''' Ethernet.
***'''2:''' WiFI.
***'''3:''' Cellular Network - Unkown Generation.
***'''4:''' Cellular Network - 2G.
***'''5:''' Cellular Network - 3G.
***'''6:''' Cellular Network - 4G.
**'''ifa:''' Identificador para la publicidad. '''Campo obligatorio, debe de estar o el ifa o el uuid.'''
***'''Android:''' Google AID (Google Advertising Identifier). ''Ejemplo: 38400000-8cf0-11bd-b23e-10b96e40000d''.
***'''iOs:''' iOS IFA (Apple Identifier for Advertiser). ''Ejemplo: AAAAAAAAA-BBBB-CCCC-1111-222222220000''.
**'''uuid:''' Identificador único universal. ''Ejemplo: 550e8400-e29b-41d4-a716-446655440000''. '''Campo obligatorio, debe estar el uuid o el ifa.'''
**'''language:''' Idioma del dispositivo ( locale ). ''Ejemplo: es''. '''Campo obligatorio.'''
**'''country:''' Pais del dispositivo ( locale ). ''Ejemplo: ES''. '''Campo obligatorio.'''
**'''carrier:''' Operador Telefónico del dispositivo. ''Ejemplo: Movistar''.
**'''carriercode:''' Código del operador telefónico. ''Ejemplo: 21407''.
**'''carriercountry:''' País del operador telefónico. ''Ejemplo: ES''.
**'''mac: ( Solo para Android )''' Mac del dispositivo. ''Ejemplo: 00:1B:44:11:3A:B7''.
**'''imsi: ( Solo para Android )''' Identidad Internacional del Abonado Móvil. ''Ejemplo: 7160652952503786''.
**'''did: ( Solo para Android )''' Identificador Direct inward dialing (DID).
**'''dpid: ( Solo para Android )''' Plataform device id (Android id).
 
*'''jsonUser:'''
**'''name:''' Nombre del usuario. Máximo 100 caracteres. ''Ejemplo: Kevin''.
**'''surname:''' Apellido del usuario. Máximo 100 caracteres. ''Ejemplo: Lancharro''.
**'''email:''' Email del usuario. Máximo 250 caracteres. ''Ejemplo: xxxx@xxx.com''.
**'''password:''' Password del usuario. Deberá ir en md5(). Máximo 50 caracteres. ''Ejemplo: e10adc3949ba59abbe56e057f20f883e''.
**'''nick:''' Nick del usuario. Máximo 50 caracteres. ''Ejemplo: CocoNilo''.
**'''phone:''' Teléfono móvil del usuario. Máximo 15 caracteres. ''Ejemplo: 6XX XXX XXX''.
**'''birthDate:''' Fecha de nacimiento del usuario. ''Ejemplo : 1992-01-12''.
**'''gender:''' Sexo del usuario.
***'''Masculino:''' M.
***'''Femenino:''' F.
**'''allowsCommercials:''' Termino de privacidad con el que el usuario permite recibir comunicaciones comerciales.
***'''Permite:''' yes.
***'''Deniega:''' no.
**'''allowsCession:''' Termino de privacidad con el que el usuario permite que sus datos sean cedidos a terceras empresas relacionadas con el sector.
***'''Permite:''' yes.
***'''Deniega:''' no.
**Dependiendo de la tarea que estemos ejecutando los campos obligatorios variarán:
***'''register:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, como mínimo siempre será obligatorio el '''email''' y el '''password'''.
***'''update:''' El único campo obligatorio para las actualizaciones será el '''email''', el resto de campos que se añadan serán los campos a actualizar.
***'''login:''' Dependerá de los campos que hayamos configurado en el apartado de NickCenter en el panel de Mobeleader, será obligatorio el '''email''' o el '''nick''', junto con el '''password'''. En cualquiera de los casos el '''password''' siempre será obligatorio.
 
*'''jsonApp''': Todos los campos son obligatorios
**'''name''': Nombre de la aplicación dada de alta en el panel de Mobeleader. ''Ejemplo: Mobeleader''.
**'''bundle''': Nombre del paquete de la aplicación. ''Ejemplo: com.mobeleader''.
**'''version''': Version de la aplicación. ''Ejemplo: 1.0''.
**'''versioncode''': Código de versión de la aplicación. ''Ejemplo: 1''.

=Códigos de Errores=
A continuación se expondrá una lista con los posibles errores que devolverá el Webservice en caso de que los datos no sean correctos:

*'''Errores generales:''' Estos errores se deben a un mal uso de la clase '''spsApiNickcenter''' y/o su cifrado, por lo que al no poder devolver la cadena cifrada con la RSA Key pública que le corresponde a la aplicación, se mandarán en texto plano sin cifrar y sin formato JSON.
**Error 000a - Failure decrypting
**Error 000b - Invalid Task
**Error 000c - Empty or invalid app hash
**Error 000d - Missing public RSA Key for app hash X
 
*'''Tarea checkActive:'''
**Error 001a - Failure checking app active
**Error 001b - Failure checking app active
**Error 001c - Failure checking app active
 
*'''Tarea rescuePassword:'''
**Error 002a - Failure on rescuePassword
**Error 002b - Failure on rescuePassword
 
*'''Tarea requestFields:'''
**Error 003a - Failure on requestFields
**Error 003b - Failure on requestFields
**Error 003c - Failure on requestFields
 
*'''Tarea register/update/login:'''
**Error 004a - Failure validating user json, there are no fields configured in your application
**Error 004b - Failure validating user json, incorrect json format
**Error 004c - Failure validating user json
**Error 004d - X is missing or empty in user json.
**Error 004e - Invalid format for X field in user json.
 
*'''Tarea register/update/login:'''
**Error 005a - Failure validating device json, incorrect json format
**Error 005b - Failure validating device json
**Error 005c - Field X is missing or empty in device json
**Error 005c - Field ifa/uuid are missing or empty in device json, one of them must be informed
 
*'''Tarea register/update/login:'''
**Error 006a - Failure validating app json, incorrect json format
**Error 006b - Field X is empty in app json
**Error 006c - The bundle X for os Y, does not exist
**Error 006c - Invalid X in app json, it must be numeric
 
*'''Tarea register/update/login:'''
**Error 007a - Failure generating library json, incorrect device json format
**Error 007b - Failure generating library json, wrong os in device json
**Error 007c - Failure generating library json, wrong os in device json
 
*'''Tarea register:'''
**Error 008a - Failure registering
**Error 008b - Failure registering
**Error 008c - Email already exists
**Error 008c - Nick already exists
 
*'''Tarea login:'''
**Error 009 - Failure on login
 
*'''Tarea update:'''
**Error 010 - Failure updating
 
*'''Sin tarea/Tarea erronea:'''
**Error 011a - Empty Task
**Error 011b - Invalid Task

SDKs:NickCenter:iOS:index

2019-06-07T10:15:42Z

Deneb: /* PASOS A REALIZAR EN NUESTRO PANEL */

= CÓMO AGREGAR EL FRAMEWORK NICKCENTER EN iOS =

{{:SDKs:NickCenter:Intro}}

== VERSIONES DE iOs SOPORTADAS ==

Este framework soporta todas las versiones de iOs superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

== PASOS A REALIZAR EN NUESTRO PANEL ==

Una vez nuestra aplicación esté registrada en nuestro panel, iremos a la sección de de Desarrolladores y hacemos click en NickCenter —> Añadir app a NickCenter.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Anadir_app_nc_1.png

Para añadir nuestra aplicación a NickCenter deberemos seguir cinco sencillos pasos:

1.- Selección de app: En este apartado tendremos que elegír la aplicación que queremos añadir a NickCenter y decidir si la librería estará activa o no al lanzar la aplicación seleccionada. Esto se podrá activar y desactivar siempre que se desee.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_2.png

2.- Pantalla de registro: En este paso configuraremos lo referente a la vista de registro para los usuarios. Podremos elegir entre varios campos de los cuales, como se indica, el email y password siempre serán obligatorios, el resto, será al gusto del desarrollador; pudiendo elegir que el usuario PUEDA introducir su nombre, pero no siendo obligatorio para el registro.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_3.png

3.- Pantalla de inicio de sesión: Como en el anterior paso, aquí, configuraremos lo referente a la pantalla de inicio de sesión para los usuarios. En este caso, como se indica, solo será obligatorio el campo password.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_4.png

4.- Pantalla de recuperación de contraseña: En este caso, para la pantalla de recuperación de contraseña tan solo se pedira el email del usuario y por tanto, dicho email sera un campo obligatorio.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_5.png

5.- Traducción: Este será el último paso para configurar nuestra aplicación, aquí deberemos seleccionar tanto los idiomas a los que estarán traducidos todos los campos que hemos configurado previamente; como su propia traducción a dichos idiomas. Una vez seleccionado el primer idioma, se pondrá como idioma por defecto de dicha aplicación. Para cambiar el idioma por defecto no tendremos más que generar las traducciones en más idiomas y modificar el campo "Traducción por defecto".

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_6.png

5.1.- Cabeceras y botones: En este primer paso generaremos las traducciones de las cabeceras de las pantallas y de sus botones.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_7.png

5.2.- Configuración de campos: En el segúndo paso generaremos las traducciones de los campos seleccionados previamente para cada pantalla y de sus posibles errores.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_8.png

5.3.- Traducciones generales: En el tercer y último paso generaremos las traducciones generales, traducciones que van asociadas a todas las pantallas y no a una/s en concreto como en los anteriores pasos.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_9.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_10.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_11.png

Una vez finalizadas las traducciones, como se ha indicado previamente, aparecerá el idioma al que se han realizado las traducciones y se pondrá por defecto.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_12.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_13.png

Si al finalizar dicha configuración no hemos quedado satisfechos con los campos seleccionados en alguna de sus pantallas, cuando procedamos a editar dicha pantalla y añadamos un nuevo campo que previamente no ha sido traducido, automáticamente se abrirá una pantalla para generar las traducciones para el IDIOMA POR DEFECTO. Si queremos generar la traducción para el resto de idiomas hemos de volver a realizar lo especificado en el paso 5.-Traducción.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Anadir_nuevo_campo_14.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Anadir_nuevo_campo_15.png

== PASOS A REALIZAR PARA LA INTALACIÓN DEL FRAMEWORK EN LA APLICACIÓN ==

=== INSTALACIÓN: ===

Existen dos maneras de instalar el FrameWork NickCenter: a través de CocoaPods o descargándolo directamente. Recomendamos hacerlo a través de la primera opción. NickCenter incorpora dos frameworks auxiliares, RegisterLib y UtilsLib.

==== INSTALACIÓN CON COCOAPODS: ====

En caso de que su proyecto no incluya el archivo Podfile, incorpórelo. Si nunca ha trabajado con CocoaPods consulte la [https://guides.cocoapods.org/using/using-cocoapods.html documentación ofrecida en su web oficial], en la que se explica paso a paso cómo instalar CocoaPods y cómo crear, actualizar y trabajar con los archivos Podfile.

target 'NameTarget' do
use_frameworks!
pod 'MobeleaderNC'
pod 'MobeleaderUtils'
pod 'MobeleaderRegister'
end

Cabe destacar que NameTarget deberá ser reemplazado por el nombre real del target de la aplicación en la que se quiere añadir el framework.

Una vez creado y configurado el archivo haremos uso del siguiente comando desde el terminal sobre la ruta en la que se encuentra dicho archivo.

$ pod install --repo-update

Y veremos como se crea un proyecto tal que el siguiente:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Proyecto_nc_ios_8.png

Deberemos abrir el proyecto desde dicho archivo para que pueda usar el framework correctamente.

==== INSTALACIÓN MANUAL: ====

Descargue el framework NickCenter:

* Desde la [http://panel.mobeleader.com/index.php?sec=82 página principal de las librerías]:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/descarga_general_nc_ios.png

* Desde la página de información de la libreria(http://panel.mobeleader.com/index.php?sec=85&id=45&tipo=3):

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/descarga_especifica_nc_ios_1.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/referrer/descargar_framework.png

* Directamente desde [https://repos.mobeleader.com/MobeleaderNC/1.0.23/MobeleaderNC.zip aquí].

Una vez descargado el framework, descomprímalo e instálelo en su proyecto.
=== LANZAMIENTO: ===

Una vez configurada la instalación, crearemos un objeto de la clase NickCenter en donde vayamos a usarla, en el ejemplo se hace en la implementacion de la clase DatosIniciales:

@implementation DatosIniciales{
NickCenter *nickCenter;
}

Para su lanzamiento se insertarán las siguientes lineas de código.

nickCenter = [[NickCenter alloc] init];
[nickCenter setDelegate:self];
[nickCenter setRootViewController:self];
[nickCenter setAppHash:@"Hash de la APP en el Panel de Mobeleader"];
[nickCenter checkAndLaunch];

* appHash: Será el hash dado por nuestro panel al dar de alta la aplicación en éste. Para acceder a el deberemos ir a la sección Desarrolladores --> Mis Apps y hacer click sobre la columna Hash de nuestra aplicación.

* setRootViewController: Ésta función será opcional, con ella le diremos al framework desde que ViewController se lanzará y se recogerán las respuestas en los delegates.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Obtener_hash_app_14.png

Por defecto las pantallas de NickCenter presentan el siguiente formato:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_ios_default.jpeg

Si desea modificar las pantallas para que sean lo más parecidas a su aplicación el framework de NickCenter esta dotado de una serie de funciones que le permitirán maquetarlas a su gusto:

* setViewsBackgroundColor:(UIColor \*): Determina el color de fondo de las pantallas.

* setViewsBackgroundImage:(UIImage \*): Determina la imagen de fondo de cada pantalla.

* setHeaderBackgroundColor:(UIColor \*): Determina el color de fondo de la cabecera de las pantallas.

* setHeaderBackgroundImage:(UIImage \*): Determina la imagen de fondo de la cabecera de cada pantalla.

* setHeaderBottomLineColor:(UIColor \*): Determina el color de la linea que separa la cabecera con el resto de la pantalla.

* setHeaderTextColor:(UIColor \*): Determina el color del texto de la cabecera de las pantallas.

* setHeaderFont:(UIFont \*): Determina la fuente de los textos de las cabeceras.

* setTextFieldsBackgroundColor:(UIColor \*): Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla.

* setTextFieldsPlaceholderColor:(UIColor \*): Determina el color del texto descriptivo de cada textfield.

* setTextFieldsTextColor:(UIColor \*): Determina el color del texto de los textfields donde se ubican los campos de cada pantalla.

* setTextFieldsFont:(UIFont \*): Determina la fuente del texto de los textfields.

* setButtonsNormalBackgroundColor:(UIColor \*): Determina el color de fondo de los botones de cada pantalla.

* setButtonsHighlightedBackgroundColor:(UIColor \*): Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos.

* setButtonsNormalTextColor:(UIColor \*): Determina el color del texto de cada boton cuando no se ha hecho click en éstos.

* setButtonsHighlightedTextColor:(UIColor \*): Determina el color del texto de cada boton cuando se ha hecho click en éstos.

* setButtonsBorderColor:(UIColor \*): Determina el color del borde de los botones.

* setButtonsFont:(UIFont \*): Determina la fuente de los textos de los botones.

* setTermsFontColor:(UIColor \*): Determina el color de la fuente de los textos de los terminos y condiciones.

* setTermsSwitchActiveColor:(UIColor \*): Determina el color de los botones activos en los terminos y condiciones.

* setTermsSwitchInactiveColor:(UIColor \*): Determina el color de los botones inactivos en los terminos y condiciones.

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

nickCenter = [[NickCenter alloc] init];
[nickCenter setDelegate:self];
[nickCenter setRootViewController:self];
[nickCenter setAppHash:@"Hash de la APP en el Panel de Mobeleader"];
[nickCenter setViewsBackgroundColor:[UIColor whiteColor]];
[nickCenter setViewsBackgroundImage:[UIImage imageNamed:@"logo"]];
[nickCenter setHeaderBackgroundColor:[UIColor orangeColor]];
[nickCenter setHeaderBottomLineColor:[UIColor orangeColor]];
[nickCenter setHeaderTextColor:[UIColor whiteColor]];
[nickCenter setTextFieldsBackgroundColor:[UIColor colorWithRed:217.0/255 green:217.0/255 blue:217.0/255 alpha:1]];
[nickCenter setTextFieldsPlaceholderColor:[UIColor grayColor]];
[nickCenter setTextFieldsTextColor:[UIColor blackColor]];
[nickCenter setButtonsNormalBackgroundColor:[UIColor orangeColor]];
[nickCenter setButtonsHighlightedBackgroundColor:[UIColor orangeColor]];
[nickCenter setButtonsNormalTextColor:[UIColor whiteColor]];
[nickCenter setButtonsHighlightedTextColor:[UIColor colorWithRed:249.0/255 green:203.0/255 blue:156.0/255 alpha:1]];
[nickCenter setTermsFontColor:[UIColor orangeColor]];
[nickCenter checkAndLaunch];

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_ios_desarrollador.jpeg

=== COMPLETAR REGISTRO: ===

Una vez un usuario haya sido registrado en una de nuestras aplicaciones, cuando otra lance NickCenter, dicho usuario tan soló debera logearse sin necesidad de tener que registrarse otra vez para ésta última aplicación. Se puede dar el caso de que al registrarte en la primera aplicación tán solo fuera necesario email y contraseña, y que para la segunda aplicación fuera necesario registrarse con el telefono, cuando este tipo de casos se den, al logearte en la segunda aplicación se abrirá una nueva vista para completar el registro. Una vez completado dicho registro se tratará como un login normal.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_ios_completar.jpeg

=== FUNCIONES UTILES: ===

NickCenter está dotada de una función que permite al desarrollador cerrar la sesión ya iniciada por el usuario de manera que la siguiente vez que abra la aplicación y pase por donde se lanza la librería, el usuario deba volver a loguearse. Dicha funcion es :

* closeSession: ( [nickCenter closeSession]; )

=== FUNCIONES DE PRECARGA DE DATOS: ===

NickCenter está dotada de una serie de funciones que permite al desarrollador precargar los datos del usuario en la pantalla del registro. De ésta manera si el desarrollador conoce los datos de los usuarios, al lanzar la librería los campos se autorellenarán en la pantalla del registro. Dichas funciones son:

* setUserName(NString \*name): Rellenará el campo "Nombre".

* setUserSurname(NString \*surName): Rellenará el campo "Apellidos".

* setUserEmail(NString \*email): Rellenará el campo "Email". El email ha de ser real, se comprobará tanto el formato de la cadena como la veracidad del propio email. Ejemplo: user@domain.com

* setUserPhone(NString \*phone): Rellenará el campo "Teléfono". Se validará el formato del teléfono; ha de ser un teléfono sin prefijo internacional. Ejemplo: 666777888

* setUserNick(NString \*nick): Rellenará el campo "Nick".

* setUserGender(NString \*gender): Rellenará el campo "Sexo". Será M para Hombre y F para mujer.

* setUserBirthDate(NString \*birthDate): Rellenará el campo "Fecha de Nacimiento". Ha de ser una fecha en formato inglés separado por /. Ejemplo: 1992/01/12.

=== DELEGATES: ===

NickCenter cuenta con una serie de delegates que permiten al desarrollador saber que parte del framework se esta ejecutando y cual es su resultado. A continuación se expondrán éstos y para que sirven.

* onRegisterViewOpened: Notifica cuando la vista de registro se ha lanzado.

* onLoginViewOpened: Notifica cuando la vista del login se ha lanzado.

* onRescueViewOpened: Notifica cuando la vista de recuperación de contraseña se ha lanzado.

* onError:(NSString \*)error: Notificará cuando haya habido un error, normalmente se lanzará cuando el registro o el login hayan sido incorrectos, o cuando al recuperar la contraseña el email sea incorrecto. Se puede dar el caso de que de otro tipo de error como bien puede ser al conectarnos al sevidor.

* onWarning:(NSString \*)warning: Notificará de alguna advertencia al desarrollador.

* onFinished: Notificará cuando la librería haya finalizado algun proceso. Inicio de sesión, registro o recuperación de contraseña correcto.

* onSessionClosed: Notificará cuando se haya cerrado la sesión de NickCenter.

* onActive: Notificará cuando detecte que NickCenter esta activa para la aplicación.

* onInactive: Notificará cuando detecte que NickCenter esta inactiva para la aplicación.

* onRegisterRegisterButtonClicked: Notificará cuando se haga click en el botón de registarse en la vista de registro de usuario.

* onRegisterLoginButtonClicked: Notificará cuando se haga click en el botón de inicio de sesión en la vista de registro de usuario.

* onRegisterCloseButtonClicked: Notificará cuando se haga click en el botón de cerrar en la vista de registro de usuario.

* onRegisterPerformed:(NCUser \) user dictionary:(NSMutableDictionary \) userDictionary: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario tanto en formato NCUser como en formato NSMutableDictionary.

* onLoginPerformed:(NCUser \) user dictionary:(NSMutableDictionary \) userDictionary: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario tanto en formato NCUser como en formato NSMutableDictionary.

* onLoginLoginButtonClicked: Notificará cuando se haga click en el botón de inicio de sesión en la vista de inicio de sesión.

* onLoginRegisterButtonClicked: Notificará cuando se haga click en el botón de registrarse en la vista de inicio de sesión.

* onLoginRescueButtonClicked: Notificará cuando se haga click en el botón de recuperar contraseña en la vista de inicio de sesión.

* onLoginCloseButtonClicked: Notificará cuando se haga click en el botón de cerrar en la vista de inicio de sesión.

* onRescueRescueButtonClicked: Notificará cuando se haga click en el botón de recuperar contraseña en la vista de recuperar contraseña.

- onRescueCloseButtonClicked: Notificará cuando se haga click en el botón de cerrar en la vista de recuperar contraseña.

SDKs:NickCenter:PanelControl

2019-06-07T10:14:09Z

Deneb: /* PASOS A REALIZAR EN NUESTRO PANEL */

== PASOS A REALIZAR EN NUESTRO PANEL ==

Una vez nuestra aplicación esté registrada en nuestro panel, iremos a la sección de de Desarrolladores y hacemos click en NickCenter —> Añadir app a NickCenter.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Anadir_app_nc_1.png

Para añadir nuestra aplicación a NickCenter deberemos seguir cinco sencillos pasos:

1.- Selección de app: En este apartado tendremos que elegír la aplicación que queremos añadir a NickCenter y decidir si la librería estará activa o no al lanzar la aplicación seleccionada. Esto se podrá activar y desactivar siempre que se desee.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_2.png

2.- Pantalla de registro: En este paso configuraremos lo referente a la vista de registro para los usuarios. Podremos elegir entre varios campos de los cuales, como se indica, el email y password siempre serán obligatorios, el resto, será al gusto del desarrollador; pudiendo elegir que el usuario pueda introducir su nombre, pero no siendo obligatorio para el registro.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_3.png

3.- Pantalla de inicio de sesión: Como en el anterior paso, aquí, configuraremos lo referente a la pantalla de inicio de sesión para los usuarios. En este caso, como se indica, solo será obligatorio el campo password.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_4.png

4.- Pantalla de recuperación de contraseña: En este caso, para la pantalla de recuperación de contraseña tan solo se pedira el email del usuario y por tanto, dicho email sera un campo obligatorio.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_5.png

5.- Traducción: Este será el último paso para configurar nuestra aplicación, aquí deberemos seleccionar tanto los idiomas a los que estarán traducidos todos los campos que hemos configurado previamente; como su propia traducción a dichos idiomas. Una vez seleccionado el primer idioma, se pondrá como idioma por defecto de dicha aplicación. Para cambiar el idioma por defecto no tendremos más que generar las traducciones en más idiomas y modificar el campo "Traducción por defecto".

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_6.png

5.1.- Cabeceras y botones: En este primer paso generaremos las traducciones de las cabeceras de las pantallas y de sus botones.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_7.png

5.2.- Configuración de campos: En el segúndo paso generaremos las traducciones de los campos seleccionados previamente para cada pantalla y de sus posibles errores.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_8.png

5.3.- Traducciones generales: En el tercer y último paso generaremos las traducciones generales, traducciones que van asociadas a todas las pantallas y no a una/s en concreto como en los anteriores pasos.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_9.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_10.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_11.png

Una vez finalizadas las traducciones, como se ha indicado previamente, aparecerá el idioma al que se han realizado las traducciones y se pondrá por defecto.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_12.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Configurar_app_nc_13.png

Si al finalizar dicha configuración no hemos quedado satisfechos con los campos seleccionados en alguna de sus pantallas, cuando procedamos a editar dicha pantalla y añadamos un nuevo campo que previamente no ha sido traducido, automáticamente se abrirá una pantalla para generar las traducciones para el IDIOMA POR DEFECTO. Si queremos generar la traducción para el resto de idiomas hemos de volver a realizar lo especificado en el paso 5.-Traducción.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Anadir_nuevo_campo_14.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Anadir_nuevo_campo_15.png

SDKs:Push:iOS:index

2019-06-07T10:12:27Z

Deneb: /* INSTALACIÓN MANUAL DEL FRAMEWORK: */

= CÓMO AGREGAR EL FRAMEWORK PUSHLIB EN iOS =

== INTRODUCCIÓN. ==

Este framework usa el sistema Push de iOs, denominado APNS. Lo primero que realiza es la recogida del Token de cada terminal por aplicación para registrarlo en nuestro sistema. Una vez registrado, se le pueden enviar las notificaciones que desee y que el framework las reciba y las muestre.

== VERSIONES SOPORTADAS DE iOS. ==

El framework Push soporta versiones de iOs 10 en adelante, en caso de ser menor que iOs 10 no se lanzará.

== PASOS A REALIZAR EN APPLE DEVELOPER CENTER. ==

Para poder enviar notificaciones push lo primero que deberemos hacer es crear los certificados para cada aplicación en [https://developer.apple.com/membercenter/ Apple Developer Center].

Una vez hayamos accedido nos dirigiremos a la sección Identifiers --> App IDs y pincharemos sobre el simbolo del + parar agregar uno nuevo.

A continuación, debemos crear los certificados, para ello pinchamos en Create Certificate y seguimos
las instrucciones que nos indican:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/certificados.png

Una vez creados los dos certificados de APNS, tanto el de Development, como el de Production, podremos configurarlos en nuestro panel. Supongamos que queremos usar el de producción
directamente, entonces lo que tenemos que hacer es pinchar dos veces en el certificado para que se nos habrá
el keychain.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/keychain.png

Seleccionamos el certificado y damos en el menú Archivo --> Exportar items y se nos dará la opción de
exportarlo como .p12 Archivo de Intercambio de Información Personal. Cuando os pregunté por la
contraseña pincháis a Aceptar y no insertáis ninguna contraseña. Una vez que tenemos el Archivo .p12
habrá que configurarlo en nuestro panel.

== PASOS A REALIZAR EN NUESTRO PANEL ==

{{:SDKs:Push:pasos_panel}}

{{:SDKs:Push:configurar_ios}}

== PASOS A REALIZAR PARA LA INSTALACIÓN DEL FRAMEWORK EN LA APLICACIÓN ==

Existen dos maneras de instalar el framework Push: a través de CocoaPods o descargándolo directamente. Recomendamos hacerlo a través de la primera opción. Push incorpora dos frameworks auxiliares, RegisterLib y UtilsLib.

=== INSTALACIÓN CON COCOAPODS: ===

En caso de que su proyecto no incluya el archivo Podfile, incorpórelo. Si nunca ha trabajado con CocoaPods consulte la [https://guides.cocoapods.org/using/using-cocoapods.html documentación ofrecida en su web oficial], en la que se explica paso a paso cómo instalar CocoaPods y cómo crear, actualizar y trabajar con los archivos Podfile.

Añada al archivo Podfile de su proyecto las siguientes dependencias:

target 'NameTarget' do
use_frameworks!
pod 'MobeleaderPush'
pod 'MobeleaderUtils'
pod 'MobeleaderRegister'
end

Cabe destacar que NameTarget deberá ser reemplazado por el nombre real del target de la aplicación en la que se quiere añadir el framework.

Una vez creado y configurado el archivo haremos uso del siguiente comando desde el terminal sobre la ruta en la que se encuentra dicho archivo.

$ pod install --repo-update

Y veremos como se crea un proyecto tal que el siguiente:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Proyecto_nc_ios_8.png

Deberemos abrir el proyecto desde dicho archivo para que pueda usar el framework correctamente.

=== INSTALACIÓN MANUAL DEL FRAMEWORK: ===

Descargue el framework Push:

* Desde la [http://panel.mobeleader.com/index.php?sec=82 página principal de las librerías]:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/descargar_ios_push_general.png

* Desde la página de [http://panel.mobeleader.com/index.php?sec=85&id=47&tipo=2 información de la libreria]:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/descargar_ios_push_especifica_1.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/referrer/descargar_framework.png

* Directamente desde [https://repos.mobeleader.com/MobeleaderPush/1.61.XX/MobeleaderPush.zip aquí].

Una vez descargado el framework, descomprímalo e instálelo en su proyecto.

=== LANZAMIENTO ===

Una vez configurada correctamente la aplicación en nuestro panel con sus respectivos certificados, e instalado el framework, procederemos a realizar las siguientes configuraciones en nuestro proyecto.

1.- Desde la sección Captabilities de nuestro "target" principal en el proyecto. Deberemos realizar las siguientes configuraciones:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/captabilities_ios.png

1.1.- Activaremos las Notificaciones Push.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/active_push_ios.png

1.2- Activaremos el Background Mode, de manera que nos deje activar las notificaciones remotas tal que se muestra en la siguiente imagen.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/background_mode_ios_push.png

2.- Desde la sección Info de nuestro "target" principal en el proyecto. Deberemos añadir la siguiente key con el fin de añadir soporte a conexiones que no sean https ( obligatorio a partir de iOs 9 ):

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/seccion_info.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/info_plist_ios.png

3.- El framework Push esta dotado de la capacidad de mostrar notificaciones enriquecidas; es decir, es capaz de mostrar notificaciones con contenido como imagenes, videos y audios. Para ello deberemos añadir a nuestro target principal una nueva extensión siguiendo los pasos expuestos a continuación:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/add_ns_1.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/add_ns_2.png

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/RichNotifications_edited.png

Por motivos de seguridad y privacidad en ésta última imagen se han protegido los datos relacionados con el desarollador y la compañia desarrolladora. Cabe destacar, que en el apartado Embed in Application deberemos seleccionador el target de la aplicación configurada previamente en los pasos 1 y 2 de éste mismo apartado.

Al añadir la extensión se generará algo tal que lo siguiente en nuestro proyecto:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/push/RichNotifications_folders.png

Deberemos reemplazar el código del metodo didReceiveNotificationRequest del archivo NotificationService.m, dicho código será el siguiente:

- (void)didReceiveNotificationRequest:(UNNotificationRequest )request withContentHandler:(void (^)(UNNotificationContent _Nonnull))contentHandler {

self.contentHandler = contentHandler;
self.bestAttemptContent = [request.content mutableCopy];
NSString *attachmentUrlString = [request.content.userInfo objectForKey:@"media-attachment"];

if (![attachmentUrlString isKindOfClass:[NSString class]])
return;

NSURL *url = [NSURL URLWithString:attachmentUrlString];
if (!url)
return;

[[[NSURLSession sharedSession] downloadTaskWithURL:url completionHandler:^(NSURL _Nullable location, NSURLResponse _Nullable response, NSError * _Nullable error) {
if (!error) {
NSString *tempDict = NSTemporaryDirectory();
NSString *attachmentID = [[[NSUUID UUID] UUIDString] stringByAppendingString:[response.URL.absoluteString lastPathComponent]];

if(response.suggestedFilename)
attachmentID = [[[NSUUID UUID] UUIDString] stringByAppendingString:response.suggestedFilename];

NSString *tempFilePath = [tempDict stringByAppendingPathComponent:attachmentID];

if ([[NSFileManager defaultManager] moveItemAtPath:location.path toPath:tempFilePath error:&error]) {
UNNotificationAttachment *attachment = [UNNotificationAttachment attachmentWithIdentifier:attachmentID URL:[NSURL fileURLWithPath:tempFilePath] options:nil error:&error];

if (!attachment) {
NSLog(@"Create attachment error: %@", error);
} else {
_bestAttemptContent.attachments = [_bestAttemptContent.attachments arrayByAddingObject:attachment];
}
} else {
NSLog(@"Move file error: %@", error);
}
} else {
NSLog(@"Download file error: %@", error);
}

[[NSOperationQueue mainQueue] addOperationWithBlock:^{
self.contentHandler(self.bestAttemptContent);
}];
}] resume];
}

4.- Para finalizar y poder lanzar el framework, configuraremos los archivos AppDelegate.h y AppDelegate.m de nuestro proyecto:

4.1.- AppDelegate.h: Añadiremos el siguiente import, de manera que podamos añadir su delegate al interface tal y como se muestra en las imagenes.

#Import <UserNotifications/UserNotifications.h>

@interface AppDelegate : UIResponder <UNUserNotificationCenterDelegate>

4.2.- AppDelegate.m: Comenzaremos importando el framework Push.

#Import <MobeleaderPush/MobeleaderPush.h>

4.2.1.- AppDelegate.m: A continuación en la función didFinishLaunchingWithOptions introduciremos lo siguiente.

#[[Push shared] setAppHash:@"App Hash"];
#[[Push shared] setDelegate:self];
#[[Push shared] activePushNotificationsInForegroundApp:NO];
#[[Push shared] activePushNotifications:YES];

if([launchOptions count] > 0){
NSDictionary *remoteNoti = [launchOptions objectForKey: UIApplicationLaunchOptionsRemoteNotificationKey];
[[Push shared] didReceiveRemoteNotification:remoteNoti];
}

Cabe destacar que: "App Hash" deberá ser reemplazado por el hash de la aplicación añadida a nuestro panel, y que la función activePushNotificationsInForegroundApp será opcional. Haciendo uso de ella decidiremos si las notificaciones se mostrarán cuando la aplicación este en primer plano. No se mostrarán por defecto.

4.2.2.- AppDelegate.m: Tambien añadiremos las siguientes funciones al código. Poniendo especial atención en la encargada de recibir notificaciones.

- (void)application:(UIApplication )application didRegisterForRemoteNotificationsWithDeviceToken:(NSData )devToken{
[[Push shared] registerForRemoteNotificationsWithDeviceToken:devToken];
[[Push shared] resetBadge];
}

- (void)application:(UIApplication )application didReceiveRemoteNotification:(NSDictionary )userInfo fetchCompletionHandler(void (^)(UIBackgroundFetchResult result))completionHandler{
[[Push shared] application:application didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
}

Como se ha indicado previamente, esta segunda función es especial. A partir de iOs 10 tan solo recibira las notificaciones silenciosas o en background. Normalmente, dichas notificaciones son para que las aplicaciones hagan algo por detras sin que el usuario lo detecte, por lo que tendremos dos opciones: 1º, procesaremos directamente lo que queramos en dicha función o 2º, tal y como se muestra en la imagen, dejaremos que el FrameWork procese la notificación y la recogeremos en el delegate onReceiveNotification, donde la procesaremos. Esto se deja al gusto del desarrollador.

=== DELEGATES ===

El framework Push esta dotado de varios delegates opcionales mediante los cuales se podrá controlar lo que esta sucediendo en cada momento. Dichos delegates son los siguientes:

* onGetToken:(NSString \*) token: Notifica cuando la librería ha recibido el token (Para rescatar este token y poder hacer pruebas con el) y devuelve el token registrado en el argumento NSString.

* onRegisterToken:(NSString \*) token: Notifica cuando la librería ha registrado el token y devuelve el token registrado en el argumento NSString.

* onUpdateToken:(NSString \*) token: Notifica cuando la librería ha actualizado el token y devuelve el token actualizado en el argumento NSString.

* onReceiveNotification:(NSDictionary \*) dictionary: Notifica cuando la librería ha recibido una notificación y devuelve la notificación en el argumento NSDictionary.

* onError:(NSString \*) error: Notifica cuando la librería ha tenido algún error, y devuelve la descripción del error en el argumento NSString.

-(void)onGetToken:(NSString *)token{}
-(void)onRegisterToken:(NSString *)token{}
-(void)onUpdateToken:(NSString *)token{}
-(void)onReceiveNotification:(NSDictionary *)notification{}
-(void)onError:(NSString *)error

------------

SDKs:Miner:iOS:index

2019-06-07T10:08:21Z

Deneb: /* LANZAMIENTO DEL FRAMEWORK. */

#CÓMO AGREGAR EL FRAMEWORK MINER EN IOS

== INTRODUCCIÓN. ==

El framework Miner permite monetizar la aplicación a través del minado de operaciones de blockchain. Las ganancias generadas dependerán del número de operaciones minadas por la app, lo cual dependerá, a su vez, de dos factores:
* La capacidad del procesador del terminal en el que se está ejecutando el framework.

* El tiempo que está el framework minando.

== VERSIONES DE IOS SOPORTADAS. ==

Este framework admite la versión 10.0 de iOS y superiores.

== INSTALACION DEL FRAMEWORK. ==

Existen dos maneras de instalar el framework Miner:
* A través de CocoaPods. Opción recomendada.

* Descargándolo directamente.

=== Instalación con CocoaPods. ===

En caso de que su proyecto no incluya el archivo Podfile, incorpórelo. Si nunca ha trabajado con CocoaPods consulte la [https://guides.cocoapods.org/using/using-cocoapods.html documentación ofrecida en su web oficial], en la que se explica paso a paso cómo instalar CocoaPods y cómo crear, actualizar y trabajar con los archivos Podfile.

Añada al archivo Podfile de su proyecto las siguientes dependencias:

pod 'MobeleaderMiner'

A continuación, en el directorio de su proyecto ejecute la siguiente línea de comandos:

$ pod install --repo-update

Se creará el workspace de su proyecto de la siguiente manera:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Proyecto_nc_ios_8.png

Abra el proyecto desde el workspace para poder usar el framework correctamente.

=== Instalación manual del framework. ===

Descargue el framework Miner:

* Desde la [http://panel.mobeleader.com/index.php?sec=82 página principal de las librerías]:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/miner/miner_download.png

* Desde la [http://panel.mobeleader.com/index.php?sec=85&id=53&tipo=7 página de información del framework Miner 1.00 de iOS]:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/sps/desc_framework.png

* Directamente desde [https://repos.mobeleader.com/MobeleaderMiner/1.0.36/MobeleaderMiner-1.0.36.zip aquí].

Una vez descargado el framework instálelo en su proyecto.

== LANZAMIENTO DEL FRAMEWORK. ==

Seleccione el controller desde el cual quiera ejecutar el minado e importe la cabecera:

```cpp
#import <MobeleaderMiner/Miner.h>
```

Declare la clase Miner como atributo global en el implementation:
```cpp
Miner *miner;
```

En el viewDidLoad del controller inicialice la clase:
```cpp
miner = [[Miner alloc] init];
miner.delegate = self;
[miner setAppHash:@"app_hash"];
[miner setRootViewController:self];
```

Los campos setAppHash:@“appHash” y setRootViewController son obligatorios.

En el campo appHash ha de introducir el código hash de su aplicación, generado al registrar su aplicación en el Panel de Mobeleader. Lo puede obtener en la sección [http://panel.mobeleader.com/index.php?sec=6Mis Aplicaciones], pulsando el icono de la columna "Hash" de su aplicación.
https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/sps/app_hash.png

Una vez inicializada la librería y definidos los parámetros utilice el método start para comenzar el proceso de minado:
```cpp
[miner start];
```

Utilice el método stop para detener el proceso de minado cuando lo desee:
```cpp
[miner stop];
```

== DELEGATES. ==

El framework Miner está dotado de varios delegates opcionales:

* onLibStart: notifica el lanzamiento del framework.

* onStartMining: notifica cuando el framework comienza el proceso de minado.

* onStop: notifica al detener el proceso de minado.

* onError: notifica cuando el framework haya tenido algún error. Devuelve un string con la descripción del error producido.

Para acceder a los delegates, la llamada al framework SpsLib deberá realizarse de la siguiente forma (se pueden implementar tantos delegates como se quiera, no es necesario implementarlos todos):

- (void)onLibStart
{
// Complete delegate
}

- (void)onStartMining
{
// Complete delegate
}

- (void)onStopMinig
{
// Complete delegate
}

- (void)onError:(NSString *)error
{
// Complete delegate
}

== CONSIDERACIONES ACERCA DEL MINADO. ==

* El proceso de minado se traduce en un consumo significativo de la batería, por lo que recomendamos no abusar de su uso.

- El minado de operaciones blockchain (coloquialmente conocido como minado de criptomonedas) es un ámbito desconocido para la mayor parte de los usuarios. Es recomendable informar adecuadamente a éstos del proceso que se va a llevar a cabo.

SDKs:Miner:iOS:index

2019-06-07T10:07:55Z

Deneb: /* Instalación manual del framework. */

#CÓMO AGREGAR EL FRAMEWORK MINER EN IOS

== INTRODUCCIÓN. ==

El framework Miner permite monetizar la aplicación a través del minado de operaciones de blockchain. Las ganancias generadas dependerán del número de operaciones minadas por la app, lo cual dependerá, a su vez, de dos factores:
* La capacidad del procesador del terminal en el que se está ejecutando el framework.

* El tiempo que está el framework minando.

== VERSIONES DE IOS SOPORTADAS. ==

Este framework admite la versión 10.0 de iOS y superiores.

== INSTALACION DEL FRAMEWORK. ==

Existen dos maneras de instalar el framework Miner:
* A través de CocoaPods. Opción recomendada.

* Descargándolo directamente.

=== Instalación con CocoaPods. ===

En caso de que su proyecto no incluya el archivo Podfile, incorpórelo. Si nunca ha trabajado con CocoaPods consulte la [https://guides.cocoapods.org/using/using-cocoapods.html documentación ofrecida en su web oficial], en la que se explica paso a paso cómo instalar CocoaPods y cómo crear, actualizar y trabajar con los archivos Podfile.

Añada al archivo Podfile de su proyecto las siguientes dependencias:

pod 'MobeleaderMiner'

A continuación, en el directorio de su proyecto ejecute la siguiente línea de comandos:

$ pod install --repo-update

Se creará el workspace de su proyecto de la siguiente manera:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Proyecto_nc_ios_8.png

Abra el proyecto desde el workspace para poder usar el framework correctamente.

=== Instalación manual del framework. ===

Descargue el framework Miner:

* Desde la [http://panel.mobeleader.com/index.php?sec=82 página principal de las librerías]:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/miner/miner_download.png

* Desde la [http://panel.mobeleader.com/index.php?sec=85&id=53&tipo=7 página de información del framework Miner 1.00 de iOS]:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/sps/desc_framework.png

* Directamente desde [https://repos.mobeleader.com/MobeleaderMiner/1.0.36/MobeleaderMiner-1.0.36.zip aquí].

Una vez descargado el framework instálelo en su proyecto.

== LANZAMIENTO DEL FRAMEWORK. ==

Seleccione el controller desde el cual quiera ejecutar el minado e importe la cabecera:

```cpp
#import <MobeleaderMiner/Miner.h>
```

Declare la clase Miner como atributo global en el implementation:
```cpp
Miner *miner;
```

En el viewDidLoad del controller inicialice la clase:
```cpp
miner = [[Miner alloc] init];
miner.delegate = self;
[miner setAppHash:@"app_hash"];
[miner setRootViewController:self];
```

Los campos setAppHash:@“appHash” y setRootViewController son obligatorios.

En el campo appHash ha de introducir el código hash de su aplicación, generado al registrar su aplicación en el Panel de Mobeleader. Lo puede obtener en la sección [Mis Aplicaciones](http://panel.mobeleader.com/index.php?sec=6), pulsando el icono de la columna "Hash" de su aplicación.
https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/sps/app_hash.png

Una vez inicializada la librería y definidos los parámetros utilice el método start para comenzar el proceso de minado:
```cpp
[miner start];
```

Utilice el método stop para detener el proceso de minado cuando lo desee:
```cpp
[miner stop];
```

== DELEGATES. ==

El framework Miner está dotado de varios delegates opcionales:

* onLibStart: notifica el lanzamiento del framework.

* onStartMining: notifica cuando el framework comienza el proceso de minado.

* onStop: notifica al detener el proceso de minado.

* onError: notifica cuando el framework haya tenido algún error. Devuelve un string con la descripción del error producido.

Para acceder a los delegates, la llamada al framework SpsLib deberá realizarse de la siguiente forma (se pueden implementar tantos delegates como se quiera, no es necesario implementarlos todos):

- (void)onLibStart
{
// Complete delegate
}

- (void)onStartMining
{
// Complete delegate
}

- (void)onStopMinig
{
// Complete delegate
}

- (void)onError:(NSString *)error
{
// Complete delegate
}

== CONSIDERACIONES ACERCA DEL MINADO. ==

* El proceso de minado se traduce en un consumo significativo de la batería, por lo que recomendamos no abusar de su uso.

- El minado de operaciones blockchain (coloquialmente conocido como minado de criptomonedas) es un ámbito desconocido para la mayor parte de los usuarios. Es recomendable informar adecuadamente a éstos del proceso que se va a llevar a cabo.

SDKs:Miner:iOS:index

2019-06-07T10:06:59Z

Deneb: /* Instalación con CocoaPods. */

#CÓMO AGREGAR EL FRAMEWORK MINER EN IOS

== INTRODUCCIÓN. ==

El framework Miner permite monetizar la aplicación a través del minado de operaciones de blockchain. Las ganancias generadas dependerán del número de operaciones minadas por la app, lo cual dependerá, a su vez, de dos factores:
* La capacidad del procesador del terminal en el que se está ejecutando el framework.

* El tiempo que está el framework minando.

== VERSIONES DE IOS SOPORTADAS. ==

Este framework admite la versión 10.0 de iOS y superiores.

== INSTALACION DEL FRAMEWORK. ==

Existen dos maneras de instalar el framework Miner:
* A través de CocoaPods. Opción recomendada.

* Descargándolo directamente.

=== Instalación con CocoaPods. ===

En caso de que su proyecto no incluya el archivo Podfile, incorpórelo. Si nunca ha trabajado con CocoaPods consulte la [https://guides.cocoapods.org/using/using-cocoapods.html documentación ofrecida en su web oficial], en la que se explica paso a paso cómo instalar CocoaPods y cómo crear, actualizar y trabajar con los archivos Podfile.

Añada al archivo Podfile de su proyecto las siguientes dependencias:

pod 'MobeleaderMiner'

A continuación, en el directorio de su proyecto ejecute la siguiente línea de comandos:

$ pod install --repo-update

Se creará el workspace de su proyecto de la siguiente manera:

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/Proyecto_nc_ios_8.png

Abra el proyecto desde el workspace para poder usar el framework correctamente.

=== Instalación manual del framework. ===

Descargue el framework Miner:

* Desde la [página principal de las librerías](http://panel.mobeleader.com/index.php?sec=82):

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/miner/miner_download.png

* Desde la [página de información del framework Miner 1.00 de iOS](http://panel.mobeleader.com/index.php?sec=85&id=53&tipo=7):

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/sps/desc_framework.png

* Directamente desde [aquí](https://repos.mobeleader.com/MobeleaderMiner/1.0.36/MobeleaderMiner-1.0.36.zip).

Una vez descargado el framework instálelo en su proyecto.

== LANZAMIENTO DEL FRAMEWORK. ==

Seleccione el controller desde el cual quiera ejecutar el minado e importe la cabecera:

```cpp
#import <MobeleaderMiner/Miner.h>
```

Declare la clase Miner como atributo global en el implementation:
```cpp
Miner *miner;
```

En el viewDidLoad del controller inicialice la clase:
```cpp
miner = [[Miner alloc] init];
miner.delegate = self;
[miner setAppHash:@"app_hash"];
[miner setRootViewController:self];
```

Los campos setAppHash:@“appHash” y setRootViewController son obligatorios.

En el campo appHash ha de introducir el código hash de su aplicación, generado al registrar su aplicación en el Panel de Mobeleader. Lo puede obtener en la sección [Mis Aplicaciones](http://panel.mobeleader.com/index.php?sec=6), pulsando el icono de la columna "Hash" de su aplicación.
https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/sps/app_hash.png

Una vez inicializada la librería y definidos los parámetros utilice el método start para comenzar el proceso de minado:
```cpp
[miner start];
```

Utilice el método stop para detener el proceso de minado cuando lo desee:
```cpp
[miner stop];
```

== DELEGATES. ==

El framework Miner está dotado de varios delegates opcionales:

* onLibStart: notifica el lanzamiento del framework.

* onStartMining: notifica cuando el framework comienza el proceso de minado.

* onStop: notifica al detener el proceso de minado.

* onError: notifica cuando el framework haya tenido algún error. Devuelve un string con la descripción del error producido.

Para acceder a los delegates, la llamada al framework SpsLib deberá realizarse de la siguiente forma (se pueden implementar tantos delegates como se quiera, no es necesario implementarlos todos):

- (void)onLibStart
{
// Complete delegate
}

- (void)onStartMining
{
// Complete delegate
}

- (void)onStopMinig
{
// Complete delegate
}

- (void)onError:(NSString *)error
{
// Complete delegate
}

== CONSIDERACIONES ACERCA DEL MINADO. ==

* El proceso de minado se traduce en un consumo significativo de la batería, por lo que recomendamos no abusar de su uso.

- El minado de operaciones blockchain (coloquialmente conocido como minado de criptomonedas) es un ámbito desconocido para la mayor parte de los usuarios. Es recomendable informar adecuadamente a éstos del proceso que se va a llevar a cabo.