REST API · dokumentasi Swagger
Apa yang boleh anda bina
- CMS dan blog: cap masa setiap artikel atau imej semasa diterbitkan.
- Alat reka bentuk dan foto: daftarkan setiap eksport secara automatik.
- Aliran kerja dokumen: tetapkan versi tepat kontrak, tawaran atau invois.
- Saluran paip kod: jana cap jari artifak keluaran dalam CI.
- Pasaran dalam talian: berikan penjual bukti kepengarangan untuk setiap muat naik.
Dapatkan kunci
- Buka https://run.secureauthor.com dan log masuk dengan Google.
- Buka bahagian Kunci API dan tekan butang untuk menjana kunci API.
- Salin kunci itu. Hantarkannya sebagai parameter pertanyaan
api-key.
Rujukan penuh: Dokumentasi API Swagger.
Cipta resit
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, medan media = fail.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Respons (dipendekkan):
{
"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— resit baharu telah dicipta.code: 1— fail ini telah didaftarkan sebelum ini; resit asal dipulangkan.blockchainLinkbernilainullsehingga larian rekod seterusnya, kemudian mengandungi pautan Polygonscan.nextEntryWritten— bila rekod dijangka masuk ke blockchain.
Sahkan fail
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— medan media = fail untuk disemak, medan pilihan pdf = sijil.
Hantar sama ada PDF sijil atau ID resit.
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) — fail sepadan dengan resit; false (code 1) — tidak sepadan.
Ralat
| Respons | Maksud |
|---|---|
{"code": 3, "error": "API key is missing"} | Tambah ?api-key= pada URL |
{"code": 3, "error": "Invalid API key"} | Jana semula kunci dalam aplikasi web |
| HTTP 400 | Tiada fail dalam medan media atau permintaan tidak sah |