REST API · dokumentácia Swagger
Čo môžete vytvoriť
- CMS a blogy: časová pečiatka pre každý článok alebo obrázok pri zverejnení.
- Nástroje pre dizajn a fotografiu: automatická registrácia každého exportu.
- Dokumentové procesy: zafixovanie presnej verzie zmluvy, ponuky alebo faktúry.
- Pipelines pre kód: odtlačky artefaktov vydaní v CI.
- Marketplaces: doklad o autorstve pre predajcov ku každému nahratiu.
Získajte kľúč
- Otvorte https://run.secureauthor.com a prihláste sa cez Google.
- Otvorte sekciu Kľúč API a stlačte tlačidlo na vygenerovanie kľúča.
- Skopírujte kľúč. Odovzdávajte ho ako parameter dopytu
api-key.
Úplná referencia: Dokumentácia API vo Swaggeri.
Vytvorenie potvrdenia
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, pole media = súbor.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Odpoveď (skrátená):
{
"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— vytvorilo sa nové potvrdenie.code: 1— tento súbor už bol zaregistrovaný; vráti sa pôvodné potvrdenie.blockchainLinkjenullaž do najbližšieho ukotvenia, potom obsahuje odkaz na Polygonscan.nextEntryWritten— kedy sa očakáva záznam v blockchaine.
Overenie súboru
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— pole media = súbor na overenie, nepovinné pole pdf = certifikát.
Odovzdajte buď PDF certifikát, alebo ID potvrdenia.
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) — súbor sa zhoduje s potvrdením; false (code 1) — nezhoduje sa.
Chyby
| Odpoveď | Význam |
|---|---|
{"code": 3, "error": "API key is missing"} | Pridajte do URL ?api-key= |
{"code": 3, "error": "Invalid API key"} | Vygenerujte kľúč vo webovej aplikácii znova |
| HTTP 400 | V poli media chýba súbor alebo je požiadavka chybná |