REST API · Swagger-dokumentation
Det kan du bygge
- CMS og blogs: tidsstempl hver artikel eller hvert billede ved udgivelse.
- Design- og fotoværktøjer: registrér hver eksport automatisk.
- Dokumentforløb: fastlås den præcise version af en kontrakt, et tilbud eller en faktura.
- Kodepipelines: tag fingeraftryk af release-artefakter i CI.
- Markedspladser: giv sælgere bevis for ophavsmandskab for hver upload.
Få en nøgle
- Åbn https://run.secureauthor.com, og log ind med Google.
- Åbn sektionen API-nøgle, og generér en nøgle.
- Kopiér nøglen. Send den som query-parameteren
api-key.
Fuld reference: Swagger API-dokumentation.
Opret en kvittering
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
– multipart/form-data, feltet media = filen.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Svar (forkortet):
{
"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– en ny kvittering er oprettet.code: 1– filen er registreret før; den oprindelige kvittering returneres.blockchainLinkernullindtil næste forankring og indeholder derefter linket til Polygonscan.nextEntryWritten– hvornår registreringen forventes i blockchainen.
Kontrollér en fil
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
– feltet media = filen, der skal kontrolleres, valgfrit felt pdf = certifikatet.
Send enten PDF-certifikatet eller kvitteringens 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) – filen stemmer med kvitteringen; false (code 1) – det gør den ikke.
Fejl
| Svar | Betydning |
|---|---|
{"code": 3, "error": "API key is missing"} | Tilføj ?api-key= til URL'en |
{"code": 3, "error": "Invalid API key"} | Generér en ny nøgle i webappen |
| HTTP 400 | Ingen fil i feltet media eller en forkert udformet forespørgsel |