REST API · Swagger 文档
你可以用它做什么
- **CMS 和博客:**每篇文章或每张图片发布时自动加上时间戳。
- **设计和照片工具:**每次导出时自动登记。
- **文档流程:**固定合同、报价单或发票的确切版本。
- **代码流水线:**在 CI 中为发布产物生成数字指纹。
- **交易平台:**为卖家的每次上传提供作者身份证明。
获取密钥
- 打开 https://run.secureauthor.com,用 Google 账号登录。
- 打开 API 密钥 部分,点击生成 API 密钥。
- 复制密钥,作为查询参数
api-key传入。
完整参考:Swagger 文档。
创建凭证
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data,字段 media = 文件。
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
响应(节选):
{
"code": 0,
"message": "Receipt created successfully",
"receipt": {
"id": "cm8ixlzwf0002pj42vqmvev62",
"hash": "26be856c7aa5748040bcf998b18d3081cacb2ab1e4e3b34aece9e86152f083aa",
"timeStamp": "2025-03-21T15:25:13.599Z",
"blockchainLink": null,
"fileName": "artwork",
"fileMimeType": "png",
"fileSize": 26106,
"nextEntryWritten": "2025-03-22T00:00:00.000Z"
}
}
code: 0——已创建新凭证。code: 1——该文件之前已登记过;返回原来的凭证。- 在下一次上链之前,
blockchainLink为null,之后会包含 Polygonscan 链接。 nextEntryWritten——预计写入区块链的时间。
验证文件
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— 字段 media = 要核对的文件,可选字段 pdf = 证书。
传入 PDF 证书或凭证 ID 二者之一即可。
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY&hash-id=cm8j56xxh0007pj42mj8eg7rl" \
-F "media=@artwork.png"
{
"code": 0,
"fileHash": "a535b2b5…d0",
"receiptHash": "a535b2b5…d0",
"receiptId": "cm8j56xxh0007pj42mj8eg7rl",
"isEqual": true
}
isEqual: true(code 0)——文件与凭证一致;false(code 1)——不一致。
错误
| 响应 | 含义 |
|---|---|
{"code": 3, "error": "API key is missing"} | 在 URL 中加上 ?api-key= |
{"code": 3, "error": "Invalid API key"} | 在网页应用中重新生成密钥 |
| HTTP 400 | media 字段中没有文件,或请求格式错误 |