mobeleader - Contribuciones del usuario [es]

SDKs:NickCenter:Cordova:index

2018-11-21T09:31:32Z

Kevin:

= CÓMO AGREGAR EL PLUGIN NICKCENTER EN CORDOVA =

{{:SDKs:NickCenter:Intro}}

== VERSIONES SOPORTADAS ==

Este Plugin soporta tanto Android como iOS.

Para iOS soporta las versiones superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

Para Android soporta todas las versiones superiores a la 4.0

{{:SDKs:NickCenter:PanelControl}}

== PASOS A REALIZAR PARA LA INTALACIÓN DEL PLUGIN ==

=== INSTALACIÓN: ===

Para instalar el Plugin, si queremos que funcione en iOS, primero tendremos que instalar el plugin cordova-plugin-cocoapod-support, de la siguiente manera:
cordova plugin add cordova-plugin-cocoapod-support
y después instalar el plugin de Nickcenter de esta manera (si solo lo vamos a usar para android con este plugin es suficiente):
cordova plugin add cordova-plugin-nickcenter

Una vez ejecutados los dos comandos ya tendremos el plugin instalado.

=== LANZAMIENTO: ===

Una vez configurada la instalación, lanzaremos en el momento donde queramos el código, por ejemplo:

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["54e46801egh95"]);

Los Argumentos enviados serán los siguientes:
* Argumento 1: Es el AppHash de la aplicación, el cual se puede obtener en el panel, como muestra la siguiente pantalla.

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 NickCenter deberá añadir más argumentos, en el siguiente orden (Estos Argumentos son completamente Opcionales) (Todos los colores deben ir en hexadecimal):

* Argumento 2: Determina el color de fondo de las pantallas. Ejemplo: "#ffffff"

* Argumento 3: Determina el color de fondo de la cabecera de las pantallas. Ejemplo: "#f0f0f0"

* Argumento 4: Determina el color de la linea que separa la cabecera con el resto de la pantalla. Ejemplo: "#01e3fe"

* Argumento 5: Determina el color del texto de la cabecera de las pantallas. Ejemplo: "#7b7b7b"

* Argumento 6: Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#ebebeb"

* Argumento 7: Determina el color del texto descriptivo de cada textfield. Ejemplo: "#7b7b7b"

* Argumento 8: Determina el color del texto de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 9: Determina el color de fondo de los botones de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 10: Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos. Ejemplo: "#000000"

* Argumento 11: Determina el color del texto de cada boton cuando no se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 12: Determina el color del texto de cada botón cuando se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 13: Determina el color del borde de los botones. Ejemplo: "#01e3fe"

* Argumento 14: Determina el color de la fuente de los textos de los terminos y condiciones. Ejemplo: "#000000"

* Argumento 15: (Solo para iOS) Determina el color de los botones activos en los términos y condiciones. Ejemplo: "#01e3fe"

* Argumento 16: (Solo para iOS) Determina el color de los botones inactivos en los términos y condiciones. Ejemplo: "#f0f0f0"

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#000000", "#01e3fe", "#f0f0f0"]);

Cabe destacar que en el caso de Android, Cordova pone los checkbox por defecto de color blanco, por lo que sí queremos que se vean deberemos usar un fondo de pantalla que no sea blanco.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_cordova_colores.png

=== 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

Ejemplo:
cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "closeNickCenterSession", ["hash_app"]);

=== PRECARGA DE DATOS PARA EL REGISTRO: ===

NickCenter está dotada de una serie de funciones que permiten al desarrollador precargar los datos del usuario a la hora de mostrarle la pantalla de registro. Si desea hacer uso de esta precarga deberá pasar más argumentos a la llamada de la librería ( todos estos argumentos son opcionales ) :

* Argumento 17: Nombre. Ejemplo: "kevin".
* Argumento 18: Apellidos. Ejemplo: "lancharro".
* Argumento 19: Email. Deberá ser un email válido, se comprobará tanto el formato de la cadena como la validez de éste. Ejemplo: "user@domain.com".
* Argumento 20: Teléfono. Deberá ser un teléfono sin prefijo internacional. Ejemplo: "666777888".
* Argumento 21: Nick. Ejemplo: "CocoZilla".
* Argumento 22: Género. Deberá ser M para hombres y F para mujeres.
* Argumento 23: Fecha de nacimiento. Deberá ser una fecha en formato inglés separado por /. Ejemplo: "1992/01/12"

A continuación se expone un ejemplo siguiendo la maquetación expuesta en anteriores puntos.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#f0f0f0", "nombre", "apellido", "user@domain.com", "666777888", "CocoZilla", "M", "1992/01/12"]);

[[Archivo:Precarga_datos_cordova.png|center]]

=== CallBacks: ===

NickCenter cuenta con una serie de callbacks los cuales se pueden recoger en en las funciones implementadas successNickCenterCallback y errorNickCenterCallback que permiten al desarrollador saber qué parte del plugin se esta ejecutando y cuál 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: Cadena de 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: Cadena de 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 registrarse 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: Json de Usuario: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario en formato Json.

* onLoginPerformed: Json de Usuario: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario en formato Json.

* 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:Cordova:index

2018-11-20T14:45:00Z

Kevin: /* PRECARGA DE DATOS PARA EL REGISTRO: */

= CÓMO AGREGAR EL PLUGIN NICKCENTER EN CORDOVA =

{{:SDKs:NickCenter:Intro}}

== VERSIONES SOPORTADAS ==

Este Plugin soporta tanto Android como iOS.

Para iOS soporta las versiones superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

Para Android soporta todas las versiones superiores a la 4.0

{{:SDKs:NickCenter:PanelControl}}

== PASOS A REALIZAR PARA LA INTALACIÓN DEL PLUGIN ==

=== INSTALACIÓN: ===

Para instalar el Plugin, si queremos que funcione en iOS, primero tendremos que instalar el plugin cordova-plugin-cocoapod-support, de la siguiente manera:
cordova plugin add cordova-plugin-cocoapod-support
y después instalar el plugin de Nickcenter de esta manera (si solo lo vamos a usar para android con este plugin es suficiente):
cordova plugin add cordova-plugin-nickcenter

Una vez ejecutados los dos comandos ya tendremos el plugin instalado.

=== LANZAMIENTO: ===

Una vez configurada la instalación, lanzaremos en el momento donde queramos el código, por ejemplo:

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["54e46801egh95"]);

Los Argumentos enviados serán los siguientes:
* Argumento 1: Es el AppHash de la aplicación, el cual se puede obtener en el panel, como muestra la siguiente pantalla.

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 NickCenter deberá añadir más argumentos, en el siguiente orden (Estos Argumentos son completamente Opcionales) (Todos los colores deben ir en hexadecimal):

* Argumento 2: Determina el color de fondo de las pantallas. Ejemplo: "#ffffff"

* Argumento 3: Determina el color de fondo de la cabecera de las pantallas. Ejemplo: "#f0f0f0"

* Argumento 4: Determina el color de la linea que separa la cabecera con el resto de la pantalla. Ejemplo: "#01e3fe"

* Argumento 5: Determina el color del texto de la cabecera de las pantallas. Ejemplo: "#7b7b7b"

* Argumento 6: Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#ebebeb"

* Argumento 7: Determina el color del texto descriptivo de cada textfield. Ejemplo: "#7b7b7b"

* Argumento 8: Determina el color del texto de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 9: Determina el color de fondo de los botones de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 10: Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos. Ejemplo: "#000000"

* Argumento 11: Determina el color del texto de cada boton cuando no se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 12: Determina el color del texto de cada botón cuando se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 13: Determina el color del borde de los botones. Ejemplo: "#01e3fe"

* Argumento 14: Determina el color de la fuente de los textos de los terminos y condiciones. Ejemplo: "#000000"

* Argumento 15: (Solo para iOS) Determina el color de los botones activos en los términos y condiciones. Ejemplo: "#01e3fe"

* Argumento 16: (Solo para iOS) Determina el color de los botones inactivos en los términos y condiciones. Ejemplo: "#f0f0f0"

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#000000", "#01e3fe", "#f0f0f0"]);

Cabe destacar que en el caso de Android, Cordova pone los checkbox por defecto de color blanco, por lo que sí queremos que se vean deberemos usar un fondo de pantalla que no sea blanco.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_cordova_colores.png

=== 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

Ejemplo:
cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "closeNickCenterSession", ["hash_app"]);

=== PRECARGA DE DATOS PARA EL REGISTRO: ===

NickCenter está dotada de una serie de funciones que permiten al desarrollador precargar los datos del usuario a la hora de mostrarle la pantalla de registro. Si desea hacer uso de esta precarga deberá pasar más argumentos a la llamada de la librería ( todos estos argumentos son opcionales ) :

* Argumento 17: Nombre. Ejemplo: "kevin".
* Argumento 18: Apellidos. Ejemplo: "lancharro".
* Argumento 19: Email. Deberá ser un email válido, se comprobará tanto el formato de la cadena como la validez de éste. Ejemplo: "user@domain.com".
* Argumento 20: Teléfono. Deberá ser un teléfono sin prefijo internacional. Ejemplo: "666777888".
* Argumento 21: Nick. Ejemplo: "CocoZilla".
* Argumento 22: Género. Deberá ser M para hombres y F para mujeres.
* Argumento 23: Fecha de nacimiento. Deberá ser una fecha en formato inglés separado por /. Ejemplo: "1992/01/12"

A continuación se expone un ejemplo siguiendo la maquetación expuesta en anteriores puntos.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#f0f0f0", "kevin", "lancharro", "user@domain.com", "666777888", "CocoZilla", "M", "1992/01/12"]);

[[Archivo:Precarga_datos_cordova.png|center]]

=== CallBacks: ===

NickCenter cuenta con una serie de callbacks los cuales se pueden recoger en en las funciones implementadas successNickCenterCallback y errorNickCenterCallback que permiten al desarrollador saber qué parte del plugin se esta ejecutando y cuál 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: Cadena de 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: Cadena de 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 registrarse 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: Json de Usuario: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario en formato Json.

* onLoginPerformed: Json de Usuario: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario en formato Json.

* 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:Cordova:index

2018-11-20T14:44:10Z

Kevin: /* PRECARGA DE DATOS PARA EL REGISTRO: */

= CÓMO AGREGAR EL PLUGIN NICKCENTER EN CORDOVA =

{{:SDKs:NickCenter:Intro}}

== VERSIONES SOPORTADAS ==

Este Plugin soporta tanto Android como iOS.

Para iOS soporta las versiones superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

Para Android soporta todas las versiones superiores a la 4.0

{{:SDKs:NickCenter:PanelControl}}

== PASOS A REALIZAR PARA LA INTALACIÓN DEL PLUGIN ==

=== INSTALACIÓN: ===

Para instalar el Plugin, si queremos que funcione en iOS, primero tendremos que instalar el plugin cordova-plugin-cocoapod-support, de la siguiente manera:
cordova plugin add cordova-plugin-cocoapod-support
y después instalar el plugin de Nickcenter de esta manera (si solo lo vamos a usar para android con este plugin es suficiente):
cordova plugin add cordova-plugin-nickcenter

Una vez ejecutados los dos comandos ya tendremos el plugin instalado.

=== LANZAMIENTO: ===

Una vez configurada la instalación, lanzaremos en el momento donde queramos el código, por ejemplo:

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["54e46801egh95"]);

Los Argumentos enviados serán los siguientes:
* Argumento 1: Es el AppHash de la aplicación, el cual se puede obtener en el panel, como muestra la siguiente pantalla.

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 NickCenter deberá añadir más argumentos, en el siguiente orden (Estos Argumentos son completamente Opcionales) (Todos los colores deben ir en hexadecimal):

* Argumento 2: Determina el color de fondo de las pantallas. Ejemplo: "#ffffff"

* Argumento 3: Determina el color de fondo de la cabecera de las pantallas. Ejemplo: "#f0f0f0"

* Argumento 4: Determina el color de la linea que separa la cabecera con el resto de la pantalla. Ejemplo: "#01e3fe"

* Argumento 5: Determina el color del texto de la cabecera de las pantallas. Ejemplo: "#7b7b7b"

* Argumento 6: Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#ebebeb"

* Argumento 7: Determina el color del texto descriptivo de cada textfield. Ejemplo: "#7b7b7b"

* Argumento 8: Determina el color del texto de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 9: Determina el color de fondo de los botones de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 10: Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos. Ejemplo: "#000000"

* Argumento 11: Determina el color del texto de cada boton cuando no se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 12: Determina el color del texto de cada botón cuando se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 13: Determina el color del borde de los botones. Ejemplo: "#01e3fe"

* Argumento 14: Determina el color de la fuente de los textos de los terminos y condiciones. Ejemplo: "#000000"

* Argumento 15: (Solo para iOS) Determina el color de los botones activos en los términos y condiciones. Ejemplo: "#01e3fe"

* Argumento 16: (Solo para iOS) Determina el color de los botones inactivos en los términos y condiciones. Ejemplo: "#f0f0f0"

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#000000", "#01e3fe", "#f0f0f0"]);

Cabe destacar que en el caso de Android, Cordova pone los checkbox por defecto de color blanco, por lo que sí queremos que se vean deberemos usar un fondo de pantalla que no sea blanco.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_cordova_colores.png

=== 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

Ejemplo:
cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "closeNickCenterSession", ["hash_app"]);

=== PRECARGA DE DATOS PARA EL REGISTRO: ===

NickCenter está dotada de una serie de funciones que permiten al desarrollador precargar los datos del usuario a la hora de mostrarle la pantalla de registro. Si desea hacer uso de esta precarga deberá pasar más argumentos a la llamada de la librería ( todos estos argumentos son opcionales ) :

* Argumento 17: Nombre. Ejemplo: "kevin".
* Argumento 18: Apellidos. Ejemplo: "lancharro".
* Argumento 19: Email. Deberá ser un email válido, se comprobará tanto el formato de la cadena como la validez de éste. Ejemplo: "user@domain.com".
* Argumento 20: Teléfono. Deberá ser un teléfono sin prefijo internacional. Ejemplo: "666777888".
* Argumento 21: Nick. Ejemplo: "CocoZilla".
* Argumento 22: Género. Deberá ser M para hombres y F para mujeres.
* Argumento 23: Fecha de nacimiento. Deberá ser una fecha en formato inglés separado por /. Ejemplo: "1992/01/12"

A continuación se expone un ejemplo siguiendo la maquetación expuesta en anteriores puntos.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["58c17363e2de6", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#f0f0f0", "kevin", "lancharro", "user@domain.com", "666777888", "CocoZilla", "M", "1992/01/12"]);

[[Archivo:Precarga_datos_cordova.png|center]]

=== CallBacks: ===

NickCenter cuenta con una serie de callbacks los cuales se pueden recoger en en las funciones implementadas successNickCenterCallback y errorNickCenterCallback que permiten al desarrollador saber qué parte del plugin se esta ejecutando y cuál 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: Cadena de 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: Cadena de 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 registrarse 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: Json de Usuario: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario en formato Json.

* onLoginPerformed: Json de Usuario: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario en formato Json.

* 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.

Archivo:Precarga datos cordova.png

2018-11-20T14:42:49Z

Kevin:

SDKs:NickCenter:Cordova:index

2018-11-20T14:42:25Z

Kevin: /* PRECARGA DE DATOS PARA EL REGISTRO: */

= CÓMO AGREGAR EL PLUGIN NICKCENTER EN CORDOVA =

{{:SDKs:NickCenter:Intro}}

== VERSIONES SOPORTADAS ==

Este Plugin soporta tanto Android como iOS.

Para iOS soporta las versiones superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

Para Android soporta todas las versiones superiores a la 4.0

{{:SDKs:NickCenter:PanelControl}}

== PASOS A REALIZAR PARA LA INTALACIÓN DEL PLUGIN ==

=== INSTALACIÓN: ===

Para instalar el Plugin, si queremos que funcione en iOS, primero tendremos que instalar el plugin cordova-plugin-cocoapod-support, de la siguiente manera:
cordova plugin add cordova-plugin-cocoapod-support
y después instalar el plugin de Nickcenter de esta manera (si solo lo vamos a usar para android con este plugin es suficiente):
cordova plugin add cordova-plugin-nickcenter

Una vez ejecutados los dos comandos ya tendremos el plugin instalado.

=== LANZAMIENTO: ===

Una vez configurada la instalación, lanzaremos en el momento donde queramos el código, por ejemplo:

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["54e46801egh95"]);

Los Argumentos enviados serán los siguientes:
* Argumento 1: Es el AppHash de la aplicación, el cual se puede obtener en el panel, como muestra la siguiente pantalla.

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 NickCenter deberá añadir más argumentos, en el siguiente orden (Estos Argumentos son completamente Opcionales) (Todos los colores deben ir en hexadecimal):

* Argumento 2: Determina el color de fondo de las pantallas. Ejemplo: "#ffffff"

* Argumento 3: Determina el color de fondo de la cabecera de las pantallas. Ejemplo: "#f0f0f0"

* Argumento 4: Determina el color de la linea que separa la cabecera con el resto de la pantalla. Ejemplo: "#01e3fe"

* Argumento 5: Determina el color del texto de la cabecera de las pantallas. Ejemplo: "#7b7b7b"

* Argumento 6: Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#ebebeb"

* Argumento 7: Determina el color del texto descriptivo de cada textfield. Ejemplo: "#7b7b7b"

* Argumento 8: Determina el color del texto de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 9: Determina el color de fondo de los botones de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 10: Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos. Ejemplo: "#000000"

* Argumento 11: Determina el color del texto de cada boton cuando no se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 12: Determina el color del texto de cada botón cuando se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 13: Determina el color del borde de los botones. Ejemplo: "#01e3fe"

* Argumento 14: Determina el color de la fuente de los textos de los terminos y condiciones. Ejemplo: "#000000"

* Argumento 15: (Solo para iOS) Determina el color de los botones activos en los términos y condiciones. Ejemplo: "#01e3fe"

* Argumento 16: (Solo para iOS) Determina el color de los botones inactivos en los términos y condiciones. Ejemplo: "#f0f0f0"

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#000000", "#01e3fe", "#f0f0f0"]);

Cabe destacar que en el caso de Android, Cordova pone los checkbox por defecto de color blanco, por lo que sí queremos que se vean deberemos usar un fondo de pantalla que no sea blanco.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_cordova_colores.png

=== 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

Ejemplo:
cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "closeNickCenterSession", ["hash_app"]);

=== PRECARGA DE DATOS PARA EL REGISTRO: ===

NickCenter está dotada de una serie de funciones que permiten al desarrollador precargar los datos del usuario a la hora de mostrarle la pantalla de registro. Si desea hacer uso de esta precarga deberá pasar más argumentos a la llamada de la librería ( todos estos argumentos son opcionales ) :

* Argumento 17: Nombre. Ejemplo: "Kevin".
* Argumento 18: Apellidos. Ejemplo: "Lancharro".
* Argumento 19: Email. Deberá ser un email válido, se comprobará tanto el formato de la cadena como la validez de éste. Ejemplo: "user@domain.com".
* Argumento 20: Teléfono. Deberá ser un teléfono sin prefijo internacional. Ejemplo: "666777888".
* Argumento 21: Nick. Ejemplo: "CocoZilla".
* Argumento 22: Género. Deberá ser M para hombres y F para mujeres.
* Argumento 23: Fecha de nacimiento. Deberá ser una fecha en formato inglés separado por /. Ejemplo: "1992/01/12"

A continuación se expone un ejemplo siguiendo la maquetación expuesta en anteriores puntos.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["58c17363e2de6", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#f0f0f0", "kevin", "lancharro", "user@domain.com", "666777888", "CocoZilla", "M", "1992/01/12"]);

[[Archivo:Precarga_datos_cordova.png|center]]

=== CallBacks: ===

NickCenter cuenta con una serie de callbacks los cuales se pueden recoger en en las funciones implementadas successNickCenterCallback y errorNickCenterCallback que permiten al desarrollador saber qué parte del plugin se esta ejecutando y cuál 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: Cadena de 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: Cadena de 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 registrarse 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: Json de Usuario: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario en formato Json.

* onLoginPerformed: Json de Usuario: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario en formato Json.

* 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:Cordova:index

2018-11-20T14:39:48Z

Kevin:

= CÓMO AGREGAR EL PLUGIN NICKCENTER EN CORDOVA =

{{:SDKs:NickCenter:Intro}}

== VERSIONES SOPORTADAS ==

Este Plugin soporta tanto Android como iOS.

Para iOS soporta las versiones superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

Para Android soporta todas las versiones superiores a la 4.0

{{:SDKs:NickCenter:PanelControl}}

== PASOS A REALIZAR PARA LA INTALACIÓN DEL PLUGIN ==

=== INSTALACIÓN: ===

Para instalar el Plugin, si queremos que funcione en iOS, primero tendremos que instalar el plugin cordova-plugin-cocoapod-support, de la siguiente manera:
cordova plugin add cordova-plugin-cocoapod-support
y después instalar el plugin de Nickcenter de esta manera (si solo lo vamos a usar para android con este plugin es suficiente):
cordova plugin add cordova-plugin-nickcenter

Una vez ejecutados los dos comandos ya tendremos el plugin instalado.

=== LANZAMIENTO: ===

Una vez configurada la instalación, lanzaremos en el momento donde queramos el código, por ejemplo:

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["54e46801egh95"]);

Los Argumentos enviados serán los siguientes:
* Argumento 1: Es el AppHash de la aplicación, el cual se puede obtener en el panel, como muestra la siguiente pantalla.

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 NickCenter deberá añadir más argumentos, en el siguiente orden (Estos Argumentos son completamente Opcionales) (Todos los colores deben ir en hexadecimal):

* Argumento 2: Determina el color de fondo de las pantallas. Ejemplo: "#ffffff"

* Argumento 3: Determina el color de fondo de la cabecera de las pantallas. Ejemplo: "#f0f0f0"

* Argumento 4: Determina el color de la linea que separa la cabecera con el resto de la pantalla. Ejemplo: "#01e3fe"

* Argumento 5: Determina el color del texto de la cabecera de las pantallas. Ejemplo: "#7b7b7b"

* Argumento 6: Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#ebebeb"

* Argumento 7: Determina el color del texto descriptivo de cada textfield. Ejemplo: "#7b7b7b"

* Argumento 8: Determina el color del texto de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 9: Determina el color de fondo de los botones de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 10: Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos. Ejemplo: "#000000"

* Argumento 11: Determina el color del texto de cada boton cuando no se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 12: Determina el color del texto de cada botón cuando se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 13: Determina el color del borde de los botones. Ejemplo: "#01e3fe"

* Argumento 14: Determina el color de la fuente de los textos de los terminos y condiciones. Ejemplo: "#000000"

* Argumento 15: (Solo para iOS) Determina el color de los botones activos en los términos y condiciones. Ejemplo: "#01e3fe"

* Argumento 16: (Solo para iOS) Determina el color de los botones inactivos en los términos y condiciones. Ejemplo: "#f0f0f0"

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#000000", "#01e3fe", "#f0f0f0"]);

Cabe destacar que en el caso de Android, Cordova pone los checkbox por defecto de color blanco, por lo que sí queremos que se vean deberemos usar un fondo de pantalla que no sea blanco.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_cordova_colores.png

=== 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

Ejemplo:
cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "closeNickCenterSession", ["hash_app"]);

=== PRECARGA DE DATOS PARA EL REGISTRO: ===

NickCenter está dotada de una serie de funciones que permiten al desarrollador precargar los datos del usuario a la hora de mostrarle la pantalla de registro. Si desea hacer uso de esta precarga deberá pasar más argumentos a la llamada de la librería ( todos estos argumentos son opcionales ) :

* Argumento 17: Nombre. Ejemplo: "Kevin".
* Argumento 18: Apellidos. Ejemplo: "Lancharro".
* Argumento 19: Email. Deberá ser un email válido, se comprobará tanto el formato de la cadena como la validez de éste. Ejemplo: "user@domain.com".
* Argumento 20: Teléfono. Deberá ser un teléfono sin prefijo internacional. Ejemplo: "666777888".
* Argumento 21: Nick. Ejemplo: "CocoZilla".
* Argumento 22: Género. Deberá ser M para hombres y F para mujeres.
* Argumento 23: Fecha de nacimiento. Deberá ser una fecha en formato inglés separado por /. Ejemplo: "1992/01/12"

A continuación se expone un ejemplo siguiendo la maquetación expuesta en anteriores puntos.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["58c17363e2de6", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#01e3fe", "#f0f0f0", "kevin", "lancharro", "user@domain.com", "666777888", "CocoZilla", "M", "1992/01/12"]);

=== CallBacks: ===

NickCenter cuenta con una serie de callbacks los cuales se pueden recoger en en las funciones implementadas successNickCenterCallback y errorNickCenterCallback que permiten al desarrollador saber qué parte del plugin se esta ejecutando y cuál 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: Cadena de 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: Cadena de 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 registrarse 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: Json de Usuario: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario en formato Json.

* onLoginPerformed: Json de Usuario: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario en formato Json.

* 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:Cordova:index

2018-10-16T12:03:45Z

Kevin:

= CÓMO AGREGAR EL PLUGIN NICKCENTER EN CORDOVA =

{{:SDKs:NickCenter:Intro}}

== VERSIONES SOPORTADAS ==

Este Plugin soporta tanto Android como iOS.

Para iOS soporta las versiones superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

Para Android soporta todas las versiones superiores a la 4.0

{{:SDKs:NickCenter:PanelControl}}

== PASOS A REALIZAR PARA LA INTALACIÓN DEL PLUGIN ==

=== INSTALACIÓN: ===

Para instalar el Plugin, si queremos que funcione en iOS, primero tendremos que instalar el plugin cordova-plugin-cocoapod-support, de la siguiente manera:
cordova plugin add cordova-plugin-cocoapod-support
y después instalar el plugin de Nickcenter de esta manera (si solo lo vamos a usar para android con este plugin es suficiente):
cordova plugin add cordova-plugin-nickcenter

Una vez ejecutados los dos comandos ya tendremos el plugin instalado.

=== LANZAMIENTO: ===

Una vez configurada la instalación, lanzaremos en el momento donde queramos el código, por ejemplo:

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["54e46801egh95"]);

Los Argumentos enviados serán los siguientes:
* Argumento 1: Es el AppHash de la aplicación, el cual se puede obtener en el panel, como muestra la siguiente pantalla.

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 NickCenter deberá añadir más argumentos, en el siguiente orden (Estos Argumentos son completamente Opcionales) (Todos los colores deben ir en hexadecimal):

* Argumento 2: Determina el color de fondo de las pantallas. Ejemplo: "#ffffff"

* Argumento 3: Determina el color de fondo de la cabecera de las pantallas. Ejemplo: "#f0f0f0"

* Argumento 4: Determina el color de la linea que separa la cabecera con el resto de la pantalla. Ejemplo: "#01e3fe"

* Argumento 5: Determina el color del texto de la cabecera de las pantallas. Ejemplo: "#7b7b7b"

* Argumento 6: Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#ebebeb"

* Argumento 7: Determina el color del texto descriptivo de cada textfield. Ejemplo: "#7b7b7b"

* Argumento 8: Determina el color del texto de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 9: Determina el color de fondo de los botones de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 10: Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos. Ejemplo: "#000000"

* Argumento 11: Determina el color del texto de cada boton cuando no se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 12: Determina el color del texto de cada botón cuando se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 13: Determina el color del borde de los botones. Ejemplo: "#01e3fe"

* Argumento 14: Determina el color de la fuente de los textos de los terminos y condiciones. Ejemplo: "#000000"

* Argumento 15: (Solo para iOS) Determina el color de los botones activos en los términos y condiciones. Ejemplo: "#01e3fe"

* Argumento 16: (Solo para iOS) Determina el color de los botones inactivos en los términos y condiciones. Ejemplo: "#f0f0f0"

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#000000", "#01e3fe", "#f0f0f0"]);

Cabe destacar que en el caso de Android, Cordova pone los checkbox por defecto de color blanco, por lo que sí queremos que se vean deberemos usar un fondo de pantalla que no sea blanco.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_cordova_colores.png

=== 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

Ejemplo:
cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "closeNickCenterSession", ["hash_app"]);

=== CallBacks: ===

NickCenter cuenta con una serie de callbacks los cuales se pueden recoger en en las funciones implementadas successNickCenterCallback y errorNickCenterCallback que permiten al desarrollador saber qué parte del plugin se esta ejecutando y cuál 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: Cadena de 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: Cadena de 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 registrarse 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: Json de Usuario: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario en formato Json.

* onLoginPerformed: Json de Usuario: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario en formato Json.

* 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:Cordova:index

2018-10-16T12:03:10Z

Kevin:

= CÓMO AGREGAR EL PLUGIN NICKCENTER EN CORDOVA =

{{:SDKs:NickCenter:Intro}}

== VERSIONES SOPORTADAS ==

Este Plugin soporta tanto Android como iOS.

Para iOS soporta las versiones superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

Para Android soporta todas las versiones superiores a la 4.0

{{:SDKs:NickCenter:PanelControl}}

== PASOS A REALIZAR PARA LA INTALACIÓN DEL PLUGIN ==

=== INSTALACIÓN: ===

Para instalar el Plugin, si queremos que funcione en iOS, primero tendremos que instalar el plugin cordova-plugin-cocoapod-support, de la siguiente manera:
cordova plugin add cordova-plugin-cocoapod-support
y después instalar el plugin de Nickcenter de esta manera (si solo lo vamos a usar para android con este plugin es suficiente):
cordova plugin add cordova-plugin-nickcenter

Una vez ejecutados los dos comandos ya tendremos el plugin instalado.

=== LANZAMIENTO: ===

Una vez configurada la instalación, lanzaremos en el momento donde queramos el código, por ejemplo:

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["54e46801egh95"]);

Los Argumentos enviados serán los siguientes:
* Argumento 1: Es el AppHash de la aplicación, el cual se puede obtener en el panel, como muestra la siguiente pantalla.

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 NickCenter deberá añadir más argumentos, en el siguiente orden (Estos Argumentos son completamente Opcionales) (Todos los colores deben ir en hexadecimal):

* Argumento 2: Determina el color de fondo de las pantallas. Ejemplo: "#ffffff"

* Argumento 3: Determina el color de fondo de la cabecera de las pantallas. Ejemplo: "#f0f0f0"

* Argumento 4: Determina el color de la linea que separa la cabecera con el resto de la pantalla. Ejemplo: "#01e3fe"

* Argumento 5: Determina el color del texto de la cabecera de las pantallas. Ejemplo: "#7b7b7b"

* Argumento 6: Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#ebebeb"

* Argumento 7: Determina el color del texto descriptivo de cada textfield. Ejemplo: "#7b7b7b"

* Argumento 8: Determina el color del texto de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 9: Determina el color de fondo de los botones de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 10: Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos. Ejemplo: "#000000"

* Argumento 11: Determina el color del texto de cada boton cuando no se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 12: Determina el color del texto de cada botón cuando se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 13: Determina el color del borde de los botones. Ejemplo: "#01e3fe"

* Argumento 14: Determina el color de la fuente de los textos de los terminos y condiciones. Ejemplo: "#000000"

* Argumento 15: (Solo para iOS) Determina el color de los botones activos en los términos y condiciones. Ejemplo: "#01e3fe"

* Argumento 16: (Solo para iOS) Determina el color de los botones inactivos en los términos y condiciones. Ejemplo: "#f0f0f0"

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#000000", "#01e3fe", "#f0f0f0"]);

Cabe destacar que en el caso de Android, Cordova pone los checkbox por defecto de color blanco, por lo que sí queremos que se vean deberemos usar un fondo de pantalla que no sea blanco.

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_cordova_colores.png

=== 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

Ejemplo:
cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "closeNickCenterSession", ["hash_app"]);

=== CallBacks: ===

NickCenter cuenta con una serie de callbacks los cuales se pueden recoger en en las funciones implementadas successNickCenterCallback y errorNickCenterCallback que permiten al desarrollador saber qué parte del plugin se esta ejecutando y cuál 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: Cadena de 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: Cadena de 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 registrarse 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: Json de Usuario: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario en formato Json.

* onLoginPerformed: Json de Usuario: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario en formato Json.

* 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:Cordova:index

2018-10-16T11:05:28Z

Kevin:

= CÓMO AGREGAR EL PLUGIN NICKCENTER EN CORDOVA =

{{:SDKs:NickCenter:Intro}}

== VERSIONES SOPORTADAS ==

Este Plugin soporta tanto Android como iOS.

Para iOS soporta las versiones superiores a las 10.0, en caso de que detecte una versión inferior no se lanzará.

Para Android soporta todas las versiones superiores a la 4.0

{{:SDKs:NickCenter:PanelControl}}

== PASOS A REALIZAR PARA LA INTALACIÓN DEL PLUGIN ==

=== INSTALACIÓN: ===

Para instalar el Plugin, si queremos que funcione en iOS, primero tendremos que instalar el plugin cordova-plugin-cocoapod-support, de la siguiente manera:
cordova plugin add cordova-plugin-cocoapod-support
y después instalar el plugin de Nickcenter de esta manera (si solo lo vamos a usar para android con este plugin es suficiente):
cordova plugin add cordova-plugin-nickcenter

Una vez ejecutados los dos comandos ya tendremos el plugin instalado.

=== LANZAMIENTO: ===

Una vez configurada la instalación, lanzaremos en el momento donde queramos el código, por ejemplo:

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["54e46801egh95"]);

Los Argumentos enviados serán los siguientes:
* Argumento 1: Es el AppHash de la aplicación, el cual se puede obtener en el panel, como muestra la siguiente pantalla.

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 NickCenter deberá añadir más argumentos, en el siguiente orden (Estos Argumentos son completamente Opcionales) (Todos los colores deben ir en hexadecimal):

* Argumento 2: Determina el color de fondo de las pantallas. Ejemplo: "#ffffff"

* Argumento 3: Determina el color de fondo de la cabecera de las pantallas. Ejemplo: "#f0f0f0"

* Argumento 4: Determina el color de la linea que separa la cabecera con el resto de la pantalla. Ejemplo: "#01e3fe"

* Argumento 5: Determina el color del texto de la cabecera de las pantallas. Ejemplo: "#7b7b7b"

* Argumento 6: Determina el color de fondo de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#ebebeb"

* Argumento 7: Determina el color del texto descriptivo de cada textfield. Ejemplo: "#7b7b7b"

* Argumento 8: Determina el color del texto de los textfields donde se ubican los campos de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 9: Determina el color de fondo de los botones de cada pantalla. Ejemplo: "#7b7b7b"

* Argumento 10: Determina el color de fondo de los botones de cada pantalla cuando se ha hecho click en éstos. Ejemplo: "#000000"

* Argumento 11: Determina el color del texto de cada boton cuando no se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 12: Determina el color del texto de cada botón cuando se ha hecho click en éstos. Ejemplo: "#01e3fe"

* Argumento 13: Determina el color del borde de los botones. Ejemplo: "#01e3fe"

* Argumento 14: Determina el color de la fuente de los textos de los terminos y condiciones. Ejemplo: "#000000"

* Argumento 15: (Solo para iOS) Determina el color de los botones activos en los términos y condiciones. Ejemplo: "#01e3fe"

* Argumento 16: (Solo para iOS) Determina el color de los botones inactivos en los términos y condiciones. Ejemplo: "#f0f0f0"

A continuación se expone un ejemplo en el que se maqueta a gusto del desarrollador las pantallas de NickCenter.

cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "launchNickCenter", ["hash_app", "#ffffff", "#f0f0f0", "#01e3fe", "#7b7b7b", "#ebebeb", "#7b7b7b", "#7b7b7b", "#7b7b7b", "#000000", "#01e3fe", "#01e3fe", "#01e3fe", "#000000", "#01e3fe", "#f0f0f0"]);

https://panel.mobeleader.com/ficheros_subidos/librerias/imagenes/NickCenter/nc_cordova_colores.png

=== 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

Ejemplo:
cordova.exec(successNickCenterCallback, errorNickCenterCallback, "nickcenter", "closeNickCenterSession", ["hash_app"]);

=== CallBacks: ===

NickCenter cuenta con una serie de callbacks los cuales se pueden recoger en en las funciones implementadas successNickCenterCallback y errorNickCenterCallback que permiten al desarrollador saber qué parte del plugin se esta ejecutando y cuál 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: Cadena de 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: Cadena de 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 registrarse 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: Json de Usuario: Notificará cuando haya habido un registro correcto. Se mandará la información recogida del usuario en formato Json.

* onLoginPerformed: Json de Usuario: Notificará cuando haya habido un login correcto. Se mandará la información recogida del usuario en formato Json.

* 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.

Página principal

2018-09-25T10:40:51Z

Kevin:

* [[Librerias:index|Librerías]]
* [[Panel:Anuncios:Anunciantes|Anuncios para anunciantes]]
* Bases de Datos
** [[BBDDs:AltasYBajas|Webservice Altas y Bajas]]
**[[Guía eMailing y BBDD]]
**[[Email 360 - Amazon SES]]
* [[Panel:Desarrolladores:AppExchange|App Exchange]]
* [[Documentación_Webservice_NickCenter|Documentación Webservice NickCenter - Manual de Usuario]]
* [[docu_push_exchange|Documentación Push Api Exchange - Manual de Usuario]]

Docu push exchange

2018-09-25T10:36:30Z

Kevin: /* 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-xchange de Mobeleader para realizar las distintas acciones que ésta nos permite. Se expondrá brevemente como ha de realizarse la conexión a dicha API, como han de ser los campos obligatorios que han de ir para todos los casos y a continuación se procederá a tratar todos los casos con ejemplos para un mayor entendimiento.

=Conectándonos a la API=
Lo primero que deberemos hacer es solicitar el token necesario para la conexion a Mobeleader. Dicho token es un identificador único para cada usuario desarrollador. Una vez obtenido dicho token procederemos a hacer una breve prueba de conexión para comprobar que tenemos acceso a la API. En dicha prueba haremos uso de la tarea '''“ping”'''.
 
<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 Webservice NickCenter

2018-09-12T10:49:11Z

Kevin: /* Llamada directa */

=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.

=Llamada directa=
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''spsApiNickCenter''', 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.

=Uso de la clase spsApiNickcenter=
Esta clase accesible desde [[Medio:Api_nickcenter_client.zip|aquí]], esta pensada para una mayor comodidad del cliente, permitiendo que todo se gestione desde ésta sin necesidad de tener que programar las llamadas y retornos del Webservice. A continuación se expondrán los pasos a seguir para un correcto funcionamiento de la clase:
==Instalación PHPSECLIB==
 
Será necesario disponer de phpseclib versión 2.0.11 o superior.
Los pasos para instalar esta versión de phpseclib son: 
- Disponer de la herramienta "composer.phar" 
- Ejecutar "composer" en la carpeta donde vaya a instalar nuestra librería. 
 

1.- Descargar composer desde: https://getcomposer.org/composer.phar
<pre>curl https://getcomposer.org/composer.phar -o composer.phar</pre>
 

2.- Ejecutar el comando:
<pre>php composer.phar --working-dir=. require phpseclib/phpseclib:~2.0</pre>
 

Hecho esto, obtendrá la siguiente salida por consola:
<pre>
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
- Installing phpseclib/phpseclib (2.0.11): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating autoload files
</pre>
 

Esto significa que está todo lo necesario instalado en su carpeta vendor.
 

==Clase spsApiNickcenter==
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, y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
$conexionapi = new spsApiNickcenter([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 '''getData()''' de la clase '''spsApiNickcenter'''. 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">
$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getData(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 '''spsApiNickcenter''' 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

2018-09-12T07:50:54Z

Kevin: /* Uso de la clase spsApiNickcenter */

=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.

=Llamada directa=
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''spsApiNickCenter''', esta será la URL a la que deberemos conectarnos ''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.

=Uso de la clase spsApiNickcenter=
Esta clase accesible desde [[Medio:Api_nickcenter_client.zip|aquí]], esta pensada para una mayor comodidad del cliente, permitiendo que todo se gestione desde ésta sin necesidad de tener que programar las llamadas y retornos del Webservice. A continuación se expondrán los pasos a seguir para un correcto funcionamiento de la clase:
==Instalación PHPSECLIB==
 
Será necesario disponer de phpseclib versión 2.0.11 o superior.
Los pasos para instalar esta versión de phpseclib son: 
- Disponer de la herramienta "composer.phar" 
- Ejecutar "composer" en la carpeta donde vaya a instalar nuestra librería. 
 

1.- Descargar composer desde: https://getcomposer.org/composer.phar
<pre>curl https://getcomposer.org/composer.phar -o composer.phar</pre>
 

2.- Ejecutar el comando:
<pre>php composer.phar --working-dir=. require phpseclib/phpseclib:~2.0</pre>
 

Hecho esto, obtendrá la siguiente salida por consola:
<pre>
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
- Installing phpseclib/phpseclib (2.0.11): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating autoload files
</pre>
 

Esto significa que está todo lo necesario instalado en su carpeta vendor.
 

==Clase spsApiNickcenter==
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, y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
$conexionapi = new spsApiNickcenter([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 '''getData()''' de la clase '''spsApiNickcenter'''. 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">
$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getData(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 '''spsApiNickcenter''' 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

2018-09-12T07:50:35Z

Kevin: /* Uso de la clase spsApiNickcenter */

=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.

=Llamada directa=
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''spsApiNickCenter''', esta será la URL a la que deberemos conectarnos ''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.

=Uso de la clase spsApiNickcenter=
Esta clase accesible desde [[Medio:Api_nickcenter_client.zip||aquí]], esta pensada para una mayor comodidad del cliente, permitiendo que todo se gestione desde ésta sin necesidad de tener que programar las llamadas y retornos del Webservice. A continuación se expondrán los pasos a seguir para un correcto funcionamiento de la clase:
==Instalación PHPSECLIB==
 
Será necesario disponer de phpseclib versión 2.0.11 o superior.
Los pasos para instalar esta versión de phpseclib son: 
- Disponer de la herramienta "composer.phar" 
- Ejecutar "composer" en la carpeta donde vaya a instalar nuestra librería. 
 

1.- Descargar composer desde: https://getcomposer.org/composer.phar
<pre>curl https://getcomposer.org/composer.phar -o composer.phar</pre>
 

2.- Ejecutar el comando:
<pre>php composer.phar --working-dir=. require phpseclib/phpseclib:~2.0</pre>
 

Hecho esto, obtendrá la siguiente salida por consola:
<pre>
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
- Installing phpseclib/phpseclib (2.0.11): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating autoload files
</pre>
 

Esto significa que está todo lo necesario instalado en su carpeta vendor.
 

==Clase spsApiNickcenter==
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, y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
$conexionapi = new spsApiNickcenter([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 '''getData()''' de la clase '''spsApiNickcenter'''. 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">
$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getData(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 '''spsApiNickcenter''' 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

2018-09-12T07:50:11Z

Kevin: /* Uso de la clase spsApiNickcenter */

=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.

=Llamada directa=
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''spsApiNickCenter''', esta será la URL a la que deberemos conectarnos ''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.

=Uso de la clase spsApiNickcenter=
Esta clase accesible desde [[Medio:Api_nickcenter_client.zip]], esta pensada para una mayor comodidad del cliente, permitiendo que todo se gestione desde ésta sin necesidad de tener que programar las llamadas y retornos del Webservice. A continuación se expondrán los pasos a seguir para un correcto funcionamiento de la clase:
==Instalación PHPSECLIB==
 
Será necesario disponer de phpseclib versión 2.0.11 o superior.
Los pasos para instalar esta versión de phpseclib son: 
- Disponer de la herramienta "composer.phar" 
- Ejecutar "composer" en la carpeta donde vaya a instalar nuestra librería. 
 

1.- Descargar composer desde: https://getcomposer.org/composer.phar
<pre>curl https://getcomposer.org/composer.phar -o composer.phar</pre>
 

2.- Ejecutar el comando:
<pre>php composer.phar --working-dir=. require phpseclib/phpseclib:~2.0</pre>
 

Hecho esto, obtendrá la siguiente salida por consola:
<pre>
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
- Installing phpseclib/phpseclib (2.0.11): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating autoload files
</pre>
 

Esto significa que está todo lo necesario instalado en su carpeta vendor.
 

==Clase spsApiNickcenter==
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, y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
$conexionapi = new spsApiNickcenter([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 '''getData()''' de la clase '''spsApiNickcenter'''. 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">
$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getData(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 '''spsApiNickcenter''' 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

2018-09-12T07:49:54Z

Kevin: /* Uso de la clase spsApiNickcenter */

=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.

=Llamada directa=
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''spsApiNickCenter''', esta será la URL a la que deberemos conectarnos ''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.

=Uso de la clase spsApiNickcenter=
Esta clase accesible desde [[Archive:Api_nickcenter_client.zip]], esta pensada para una mayor comodidad del cliente, permitiendo que todo se gestione desde ésta sin necesidad de tener que programar las llamadas y retornos del Webservice. A continuación se expondrán los pasos a seguir para un correcto funcionamiento de la clase:
==Instalación PHPSECLIB==
 
Será necesario disponer de phpseclib versión 2.0.11 o superior.
Los pasos para instalar esta versión de phpseclib son: 
- Disponer de la herramienta "composer.phar" 
- Ejecutar "composer" en la carpeta donde vaya a instalar nuestra librería. 
 

1.- Descargar composer desde: https://getcomposer.org/composer.phar
<pre>curl https://getcomposer.org/composer.phar -o composer.phar</pre>
 

2.- Ejecutar el comando:
<pre>php composer.phar --working-dir=. require phpseclib/phpseclib:~2.0</pre>
 

Hecho esto, obtendrá la siguiente salida por consola:
<pre>
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
- Installing phpseclib/phpseclib (2.0.11): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating autoload files
</pre>
 

Esto significa que está todo lo necesario instalado en su carpeta vendor.
 

==Clase spsApiNickcenter==
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, y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
$conexionapi = new spsApiNickcenter([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 '''getData()''' de la clase '''spsApiNickcenter'''. 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">
$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getData(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 '''spsApiNickcenter''' 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

2018-09-12T07:48:36Z

Kevin: /* Uso de la clase spsApiNickcenter */

=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.

=Llamada directa=
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''spsApiNickCenter''', esta será la URL a la que deberemos conectarnos ''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.

=Uso de la clase spsApiNickcenter=
Esta clase accesible desde [[Medio:Api_nickcenter_client.zip]], esta pensada para una mayor comodidad del cliente, permitiendo que todo se gestione desde ésta sin necesidad de tener que programar las llamadas y retornos del Webservice. A continuación se expondrán los pasos a seguir para un correcto funcionamiento de la clase:
==Instalación PHPSECLIB==
 
Será necesario disponer de phpseclib versión 2.0.11 o superior.
Los pasos para instalar esta versión de phpseclib son: 
- Disponer de la herramienta "composer.phar" 
- Ejecutar "composer" en la carpeta donde vaya a instalar nuestra librería. 
 

1.- Descargar composer desde: https://getcomposer.org/composer.phar
<pre>curl https://getcomposer.org/composer.phar -o composer.phar</pre>
 

2.- Ejecutar el comando:
<pre>php composer.phar --working-dir=. require phpseclib/phpseclib:~2.0</pre>
 

Hecho esto, obtendrá la siguiente salida por consola:
<pre>
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
- Installing phpseclib/phpseclib (2.0.11): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating autoload files
</pre>
 

Esto significa que está todo lo necesario instalado en su carpeta vendor.
 

==Clase spsApiNickcenter==
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, y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
$conexionapi = new spsApiNickcenter([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 '''getData()''' de la clase '''spsApiNickcenter'''. 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">
$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getData(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 '''spsApiNickcenter''' 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

Archivo:Api nickcenter client.zip

2018-09-12T07:47:58Z

Kevin:

Página principal

2018-09-11T16:06:25Z

Kevin:

* [[Librerias:index|Librerías]]
* [[Panel:Anuncios:Anunciantes|Anuncios para anunciantes]]
* Bases de Datos
** [[BBDDs:AltasYBajas|Webservice Altas y Bajas]]
**[[Guía eMailing y BBDD]]
**[[Email 360 - Amazon SES]]
* [[Panel:Desarrolladores:AppExchange|App Exchange]]
* [[Documentación_Webservice_NickCenter|Documentación Webservice NickCenter - Manual de Usuario]]

Documentación Webservice NickCenter

2018-09-11T16:05:52Z

Kevin: Página creada con «=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 h...»

=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.

=Llamada directa=
Si queremos usar directamente el Webservice de Nickcenter sin la necesidad de usar la clase '''spsApiNickCenter''', esta será la URL a la que deberemos conectarnos ''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.

=Uso de la clase spsApiNickcenter=
Esta clase accesible desde ---->URL DE DESCARGA<---, esta pensada para una mayor comodidad del cliente, permitiendo que todo se gestione desde ésta sin necesidad de tener que programar las llamadas y retornos del Webservice. A continuación se expondrán los pasos a seguir para un correcto funcionamiento de la clase:
==Instalación PHPSECLIB==
 
Será necesario disponer de phpseclib versión 2.0.11 o superior.
Los pasos para instalar esta versión de phpseclib son: 
- Disponer de la herramienta "composer.phar" 
- Ejecutar "composer" en la carpeta donde vaya a instalar nuestra librería. 
 

1.- Descargar composer desde: https://getcomposer.org/composer.phar
<pre>curl https://getcomposer.org/composer.phar -o composer.phar</pre>
 

2.- Ejecutar el comando:
<pre>php composer.phar --working-dir=. require phpseclib/phpseclib:~2.0</pre>
 

Hecho esto, obtendrá la siguiente salida por consola:
<pre>
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
- Installing phpseclib/phpseclib (2.0.11): Downloading (100%)
phpseclib/phpseclib suggests installing ext-libsodium (SSH2/SFTP can make use of some algorithms provided by the libsodium-php extension.)
phpseclib/phpseclib suggests installing ext-mcrypt (Install the Mcrypt extension in order to speed up a few other cryptographic operations.)
phpseclib/phpseclib suggests installing ext-gmp (Install the GMP (GNU Multiple Precision) extension in order to speed up arbitrary precision integer arithmetic operations.)
Writing lock file
Generating autoload files
</pre>
 

Esto significa que está todo lo necesario instalado en su carpeta vendor.
 

==Clase spsApiNickcenter==
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, y reemplazarla en el siguiente codigo.
 
<source lang="PHP">
$conexionapi = new spsApiNickcenter([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 '''getData()''' de la clase '''spsApiNickcenter'''. 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">
$conexionapi = new spsApiNickcenter([RSA KEY PRIVADA]);
$json_datos_devueltos = $conexionapi->getData(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 '''spsApiNickcenter''' 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

Página principal

2018-09-11T16:04:09Z

Kevin:

* [[Librerias:index|Librerías]]
* [[Panel:Anuncios:Anunciantes|Anuncios para anunciantes]]
* Bases de Datos
** [[BBDDs:AltasYBajas|Webservice Altas y Bajas]]
**[[Guía eMailing y BBDD]]
**[[Email 360 - Amazon SES]]
* [[Panel:Desarrolladores:AppExchange|App Exchange]]
* [[Docu_wbs_nickcenter|Documentación Webservice NickCenter]]

Página principal

2018-09-11T16:03:46Z

Kevin:

* [[Librerias:index|Librerías]]
* [[Panel:Anuncios:Anunciantes|Anuncios para anunciantes]]
* Bases de Datos
** [[BBDDs:AltasYBajas|Webservice Altas y Bajas]]
**[[Guía eMailing y BBDD]]
**[[Email 360 - Amazon SES]]
* [[Panel:Desarrolladores:AppExchange|App Exchange]]
* [[Documentación_Webservice_NickCenter|Documentación Webservice NickCenter]]

Página principal

2018-09-11T16:02:58Z

Kevin:

* [[Librerias:index|Librerías]]
* [[Panel:Anuncios:Anunciantes|Anuncios para anunciantes]]
* Bases de Datos
** [[BBDDs:AltasYBajas|Webservice Altas y Bajas]]
**[[Guía eMailing y BBDD]]
**[[Email 360 - Amazon SES]]
* [[Panel:Desarrolladores:AppExchange|App Exchange]]
* [[Docu_wbs_nickcenter|Documentación Webservice NickCenter]]