Documentación API

Reglas de Validación

Las reglas permiten validar automáticamente los datos extraídos según patrones, rangos y condiciones personalizadas.

GET /api/reglas/{habilidad_id}

Lista todas las reglas de validación de una habilidad.

GET /api/reglas/{habilidad_id}

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reglas/HABILIDAD_ID \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{
  "reglas": [
    {
      "id": "regla-uuid-1",
      "nombre": "Validar NIF",
      "tipo": "formato",
      "configuracion": {"patron": "^[0-9]{8}[A-Z]$"},
      "campo_id": "campo-uuid",
      "activa": true
    }
  ]
}

Lista de reglas con su configuración y estado.

Errores

404Not Found

Habilidad no encontrada.

{"error": "Habilidad no encontrada"}

GET /api/reglas/{habilidad_id}/{regla_id}

Obtiene una regla específica con su configuración completa.

GET /api/reglas/{habilidad_id}/{regla_id}

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reglas/HABILIDAD_ID/REGLA_ID \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{
  "regla": {
    "id": "regla-uuid-1",
    "nombre": "Validar NIF",
    "tipo": "formato",
    "configuracion": {"patron": "^[0-9]{8}[A-Z]$"},
    "campo_id": "campo-uuid",
    "activa": true
  }
}

Detalle completo de la regla.

Errores

404Not Found

Regla no encontrada.

{"error": "Regla no encontrada"}

POST /api/reglas/{habilidad_id}

Crea una nueva regla de validación para una habilidad.

POST /api/reglas/{habilidad_id}

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)

{
  "nombre": "Validar NIF",
  "tipo": "formato",
  "configuracion": {"patron": "^[0-9]{8}[A-Z]$"},
  "campo_id": "campo-uuid"
}
  • nombre: (obligatorio) Nombre de la regla.
  • tipo: (obligatorio) Tipo de regla: formato, rango, obligatorio, personalizado.
  • configuracion: (obligatorio) Configuración específica según el tipo.
  • campo_id: (opcional) ID del campo al que aplica la regla.

Ejemplos

curl -X POST https://api-docmind.devol.es/api/reglas/HABILIDAD_ID \
  -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN" \
  -d '{"nombre": "Validar NIF", "tipo": "formato", "configuracion": {"patron": "^[0-9]{8}[A-Z]$"}}'

Respuesta

{"message": "Regla creada exitosamente", "regla": {"id": "regla-uuid-new", "nombre": "Validar NIF"}}

Regla creada y lista para usarse en validaciones.

Errores

400Bad Request

Datos inválidos.

{"error": "El nombre es obligatorio"}
404Not Found

Habilidad no encontrada.

{"error": "Habilidad no encontrada"}

PUT /api/reglas/{habilidad_id}/{regla_id}

Actualiza una regla de validación existente.

PUT /api/reglas/{habilidad_id}/{regla_id}

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)

{"nombre": "Validar NIF Actualizado", "configuracion": {"patron": "^[A-Z][0-9]{8}$"}}
  • nombre: (opcional) Nuevo nombre.
  • configuracion: (opcional) Nueva configuración.
  • activa: (opcional) Activar/desactivar la regla.

Ejemplos

curl -X PUT https://api-docmind.devol.es/api/reglas/HABILIDAD_ID/REGLA_ID \
  -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN" \
  -d '{"nombre": "Validar NIF v2", "activa": true}'

Respuesta

{"message": "Regla actualizada exitosamente"}

Confirmación de la actualización.

Errores

404Not Found

Regla no encontrada.

{"error": "Regla no encontrada"}

DELETE /api/reglas/{habilidad_id}/{regla_id}

Elimina una regla de validación.

DELETE /api/reglas/{habilidad_id}/{regla_id}

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X DELETE https://api-docmind.devol.es/api/reglas/HABILIDAD_ID/REGLA_ID \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"message": "Regla eliminada exitosamente"}

La regla se elimina permanentemente.

Errores

404Not Found

Regla no encontrada.

{"error": "Regla no encontrada"}

GET /api/reglas/extracciones/{extraction_id}/validaciones

Obtiene los resultados de las validaciones ejecutadas sobre una extracción.

GET /api/reglas/extracciones/{extraction_id}/validaciones

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reglas/extracciones/EXTRACTION_ID/validaciones \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{
  "validaciones": [
    {
      "regla_id": "regla-uuid-1",
      "regla_nombre": "Validar NIF",
      "campo": "nif",
      "resultado": "fallo",
      "mensaje": "El valor '123ABC' no cumple el formato esperado"
    },
    {
      "regla_id": "regla-uuid-2",
      "regla_nombre": "Campo obligatorio",
      "campo": "total",
      "resultado": "ok",
      "mensaje": null
    }
  ],
  "resumen": {"total": 2, "ok": 1, "fallos": 1}
}

Resultados de cada regla aplicada, con resumen de validaciones pasadas y fallidas.

Errores

404Not Found

Extracción no encontrada.

{"error": "Extracción no encontrada"}

© 2025 Devol. Todos los derechos reservados.