REST API · Swagger ডকুমেন্টেশন
আপনি যা তৈরি করতে পারেন
- CMS ও ব্লগ: প্রকাশের সময় প্রতিটি আর্টিকেল বা ছবির টাইমস্ট্যাম্প।
- ডিজাইন ও ফটো টুল: প্রতিটি এক্সপোর্ট স্বয়ংক্রিয়ভাবে নিবন্ধন।
- ডকুমেন্ট ওয়ার্কফ্লো: চুক্তি, অফার বা ইনভয়েসের সঠিক সংস্করণ নির্দিষ্ট করা।
- কোড পাইপলাইন: CI-তে রিলিজ আর্টিফ্যাক্টের ফিঙ্গারপ্রিন্ট।
- মার্কেটপ্লেস: বিক্রেতাদের প্রতিটি আপলোডের জন্য লেখকত্বের প্রমাণ।
কী নিন
- https://run.secureauthor.com খুলে Google দিয়ে সাইন ইন করুন।
- “API কী” বিভাগ খুলে নতুন কী তৈরির বোতাম (Generate API key) চাপুন।
- কী কপি করুন। এটি
api-keyকোয়েরি প্যারামিটার হিসেবে পাঠান।
পূর্ণ রেফারেন্স: “Swagger API ডকুমেন্টেশন”।
রসিদ তৈরি
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"} | URL-এ ?api-key= যোগ করুন |
{"code": 3, "error": "Invalid API key"} | ওয়েব অ্যাপে কী নতুন করে তৈরি করুন |
| HTTP 400 | media ফিল্ডে ফাইল নেই অথবা অনুরোধটি ত্রুটিপূর্ণ |