將資料匯出至 CSV、JSON 或 SARIF

本節介紹如何將掃描結果匯出為 CSV、JSON 或 SARIF。

預設情況下，ASoC API 以 JSON 格式回傳資料，對於程式自動化調用非常有用。如果要明確請求 JSON 格式，請發送下列標頭：
Accept: application/json
如果您需要 CSV 格式的資料（用於試算表），請傳送以下內容以請求 CSV 檔案：
Accept: text/csv
注意：ASoCAPI 支援 OData V4 ($filter, $select) 進行過濾和選擇要回傳的欄位；此功能適用於 JSON 和 CSV 的回應。

關於 SARIF 格式：UI 提供了一個「匯出」對話框，可以產生 SAST 問題的 SARIF 檔案（請參閱產品內的「匯出」對話框）。如果需要透過 API 以程式自動化方式產生 SARIF，會由 Reports API（此為與 OData/匯出端點不同的端點）來產生 SARIF 輸出結果。有關 API 範例與參數，請參閱將資料匯出至 SARIF。

使用 API

若要使用 API，您必須具有有效的存取記號，且若要取得存取記號，您需要與帳戶相關聯的 API 金鑰。請參閱產生 API 金鑰，以取得詳細資料。

Swagger

若要取得 CSV 格式的資料，請在按一下「執行」按鈕之前，將預設的「回應內容類型」從「application/json」變更為「text/csv」。

如需詳細資料，請參閱 Swagger 文件。

curl

以下是 curl 指令的範例，它會傳回您可以從帳戶存取的所有應用程式的所有內容（將 <access token> 取代為有效的存取記號）：
curl -X GET --header 'Accept: text/csv' --header 'Authorization: Bearer <access token>'
                    'https://cloud.appscan.com/api/v4/Apps'
由於 API 支援 OData，因此您可以利用 $filter 和 $select 要求參數來取得部分資料。在下列範例中，只會擷取具有高風險評級的應用程式，且每一個應用程式會包含 3 個內容：ID、名稱及風險評級：
curl -X GET --header 'Accept: text/csv' --header 'Authorization: Bearer <access token>'
                    'https://cloud.appscan.com/api/v4/Apps?
                    $filter=RiskRating%20eq%20'\''High'\''&$select=Id%2CName%2CRiskRating'

另請參閱：

CSV 格式