REST API · مستندات Swagger
چه چیزهایی میتوانید بسازید
- CMS و وبلاگها: هنگام انتشار، برای هر مقاله یا تصویر مهر زمانی بگیرید.
- ابزارهای طراحی و عکس: هر خروجی را بهطور خودکار ثبت کنید.
- گردش کار اسناد: نسخه دقیق یک قرارداد، پیشنهاد قیمت یا فاکتور را ثبت کنید.
- پایپلاینهای کد: در CI از فایلهای انتشار اثر انگشت دیجیتال بگیرید.
- فروشگاههای آنلاین چندفروشنده: برای هر بارگذاری به فروشندگان اثبات پدیدآورندگی بدهید.
دریافت کلید
- https://run.secureauthor.com را باز کنید و با Google وارد شوید.
- بخش «کلید API» را باز کنید و دکمه ساخت کلید API را بزنید.
- کلید را کپی کنید. آن را بهعنوان پارامتر کوئری
api-keyارسال کنید.
مرجع کامل: مستندات API در 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 گواهی را بفرستید یا شناسه رسید را.
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"} | ?api-key= را به نشانی اضافه کنید |
{"code": 3, "error": "Invalid API key"} | کلید را در وباپلیکیشن دوباره بسازید |
| HTTP 400 | فایلی در فیلد media نیست یا درخواست نادرست است |