SonarQube справки API
Тази статия описва как да достъпвате програмно справките за сигурност на SonarQube, съхранявани в платформата Procurize. Тя обхваща REST API за изброяване и извличане на справки и изтегляне на архиви със справки.
Преглед
Подмодулът SonarQube Reports позволява на организации да съхраняват и управляват централизирано справки за сигурност и качеството на кода, генерирани от SonarQube. Платформата Procurize излага тези данни чрез:
- REST API за извличане на метаданни за съхранени справки
- Крайна точка за изтегляне на артефакти от справки като ZIP архиви
Тези възможности позволяват интеграции с CI/CD конвейери, GRC системи, вътрешни табла и инструменти за управление на риска от трети страни.
Автентикация и оторизация
Всички API заявки, описани в тази статия, не изискват автентикация.
ID на организацията
ID на организацията е задължителен за всички заявки, описани тук.
Можете да го намерите в панела за настройки на организацията на https://dashboard.procurize.ai.
Имайте предвид, че достъпът до панела за настройки изисква оторизация, а достъпът до панела за настройки на организацията изисква роля потребител поне „Администратор“ в съответната организация.
Базов URL
Всички REST API крайни точки се обслужват под следния базов URL:
https://api.procurize.com
REST API за справки на SonarQube
Списък със справки
Връща странициран списък със справки за сигурност на SonarQube, съхранявани в платформата.
Крайна точка
GET /security/report/list
Параметри на заявката
org(required): ID на организацията.version(optional): Точната версия на продуктите във формат Semantic Versioning.minver(optional): Минималната версия на продуктите във формат Semantic Versioning.maxver(optional): Максималната версия на продуктите във формат Semantic Versioning.
Имайте предвид, че поне един от параметрите version, minver или maxver е задължителен за заявката.
Примерна заявка
curl "https://api.procurize.com/security/report/list?org=00000000-0000-0000-0000-000000000001&version=1.0"
Примерен отговор
{
"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"
}
]
}
Изтегляне на архив със справка
Изтегля ZIP архив, съдържащ пълните артефакти на справката SonarQube. Архивът включва HTML и PDF справки.
Крайна точка
GET /security/report/files
org(required): ID на организацията.reports(required): Масив от ID‑та на справките.
Примерна заявка
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"
Отговор
- Content-Type:
application/zip - Тялото на отговора съдържа двоичния ZIP файл
Клиентите трябва да стриймват отговора и да го запишат на диска.
Обработване на грешки
API‑то използва стандартните HTTP кодове за статус.
200 OK: Заявката е успешна204 No Content: Справката не съществува400 Bad Request: Невалидни параметри или неправилно формулирана заявка500 Internal Server Error: Неочаквана грешка на сървъра
Отговорите за грешки включват машинно четим код за грешка и човешко четимо съобщение.
Вижте също:
Свързани статии
Какво представляват справките за сигурност?