Instructivo para configurar el complemento de inicio de sesión alternativo de Teachlr Organizaciones

El complemento de Inicio de sesión alternativo tiene un interruptor en la esquina superior derecha que le permite activar o desactivar esta funcionalidad.

Para poder activar el complemento primero se deben llenar y guardar todos los campos del formulario.

Al activar este complemento, los usuarios podrán iniciar sesión validando sus credenciales contra un servicio Web externo, lo cual determinará si pueden ingresar a la plataforma o no.

En este complemento se definen todos los datos necesarios para realizar esta validación, como lo son: la ruta hacia el servicio Web externo (endpoint), los nombres de los parámetros a enviar a este servicio Web y las etiquetas a mostrar en el formulario de inicio de sesión alternativo. Los campos a llenar de este complemento son:

Ruta: indica la ruta (endpoint) hacia la cual enviar las credenciales que se definirán en este complemento para el inicio de sesión.

Campo identificador:

  • Parámetro: indica el nombre del parámetro a enviar al servicio Web externo que corresponde al identificador del usuario.
  • Etiqueta en español: indica el texto en español que se mostrará en el formulario de inicio de sesión para solicitar el identificador del usuario cuando la plataforma se muestre en español.
  • Etiqueta en inglés: indica el texto en inglés que se mostrará en el formulario de inicio de sesión para solicitar el identificador del usuario cuando la plataforma se muestre en inglés.

Campo clave secreta:

  • Parámetro: indica el nombre del parámetro a enviar al servicio Web externo que corresponde a la clave secreta del usuario.
  • Etiqueta en español: indica el texto en español que se mostrará en el formulario de inicio de sesión para solicitar la clave secreta del usuario cuando la plataforma se muestre en español.
  • Etiqueta en inglés: indica el texto en inglés que se mostrará en el formulario de inicio de sesión para solicitar la clave secreta del usuario cuando la plataforma se muestre en inglés.

La validación del usuario se logra realizando una petición hacia la ruta definida en este complemento y enviando en dicha petición un par de valores que denominaremos [identificador y clave] como por ejemplo: [correo y contraseña] o [teléfono y PIN].

El servicio Web verifica las credenciales enviadas, devuelve una respuesta y, dependiendo de la respuesta, se le permite o se le impide al usuario el acceso a la plataforma.

Las respuestas se consideran exitosas o fallidas basándose principalmente en los códigos de estado HTTP.

Se considera una respuesta exitosa cuando se recibe un código de estado HTTP 2xx: «Peticiones correctas» y cumple con las siguientes características:

Nota: Si se recibe un código de estado HTTP 2xx pero el formato de respuesta no se cumple, se considerará fallida la respuesta.

También se considerará una respuesta fallida cuando no se recibe un código de estado HTTP 2xx, como por ejemplo, un código 4xx: «Errores del cliente»:

Para los casos de respuesta fallida se le mostrará al usuario el mensaje recibido por el servicio Web externo en el parámetro «message», si lo hubiera.

Se admite recibir también en la respuesta un parámetro «lang» que la aplicación podrá leer para mostrar el mensaje de error en el idioma en el que se está visualizando la aplicación en ese momento.

Para especificar cada lenguaje se utiliza la nomenclatura estandarizada ISO 639-1 de dos letras. A continuación se muestra el objeto completo de respuesta fallida que admite la aplicación.

Cabe destacar que el parámetro «message» es obligatorio, pero el parámetro «lang» es opcional. Si no se envía el parámetro «lang», la aplicación entonces mostrará el mensaje especificado en el parámetro «message».

Si el parámetro «message» no se envía o el objeto de respuesta no es un objeto JSON válido, la aplicación mostrará entonces (en el idioma actual de la aplicación) un mensaje por defecto, que en español sería:

«Tus credenciales no pudieron ser verificadas. Por favor, contacta al administrador.»