REST API · Swagger-documentatie
Wat je kunt bouwen
- CMS'en en blogs: zet bij publicatie een tijdstempel op elk artikel of elke afbeelding.
- Ontwerp- en fototools: registreer elke export automatisch.
- Documentworkflows: leg de exacte versie van een contract, offerte of factuur vast.
- Code-pipelines: maak in CI een vingerafdruk van release-artefacten.
- Marktplaatsen: geef verkopers bewijs van auteurschap voor elke upload.
Vraag een sleutel aan
- Open https://run.secureauthor.com en log in met Google.
- Open het onderdeel „API-sleutel” en druk op de knop om een sleutel te genereren (Generate API key).
- Kopieer de sleutel. Geef hem mee als queryparameter
api-key.
Volledige referentie: Swagger API-documentatie.
Een ontvangstbewijs maken
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, veld media = het bestand.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Antwoord (ingekort):
{
"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— nieuw ontvangstbewijs gemaakt.code: 1— dit bestand is al eerder geregistreerd; je krijgt het oorspronkelijke ontvangstbewijs terug.blockchainLinkisnulltot de volgende verankeringsronde en bevat daarna de link naar Polygonscan.nextEntryWritten— wanneer het record naar verwachting op de blockchain staat.
Een bestand controleren
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— veld media = het bestand dat je wilt controleren, optioneel veld pdf = het certificaat.
Geef de pdf van het certificaat of de ID van het ontvangstbewijs mee.
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) — het bestand komt overeen met het ontvangstbewijs; false (code 1) — het komt niet overeen.
Fouten
| Antwoord | Betekenis |
|---|---|
{"code": 3, "error": "API key is missing"} | Voeg ?api-key= toe aan de URL |
{"code": 3, "error": "Invalid API key"} | Genereer de sleutel opnieuw in de webapp |
| HTTP 400 | Geen bestand in het veld media of een onjuist opgebouwd verzoek |