REST API · Swagger-Dokumentation
Was Sie damit bauen können
- CMS und Blogs: jeden Artikel und jedes Bild beim Veröffentlichen mit einem Zeitstempel versehen.
- Design- und Foto-Tools: jeden Export automatisch registrieren.
- Dokumenten-Workflows: die exakte Fassung eines Vertrags, Angebots oder einer Rechnung festhalten.
- Code-Pipelines: Release-Artefakte in der CI mit einem Fingerabdruck versehen.
- Marktplätze: Verkäufern für jeden Upload einen Urheberschaftsnachweis geben.
Schlüssel erhalten
- Öffnen Sie https://run.secureauthor.com und melden Sie sich mit Google an.
- Öffnen Sie den Bereich „API-Schlüssel“ und klicken Sie auf „API-Schlüssel generieren“.
- Kopieren Sie den Schlüssel. Übergeben Sie ihn als Query-Parameter
api-key.
Vollständige Referenz: Swagger-Dokumentation.
Beleg erstellen
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data, Feld media = die Datei.
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
Antwort (gekürzt):
{
"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— neuer Beleg erstellt.code: 1— diese Datei wurde bereits registriert; zurückgegeben wird der ursprüngliche Beleg.blockchainLinkist bis zur nächsten Verankerungnullund enthält danach den Link zu Polygonscan.nextEntryWritten— wann der Eintrag voraussichtlich in der Blockchain steht.
Datei prüfen
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— Feld media = die zu prüfende Datei, optionales Feld pdf = das Zertifikat.
Übergeben Sie entweder das PDF-Zertifikat oder die Beleg-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) — die Datei stimmt mit dem Beleg überein; false (code 1) — sie stimmt nicht überein.
Fehler
| Antwort | Bedeutung |
|---|---|
{"code": 3, "error": "API key is missing"} | Ergänzen Sie ?api-key= in der URL |
{"code": 3, "error": "Invalid API key"} | Erzeugen Sie den Schlüssel in der Web-App neu |
| HTTP 400 | Keine Datei im Feld media oder fehlerhafte Anfrage |