Integración con Sistema de Usuarios

Usuarios

Resumen

Como se mencionó en casi todas las funcionalidades provistas por Araí-Documentos se requiere integracion con un sistema que provea los Usuarios requeridos por el sistema para interactuar con otras aplicaciones como con Sudocu.

Integrarse con un sistema de usuarios permite:

• Conocer el usuario que genera un documento
• Obtener listados de los usuarios que pueden autorizar documentos
• Conocer atributos de los usuarios que al sistema que genera el documento podría no considerar
• Conocer usuarios que realizan acciones entre el Araí-Documentos y el Sistema de Expedientes

Requisitos

• Instalación de Sistema de Usuarios que provea endpoints para obtener listado de usuarios y obtener atributos de los usuarios
• Proporcionar/Implementar interface dentro de Araí-Documentos para que consuma esos Servicios
• Instalación de Arai-Personas vínculado con Sistema de Usuarios que provea endpoints para obtener listado de personas con sus atributos

Limitaciones

Se provee implementación para Araí-Usuarios, en caso de utilizar otro proveedor de Usuarios se debe implementar UserProviderInterface (directorio-documentos/src/SIU/DocsApi/Security/UserProviderInterface.php)

Se provee implementación para Araí-Personas, en caso de utilizar otro proveedor de Personas se debe implementar PersonasProviderInterface (directorio-documentos/src/SIU/DocsApi/Personas/PersonasProviderInterface.php)

Las imagenes de los contenedores provistas para Araí-Documentos solamente contienen la implementación para Araí-Usuarios / Araí-Personas en caso de realizar una implementación propia debe montar la/s clase/s y realizar actualizar la configuración de las variables requeridas

Implementación

Casos
La aplicación que genera un documento debe interactuar con el Sistema de Usuarios (comunmente Araí-Usuarios) para conocer el identificador del usuario que ingresa al sistema. Este identificador se utiliza al momento de crear un documento para identificar el usuario de creación.
Para enviar un documento a autorizar es necesario que un sistema de usuarios provea un servicio que pueda obtener un listado de usuarios mediante un filtro de búsqueda (string).

A continuación se describen los servicios implementados por Araí-Usuarios. En caso de implementar otro sistema de Usuarios se deberían proveer servicios similares a los mencionados

WHOAMI

(Pendiente link a Araí-Usuarios)

GET - Listado de Usuarios

REQUEST

• Campos obligatorios (Query Param)

Nombre	Tipo	Descripcion
filtro	string	Filtro para realizar busquedas en Araí-Usuarios, se busca por una serie de atributos del usuario como email, nombre, apellido e identificador

• Campos opcionales (Query Param)

Nombre	Tipo	Descripcion
solo_firmantes	string	Recupera usuarios que sean firmantes únicamente (acepta cualquier valor), requiere instalación de Arai-Personas vínculada.

RESPONSE

{
  "listado": [
    {
      "username": "string",
      "identifier": "string",
      "email": "string",
    }
  ]
}

Nombre	Tipo	Descripcion
username	string	Nombre completo del Usuario
identifier	string	Identificador unico del usuario en el sistema
email	string	Cuenta de email del usuario

GET Atributos de un Usuario por Identificador

REQUEST

Campos obligatorios (URI Param)

Nombre	Tipo	Descripcion
identifier	string	Identificador unico del usuario en el sistema

RESPONSE

{
  "listado": [
    {
      "username": "string",
      "identifier": "string",
      "cuit": "string",
      "name": "string",
      "lastname": "string",
      "email": "string",
    }
  ]
}

Nombre	Tipo	Descripcion
username	string	Campo que define el nombre del usuario
identifier	string	Identificador unico del usuario en el sistema
cuit	string	Solo requerido para integración con FirmAR
name	string	Nombre del Usuario
lastname	string	Apellido del usuario
email	string	Cuenta de email del usuario

Configuración

Ver ejemplo de configuración de variables de entorno