REST API · Swaggeri dokumentatsioon
Mida saad ehitada
- Sisuhaldussüsteemid ja blogid: lisa avaldamisel igale artiklile või pildile ajatempel.
- Disaini- ja fototööriistad: registreeri iga eksport automaatselt.
- Dokumendivood: fikseeri lepingu, pakkumise või arve täpne versioon.
- Koodi torud: arvuta CI-s väljalaske artefaktidele sõrmejäljed.
- Turuplatvormid: anna müüjatele iga üleslaadimise kohta autorsuse tõend.
Hangi võti
- Ava https://run.secureauthor.com ja logi Google'iga sisse.
- Ava jaotis „API-võti“ ja vajuta „Genereeri API võti“.
- Kopeeri võti. Edasta see päringuparameetrina
api-key.
Täielik viide: Swaggeri API dokumentatsioon.
Loo kviitung
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, väli media = fail.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Vastus (lühendatud):
{
"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— loodi uus kviitung.code: 1— see fail on varem registreeritud; tagastatakse algne kviitung.blockchainLinkonnullkuni järgmise plokiahelasse kirjutamiseni, seejärel on selles Polygonscani link.nextEntryWritten— millal kirje eeldatavasti plokiahelasse jõuab.
Kontrolli faili
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— väli media = kontrollitav fail, valikuline väli pdf = sertifikaat.
Edasta kas PDF-sertifikaat või kviitungi 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) — fail ühtib kviitungiga; false (code 1) — ei ühti.
Vead
| Vastus | Tähendus |
|---|---|
{"code": 3, "error": "API key is missing"} | Lisa URL-ile ?api-key= |
{"code": 3, "error": "Invalid API key"} | Genereeri võti veebirakenduses uuesti |
| HTTP 400 | Väljal media pole faili või päring on vigane |