导出 Copyleaks API 扫描工件

Exporting Copyleaks API scan artifacts

我使用提交文件方法在 Copyleaks API platform 上创建了一个新扫描。使用此代码:

curl -XPUT -H 'Authorization: Bearer XXX' -H "Content-type: application/json" -d '{
  "base64": "SGVsbG8gd29ybGQh",
  "filename": "file.txt",
  "properties": {
    "webhooks": {
      "status": "https://yoursite.com/webhook/{STATUS}/my-custom-id"
    }
  }
}' 'https://api.copyleaks.com/v3/businesses/submit/file/my-custom-id'

我得到了表示扫描已成功完成的完成 webhook。

如何下载工件:

  1. 我的文档的抓取版本
  2. PDF 报告
  3. 结果

并将其存储在我的服务器上?

基于此说明页面 - Export documentation

这种方法的想法是允许 Copyleaks 服务器将所有扫描工件推送到客户服务器中。这就像一个 PUSH 消息,其中 Copyleaks 服务器是对话发起者。

如果您正在使用云存储(如 Google Bucket、Azure 存储或其他),您可以要求 Copyleaks Export 方法直接写入它们 - 使用 Signed URL.

原始调用示例:

POST https://api.copyleaks.com/v3/downloads/scan-id/export/export-id

Authorization: Bearer XXX;

{
    "results": [
        {
            "id": "my-result-id",
            "verb": "POST",
            "headers": [
                ["header-key", "header-value"]
            ],
            "endpoint": "https://yourserver.com/export/export-id/results/my-result-id"
        }
    ],
    "pdfReport": {
        "verb": "POST",
        "headers": [
            ["header-key", "header-value"]
        ],
        "endpoint": "https://yourserver.com/export/export-id/pdf-report"
    },
    "crawledVersion": {
        "verb": "POST",
        "headers": [
            ["header-key", "header-value"]
        ],
        "endpoint": "https://yourserver.com/export/export-id/crawled-version"
    },
    "completionWebhook": "https://yourserver.com/export/export-id/completed",
    "maxRetries": 3
}