REST API · وثائق Swagger
ما الذي يمكنك بناؤه
- أنظمة إدارة المحتوى والمدونات: ختم زمني لكل مقال أو صورة عند النشر.
- أدوات التصميم والتصوير: تسجيل كل ملف مُصدَّر تلقائيًا.
- سير عمل المستندات: تثبيت النسخة الدقيقة من عقد أو عرض أو فاتورة.
- مسارات الشيفرة: بصمة لملفات الإصدار في 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 أو رقم الإيصال.
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 (الرمز 0): الملف مطابق للإيصال؛ وfalse (الرمز 1): غير مطابق.
الأخطاء
| الاستجابة | المعنى |
|---|---|
{"code": 3, "error": "API key is missing"} | أضف ?api-key= إلى الرابط |
{"code": 3, "error": "Invalid API key"} | أعد إنشاء المفتاح في تطبيق الويب |
| HTTP 400 | لا يوجد ملف في الحقل media أو الطلب غير صحيح البنية |