El servicio tiene como finalidad permitir un entorno unificado de acceso a los Usuarios y Comensales registrados en el servicio de cuentas National Soft®.
El servicio de cuentas consta de dos modalidades de inicio de sesión que a continuación se describen:
api/User/Loggin, recibe las credenciales proporcionadas por la aplicación integradora e inicia una sesión para el usuario. La aplicación integradora, es la encargada del direccionamiento.
Diagrama representando el flujo de comunicación entre la aplicación integradora y el servicio de cuentas.
Como se puede observar en el diagrama anterior el servicio de cuentas válida las credenciales y permite o denega el acceso del usuario a la aplicación integradora. Después del inicio de sesión, el servicio de cuentas devuelve información de la sesión del usuario, posteriormente debe consumirse el sevicio api/User/Logged para obtener la información del usuario que inicio sesión.
Ademas de los métodos de inicio de sesión de la API también existen métodos para obtener información de las compañias correspondiente a los usuarios e información de los comensales.
Usuario: Este termino se refiere a la cuenta del restaurantero o comercio.
Compañia: Son las diferentes sucursales que tiene registrado el restaurantero en el servicio de cuentas.
Comensal: Se refiere a los consumidores registrados.
Como parte del proceso de integración se proporcionarán a la aplicación integradora:
Llave de aplicación:Las llaves de acceso proporcionados son para el consumo de los servicios DEMO y PRODUCTIVO del Ecosistema National Soft®. Dicha llave deberá ser enviada al consumir los servicios bajo el encabezado AuthorizedApp.
Enlaces de acceso personalizado:
Enlace de inicio de sesión: Permite a los usuarios iniciar sesión con su cuenta National Soft®.
Llave de cifrado: Las llaves de cifrado serán proporcionados para la encriptación de solicitudes y desencriptación de respuestas de los servicios que lo requieran.
Asimismo, será indispensable que el integrador proporcione los siguientes enlaces a emplear como parte de la integración.
Enlace de acceso a la aplicación integradora (EA): Enlace de la aplicación integradora al que será redirigido el usuario cuando inicie sesión mediante el Servicio de cuentas.
Enlace de creación de empresa de la aplicación integradora (ECE): Enlace de la aplicación integradora al que redireccionará al momento de crear nuevas empresas visibles al Ecosistema National Soft®. El enlace podría hacer referencia a un asistente para la personalización de la empresa creada, según las necesidades de la aplicación integradora.
Enlace para edición de empresa del integrador (EEC): Enlace de la aplicación integradora al que redireccionará el servicio de cuentas para la edición de empresas.