API REST · documentação Swagger
O que pode criar
- CMS e blogues: aplique um selo temporal a cada artigo ou imagem ao publicar.
- Ferramentas de design e fotografia: registe cada exportação automaticamente.
- Fluxos de documentos: fixe a versão exata de um contrato, proposta ou fatura.
- Pipelines de código: gere a impressão digital dos artefactos de cada versão no CI.
- Marketplaces: dê aos vendedores uma prova de autoria para cada carregamento.
Obtenha uma chave
- Abra https://run.secureauthor.com e entre com o Google.
- Abra a secção Chave de API e clique em Gerar chave API.
- Copie a chave. Passe-a no parâmetro de consulta
api-key.
Referência completa: documentação da API no Swagger.
Criar um recibo
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, campo media = o ficheiro.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Resposta (resumida):
{
"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— foi criado um novo recibo.code: 1— este ficheiro já tinha sido registado; é devolvido o recibo original.blockchainLinkficanullaté à ronda de registo seguinte e depois contém a ligação para o Polygonscan.nextEntryWritten— quando o registo deve entrar na blockchain.
Verificar um ficheiro
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— campo media = o ficheiro a conferir, campo opcional pdf = o certificado.
Passe o PDF do certificado ou o ID do recibo.
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) — o ficheiro corresponde ao recibo; false (code 1) — não corresponde.
Erros
| Resposta | Significado |
|---|---|
{"code": 3, "error": "API key is missing"} | Acrescente ?api-key= ao URL |
{"code": 3, "error": "Invalid API key"} | Gere uma nova chave na aplicação web |
| HTTP 400 | Nenhum ficheiro no campo media ou pedido mal formado |