API REST · documentació Swagger
Què pots construir
- CMS i blogs: posa un segell de temps a cada article o imatge en publicar-lo.
- Eines de disseny i fotografia: registra cada exportació automàticament.
- Fluxos de documents: fixa la versió exacta d'un contracte, una oferta o una factura.
- Pipelines de codi: treu l'empremta dels artefactes de cada versió a la CI.
- Marketplaces: dona als venedors una prova d'autoria per a cada fitxer que pugin.
Obtén una clau
- Obre https://run.secureauthor.com i inicia sessió amb Google.
- Obre la secció «Clau d'API» i prem el botó per generar una clau.
- Copia la clau. Passa-la com a paràmetre de consulta
api-key.
Referència completa: documentació de Swagger.
Crea un rebut
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, camp media = el fitxer.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Resposta (abreujada):
{
"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: s'ha creat un rebut nou.code: 1: aquest fitxer ja s'havia registrat; es torna el rebut original.blockchainLinkésnullfins a la propera execució del registre i després conté l'enllaç a Polygonscan.nextEntryWritten: quan es preveu que el registre arribi a la cadena.
Verifica un fitxer
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— camp media = el fitxer que vols comprovar, camp opcional pdf = el certificat.
Passa o bé el certificat PDF o bé l'ID del rebut.
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): el fitxer coincideix amb el rebut; false (code 1): no hi
coincideix.
Errors
| Resposta | Significat |
|---|---|
{"code": 3, "error": "API key is missing"} | Afegeix ?api-key= a l'URL |
{"code": 3, "error": "Invalid API key"} | Torna a generar la clau a l'aplicació web |
| HTTP 400 | No hi ha cap fitxer al camp media o la petició és incorrecta |