REST API · dokumentacija Swagger
Kaj lahko zgradite
- CMS in blogi: časovni žig za vsak članek ali sliko ob objavi.
- Orodja za oblikovanje in fotografijo: samodejna registracija vsakega izvoza.
- Delo z dokumenti: zabeležite točno različico pogodbe, ponudbe ali računa.
- Razvojni cevovodi: prstni odtisi artefaktov izdaje v CI.
- Spletne tržnice: prodajalcem dajte dokaz avtorstva za vsako naloženo datoteko.
Pridobite ključ
- Odprite https://run.secureauthor.com in se prijavite z Googlom.
- Odprite razdelek Ključ API in ustvarite ključ.
- Kopirajte ključ. Posredujte ga kot parameter poizvedbe
api-key.
Celotna referenca: Dokumentacija API v Swaggerju.
Ustvarite potrdilo
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, polje media = datoteka.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Odgovor (skrajšano):
{
"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— ustvarjeno je novo potrdilo.code: 1— ta datoteka je bila že registrirana; vrne se prvotno potrdilo.blockchainLinkjenulldo naslednjega zasidranja, nato vsebuje povezavo na Polygonscan.nextEntryWritten— kdaj se pričakuje zapis v verigi blokov.
Preverite datoteko
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— polje media = datoteka za preverjanje, neobvezno polje pdf = certifikat.
Posredujte bodisi certifikat PDF bodisi ID potrdila.
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) — datoteka se ujema s potrdilom; false (code 1) — se ne ujema.
Napake
| Odgovor | Pomen |
|---|---|
{"code": 3, "error": "API key is missing"} | URL-ju dodajte ?api-key= |
{"code": 3, "error": "Invalid API key"} | V spletni aplikaciji ustvarite nov ključ |
| HTTP 400 | V polju media ni datoteke ali pa je zahteva napačno oblikovana |