REST API · Swagger dokumentacija
Ką galite sukurti
- TVS ir tinklaraščiai: pažymėkite kiekvieno straipsnio ar vaizdo laiką jį paskelbdami.
- Dizaino ir nuotraukų įrankiai: automatiškai registruokite kiekvieną eksportą.
- Dokumentų srautai: užfiksuokite tikslią sutarties, pasiūlymo ar sąskaitos versiją.
- Kodo srautai: CI aplinkoje apskaičiuokite leidimų artefaktų piršto atspaudus.
- Prekyvietės: suteikite pardavėjams autorystės įrodymą kiekvienam įkėlimui.
Gaukite raktą
- Atidarykite https://run.secureauthor.com ir prisijunkite su „Google“.
- Atidarykite skiltį API raktas ir paspauskite rakto generavimo mygtuką.
- Nukopijuokite raktą. Perduokite jį kaip užklausos parametrą
api-key.
Visas aprašas: Swagger API dokumentacija.
Kvito sukūrimas
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
– multipart/form-data, laukas media = failas.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Atsakymas (sutrumpintas):
{
"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– sukurtas naujas kvitas.code: 1– šis failas jau buvo užregistruotas; grąžinamas pirminis kvitas.blockchainLinkyranulliki kito įrašymo į grandinę, vėliau jame – nuoroda į Polygonscan.nextEntryWritten– kada numatomas įrašas grandinėje.
Failo patikrinimas
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
– laukas media = tikrinamas failas, neprivalomas laukas pdf = sertifikatas.
Perduokite arba PDF sertifikatą, arba kvito 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) – failas sutampa su kvitu; false (code 1) – nesutampa.
Klaidos
| Atsakymas | Reikšmė |
|---|---|
{"code": 3, "error": "API key is missing"} | Pridėkite ?api-key= prie URL |
{"code": 3, "error": "Invalid API key"} | Sugeneruokite raktą iš naujo internetinėje programoje |
| HTTP 400 | Lauke media nėra failo arba užklausa netaisyklinga |