REST API · Swagger dokumentācija
Ko varat izveidot
- CMS un blogi: laika zīmogs katram rakstam vai attēlam publicēšanas brīdī.
- Dizaina un foto rīki: automātiska katra eksporta reģistrācija.
- Dokumentu plūsmas: precīzas līguma, piedāvājuma vai rēķina versijas fiksēšana.
- Koda konveijeri: relīžu artefaktu nospiedumi CI vidē.
- Tirdzniecības platformas: autorības pierādījums pārdevējiem par katru augšupielādi.
Atslēgas iegūšana
- Atveriet https://run.secureauthor.com un pierakstieties ar Google.
- Atveriet sadaļu „API atslēga“ un nospiediet atslēgas ģenerēšanas pogu.
- Nokopējiet atslēgu. Nododiet to kā vaicājuma parametru
api-key.
Pilna dokumentācija: Swagger dokumentācija.
Kvīts izveide
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, lauks media = fails.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Atbilde (saīsināta):
{
"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— izveidota jauna kvīts.code: 1— šis fails jau ir reģistrēts; tiek atgriezta sākotnējā kvīts.blockchainLinkirnulllīdz nākamajai ierakstīšanas reizei, pēc tam tajā ir saite uz Polygonscan.nextEntryWritten— kad ieraksts paredzams blokķēdē.
Faila pārbaude
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— lauks media = pārbaudāmais fails, neobligāts lauks pdf = sertifikāts.
Nododiet vai nu PDF sertifikātu, vai kvīts 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) — fails atbilst kvītij; false (code 1) — neatbilst.
Kļūdas
| Atbilde | Nozīme |
|---|---|
{"code": 3, "error": "API key is missing"} | Pievienojiet URL adresei ?api-key= |
{"code": 3, "error": "Invalid API key"} | Ģenerējiet atslēgu no jauna tīmekļa lietotnē |
| HTTP 400 | Laukā media nav faila vai pieprasījums ir nekorekts |