API de Integración
La API de integración con SUDOCU provee una serie de herramientas que permiten acceder a información esencial del sistema, para que desde otros sistemas se puedan listar expedientes o crear documentos e incorporarlos en tramites que luego podrán ser tramitados en SUDOCU.
1. Acceso:
A la API se accede por Auth Basic, y el usuario se configura en el archivo de configuración del Api-Server en la dimensión auth->providers->basic, y el password en el apartado secrets.
...
"auth": {
"providers": {
"basic": {
"user": "",
"challenge": true,
"realm": ""
},
...
2. Endpoints
Para información más detallada acceder a la siguiente url https://{url_sudocu}/api/swagger/.
GET
/api/v1/integration/
documentos
Devuelve el listado de documentos de un usuario
Parámetros opcionales:
- id_documento: uuid (query) - ID del documento
- id_area: uuid (query) - ID del área
- id_tipo: number (query) - Tipo de documento
- id_usuario: uuid (query) - ID del usuario (idp o SUDOCU)
- id_estado: number (query) - Estado del documento
- vista: string (query) - Vista
- titulo: string (query) - Título del documento
- nro: string (query) - Número del documento
- nro_asignado: string (query) - Número asignado
- page: number (query) - Número de página
- limit: number (query) - Límite de resultados
/api/v1/integration/
areas
Devuelve el listado de todas las áreas de SUDOCU
Parámetros opcionales:
- page: number (query) - Número de página
- limit: number (query) - Límite de resultados
- id_usuario: uuid (query) - ID del usuario (idp o SUDOCU)
- nombre: string (query) - Nombre del área
- sigla: string (query) - Sigla del área
/api/v1/integration/
personas
Devuelve el listado de personas de SUDOCU
Parámetros opcionales:
- page: number (query) - Número de página
- limit: number (query) - Límite de resultados
- id: uuid (query) - ID del usuario (idp o SUDOCU)
- nombre: string (query) - Nombre de la persona
- apellido: string (query) - Apellido de la persona
- dni: string (query) - DNI de la persona
/api/v1/integration/
tipos_documento
Devuelve el listado de los tipos de documento de SUDOCU
Parámetros opcionales:
- page: number (query) - Número de página
- limit: number (query) - Límite de resultados
- id: uuid (query) - ID del tipo de documento
- esencia: string (query) - 'documento', 'tramite' o 'contenedor'
- visibilidad: string (query) - 'publico', 'privado' o 'reservado'
- nombre_tipo: string (query) - Nombre del tipo de documento
- id_usuario: uuid (query) - ID del usuario
/api/v1/integration/
get_pdf_file
Retorna el archivo PDF
Parámetro:
- id_documento: uuid (query, *requerido) - ID del documento que contiene el PDF
/api/integracion/
expedientes
Devuelve listado de expedientes correspondientes a un usuario
Parámetros:
- id_usuario: uuid (query, *requerido) - ID del usuario
- id_documento: uuid (query) - ID del documento
- id_area: uuid (query) - Si no se especifica, buscará en las áreas del usuario
- id_tipo_documento: number (query) - ID del tipo de documento
- id_estado: number (query) - ID del estado de documento
- page: number (query) - Número de página
- limit: number (query) - Límite de resultados
/api/integracion/
expediente
Devuelve información detallada de un expediente
Parámetros:
- id_documento: uuid (query, *requerido) - ID del documento
- relaciones: boolean (query) - Mostrar relaciones (por defecto es true)
- page: number (query) - Número de página
- limit: number (query) - Límite de resultados
POST
/api/v1/integration/documento
Crea un documento en SUDOCU
Request body:
{
"id_usuario": "uuid",
"id_area_creacion": "uuid",
"id_tipo": "number",
"titulo": "string",
"estado": {},
"fecha": "string",
"atributos": {},
"palabras_clave": ["string"],
"visibilidad": "string",
"validez": {},
"guardar_en_area": true,
"relaciones_personas": [
{
"id_persona": "string",
"id_rol": 0
}
]
}
/api/v1/integration/arai/documento
Crea un documento en SUDOCU
Request body:
{
"id_expediente": "uuid",
"id_usuario_idp": "string",
"documento": {
"id_documento": "uuid",
"id_tipo_uunn": "uuid",
"titulo": "string",
"fecha_cierre": "date",
"atributos": {
"contenido": "string",
"usa_fojas": true,
"id_area_creacion": "uuid"
},
"palabras_clave": {},
"visibilidad": "string",
"nro": {
"nro": "number",
"año": "number",
"nro_visible": "string",
"tipo_visible": "string",
"area": "string",
"usuario": "string",
"mes": "number",
"dia": "number",
"id_sistema_origen": "uuid"
},
"autorizacion": [
{
"usuario": "string",
"nivel": "string",
"creacion": "string"
}
]
}
}
/api/v1/integration/incorporacion
Incorpora un documento en un contenedor
Request body:
{
"id_usuario": "uuid",
"id_area": "uuid",
"id_documento": "uuid",
"id_contenedor": "uuid"
}
/api/v1/integration/attach
Adjunta un archivo a un documento
Parámetros:
- id_usuario: uuid (query, *requerido) - ID del usuario
- id_documento: uuid (query, *requerido) - ID del documento donde se adjunta el archivo
- archivo_adjunto: file (multipart/form-data) - Tipo 'File'
- multipart/form-data: boolean (query) - Define si el archivo es principal o no
/api/v1/integration/seguimiento
Genera seguimiento/notificación a un documento
Request body:
{
"tipo": "enum: seguimiento,nota,recordatorio,notificacion,revision",
"subject": "string",
"nota": "string",
"id_usuario_alta": "uuid",
"id_documento": "uuid",
"destinatarios": [
{
"id": "uuid"
}
],
"situacion": "string"
}
/api/v1/integration/enviar
Envía un documento a un usuario
Request body:
{
"id_usuario": "uuid",
"id_documento": "uuid",
"id_area_origen": "uuid",
"id_usuario_destino": "uuid"
}
/api/v1/integration/regenerar_pdf
Regenerar un PDF
Request body:
{
"id_documento": "uuid",
"id_usuario": "uuid"
}
/api/v1/integration/arai/
notification
Endpoint reservado para la recepción de notificaciones de Arai Documentos
Request body:
{}
/api/v1/integration/arai/persona
Crea una persona en SUDOCU
Request body:
{
"tipo": "enum: fisica,juridica",
"nombre": "string",
"apellido": "string",
"tipo_doc": "enum: DNI,CUIT,CUIL,LE",
"nro_doc": "number",
"pais": "enum: AR"
}