API de Informes de SonarQube#

Este artículo describe cómo acceder programáticamente a los informes de seguridad de SonarQube almacenados en la plataforma Procurize. Cubre la API REST para listar y recuperar informes, así como la descarga de archivos de informe.

Visión general#

El submódulo de Informes de SonarQube permite a las organizaciones almacenar y gestionar de forma centralizada los informes de seguridad y calidad de código generados por SonarQube. La plataforma Procurize expone estos datos a través de:

  • Una API REST para recuperar metadatos de los informes almacenados
  • Un punto de acceso para descargar los artefactos de los informes como archivos ZIP

Estas capacidades permiten integraciones con pipelines CI/CD, sistemas GRC, paneles internos y herramientas de gestión de riesgos de terceros.

Autenticación y autorización#

Todas las solicitudes API descritas en este artículo no requieren autenticación.

ID de organización#

Se requiere un ID de organización para todas las solicitudes descritas aquí.
Puedes encontrarlo en el panel de configuración de la organización en https://dashboard.procurize.ai.
Ten en cuenta que el acceso al panel de configuración requiere autorización, y acceder al panel de configuración de la organización necesita un rol de usuario de al menos Administrador en esa organización.

Botón Copiar ID

URL base#

Todos los puntos de acceso de la API REST se sirven bajo la siguiente URL base:

https://api.procurize.com

API REST de Informes de SonarQube#

Listar informes#

Recupera una lista paginada de informes de seguridad de SonarQube almacenados en la plataforma.

Punto de acceso

GET /security/report/list

Parámetros de consulta

  • org (obligatorio): ID de la organización.
  • version (opcional): La versión exacta de los productos en formato Semantic Versioning.
  • minver (opcional): La versión mínima de los productos en formato Semantic Versioning.
  • maxver (opcional): La versión máxima de los productos en formato Semantic Versioning.

Ten en cuenta que al menos uno de los parámetros version, minver o maxver es obligatorio para la solicitud.

Ejemplo de solicitud

curl "https://api.procurize.com/security/report/list?org=00000000-0000-0000-0000-000000000001&version=1.0"

Ejemplo de respuesta

{
  "organizationId": "00000000-0000-0000-0000-000000000001",
  "reports": [
    {
      "projectName": "Test product",
      "id": "00000000-0000-0000-0000-000000000002",
      "reportType": "CWE Top 25",
      "reportVersion": 2024,
      "projectVersion": "1.0",
      "date": "2025-12-17T09:05:48.5946432+00:00",
      "uploadDate": "2025-12-17T09:05:48.5946432+00:00",
      "vulnerabilitiesCount": 0,
      "securityRating": "A"
    }
  ]
}

Descargar archivo de informe#

Descarga un archivo ZIP que contiene los artefactos completos del informe de SonarQube. El archivo incluye informes en HTML y PDF.

Punto de acceso

GET /security/report/files
  • org (obligatorio): ID de la organización.
  • reports (obligatorio): Array de IDs de informes.

Ejemplo de solicitud

curl "https://api.procurize.com/security/report/files?org=00000000-0000-0000-0000-000000000001&reports=00000000-0000-0000-0000-000000000002&reports=00000000-0000-0000-0000-000000000003"

Respuesta

  • Content-Type: application/zip
  • El cuerpo de la respuesta contiene el archivo ZIP binario

Los clientes deben transmitir (stream) la respuesta y guardarla en disco.

Manejo de errores#

La API usa códigos de estado HTTP estándar.

  • 200 OK: Solicitud exitosa
  • 204 No Content: El informe no existe
  • 400 Bad Request: Parámetros inválidos o solicitud malformada
  • 500 Internal Server Error: Error inesperado del servidor

Las respuestas de error incluyen un código de error legible por máquina y un mensaje legible por humanos.

Véase también:#

Artículos relacionados#

¿Qué son los Informes de Seguridad?

Repositorio de informes de seguridad

Cómo configurar los Informes de Seguridad

Arriba
Seleccionar idioma