REST API・Swaggerドキュメント
作れるもの
- CMSやブログ:記事や画像の公開時に自動でタイムスタンプを付与。
- デザイン・写真ツール:書き出したファイルを毎回自動で登録。
- 文書ワークフロー:契約書、見積書、請求書の正確なバージョンを固定。
- コードのパイプライン:CIでリリース成果物のハッシュを記録。
- マーケットプレイス:出品者がアップロードするたびに作者証明を提供。
キーを取得する
- https://run.secureauthor.com を開き、Googleでサインインします。
- 「APIキー」のセクションを開き、「APIキーを生成」を押します。
- キーをコピーします。クエリパラメーター
api-keyとして渡してください。
詳細なリファレンス:Swaggerドキュメント
受領証を作成する
POST https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY
— multipart/form-data、フィールド media にファイルを指定します。
curl -X POST "https://api.secureauthor.com/api/recipient/user-api/create-with-pdf?api-key=YOUR_KEY" \
-F "media=@artwork.png"
レスポンス(抜粋):
{
"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:新しい受領証が作成されました。code: 1:このファイルは登録済みです。元の受領証が返されます。blockchainLinkは次回の記録まではnullで、その後Polygonscanへのリンクが入ります。nextEntryWritten:ブロックチェーンへの記録予定時刻。
ファイルを検証する
POST https://api.secureauthor.com/api/recipient/user-api/compare-with-pdf?api-key=YOUR_KEY[&hash-id=RECEIPT_ID]
— フィールド media に確認するファイル、任意のフィールド pdf に証明書を指定します。証明書PDFか受領証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)はファイルが受領証と一致、false(code 1)は不一致を意味します。
エラー
| レスポンス | 意味 |
|---|---|
{"code": 3, "error": "API key is missing"} | URLに ?api-key= を追加してください |
{"code": 3, "error": "Invalid API key"} | Webアプリでキーを再生成してください |
| HTTP 400 | media フィールドにファイルがないか、リクエストの形式が正しくありません |