REST API · tài liệu Swagger
Bạn có thể xây dựng gì
- CMS và blog: gắn dấu thời gian cho mọi bài viết hoặc hình ảnh khi xuất bản.
- Công cụ thiết kế và ảnh: tự động đăng ký mỗi lần xuất tệp.
- Quy trình tài liệu: cố định đúng phiên bản của hợp đồng, bản chào giá hoặc hóa đơn.
- Pipeline mã nguồn: tạo dấu vân tay cho các artifact phát hành trong CI.
- Chợ trực tuyến: cấp cho người bán bằng chứng quyền tác giả cho mỗi lần tải lên.
Nhận khóa
- Mở https://run.secureauthor.com và đăng nhập bằng Google.
- Mở mục Khóa API và nhấn nút tạo khóa API.
- Sao chép khóa. Truyền nó qua tham số truy vấn
api-key.
Tài liệu đầy đủ: Tài liệu API trên Swagger.
Tạo biên nhận
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, trường media = tệp.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Phản hồi (rút gọn):
{
"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— đã tạo biên nhận mới.code: 1— tệp này đã được đăng ký trước đó; biên nhận ban đầu được trả về.blockchainLinklànullcho đến lượt ghi tiếp theo, sau đó chứa liên kết Polygonscan.nextEntryWritten— thời điểm dự kiến bản ghi xuất hiện trên blockchain.
Kiểm tra tệp
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— trường media = tệp cần kiểm tra, trường tùy chọn pdf = chứng nhận.
Truyền chứng nhận PDF hoặc ID biên nhận.
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) — tệp khớp với biên nhận; false (code 1) — không khớp.
Lỗi
| Phản hồi | Ý nghĩa |
|---|---|
{"code": 3, "error": "API key is missing"} | Thêm ?api-key= vào URL |
{"code": 3, "error": "Invalid API key"} | Tạo lại khóa trong ứng dụng web |
| HTTP 400 | Không có tệp trong trường media hoặc yêu cầu sai định dạng |