REST API · Swagger-dokumentáció
Mit építhetsz vele?
- CMS és blogok: minden cikk vagy kép időbélyegzése közzétételkor.
- Tervező- és fotós eszközök: minden export automatikus regisztrálása.
- Dokumentumfolyamatok: egy szerződés, ajánlat vagy számla pontos változatának rögzítése.
- Kódfolyamatok: ujjlenyomat a kiadási artefaktumokról a CI-ban.
- Piacterek: szerzőségigazolás az eladóknak minden feltöltéshez.
Kulcs igénylése
- Nyisd meg a https://run.secureauthor.com oldalt, és jelentkezz be Google-fiókkal.
- Nyisd meg az „API-kulcs” részt, és generálj kulcsot.
- Másold ki a kulcsot. Az
api-keylekérdezési paraméterben add át.
Teljes referencia: Swagger API-dokumentáció.
Nyugta létrehozása
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
– multipart/form-data, a media mező = a fájl.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Válasz (rövidítve):
{
"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– új nyugta jött létre.code: 1– ezt a fájlt korábban már regisztrálták; az eredeti nyugtát kapod vissza.- A
blockchainLinkértékenulla következő rögzítésig, utána a Polygonscan-linket tartalmazza. nextEntryWritten– mikor várható a bejegyzés a blokkláncon.
Fájl ellenőrzése
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
– a media mező = az ellenőrizendő fájl, a nem kötelező pdf mező = a tanúsítvány.
Add meg vagy a PDF-tanúsítványt, vagy a nyugtaazonosítót.
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) – a fájl egyezik a nyugtával; false (code 1) – nem egyezik.
Hibák
| Válasz | Jelentés |
|---|---|
{"code": 3, "error": "API key is missing"} | Add hozzá az URL-hez: ?api-key= |
{"code": 3, "error": "Invalid API key"} | Generáld újra a kulcsot a webalkalmazásban |
| HTTP 400 | Nincs fájl a media mezőben, vagy hibás a kérés |