REST API · תיעוד Swagger
מה אפשר לבנות
- מערכות CMS ובלוגים: חותמת זמן לכל מאמר או תמונה ברגע הפרסום.
- כלי עיצוב וצילום: רישום אוטומטי של כל ייצוא.
- תהליכי עבודה עם מסמכים: קיבוע הגרסה המדויקת של חוזה, הצעת מחיר או חשבונית.
- פייפליינים של קוד: טביעת אצבע לתוצרי גרסה (release artifacts) ב-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 או שהבקשה שגויה |