REST API · dokumentace Swagger
Co můžete vytvořit
- CMS a blogy: časové razítko pro každý článek nebo obrázek při publikaci.
- Nástroje pro design a fotografie: automatická registrace každého exportu.
- Práce s dokumenty: zafixování přesné verze smlouvy, nabídky nebo faktury.
- CI/CD: otisky artefaktů vydání přímo v CI.
- Tržiště: doklad o autorství pro prodejce u každého nahraného souboru.
Získejte klíč
- Otevřete https://run.secureauthor.com a přihlaste se účtem Google.
- Otevřete sekci Klíč API a stiskněte tlačítko pro vygenerování klíče.
- Zkopírujte klíč. Předávejte ho jako parametr dotazu
api-key.
Kompletní reference: dokumentace Swagger.
Vytvoření potvrzení
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, pole media = soubor.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Odpověď (zkrácená):
{
"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— vzniklo nové potvrzení.code: 1— tento soubor už byl zaregistrován dříve; vrací se původní potvrzení.blockchainLinkjenullaž do nejbližšího ukotvení, pak obsahuje odkaz na Polygonscan.nextEntryWritten— kdy se záznam očekává v blockchainu.
Ověření souboru
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— pole media = soubor ke kontrole, nepovinné pole pdf = certifikát.
Předejte buď PDF certifikát, nebo ID potvrzení.
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) — soubor odpovídá potvrzení; false (code 1) — neodpovídá.
Chyby
| Odpověď | Význam |
|---|---|
{"code": 3, "error": "API key is missing"} | Přidejte do URL ?api-key= |
{"code": 3, "error": "Invalid API key"} | Vygenerujte klíč ve webové aplikaci znovu |
| HTTP 400 | V poli media chybí soubor nebo je požadavek chybně sestavený |