REST API · የSwagger ሰነዶች
ምን መገንባት ይችላሉ
- CMS እና ብሎጎች፦ እያንዳንዱን ጽሑፍ ወይም ምስል ሲታተም የጊዜ ማህተም ያድርጉ።
- የዲዛይን እና የፎቶ መሣሪያዎች፦ እያንዳንዱን ኤክስፖርት በራሱ ያስመዝግቡ።
- የሰነድ የሥራ ፍሰቶች፦ የውል፣ የዋጋ ቅናሽ ወይም የደረሰኝ ትክክለኛውን ስሪት ያስቀምጡ።
- የኮድ ፓይፕላይኖች፦ በCI ውስጥ የልቀት ፋይሎችን አሻራ ይመዝግቡ።
- የገበያ መድረኮች፦ ለሻጮች ለእያንዳንዱ ሰቀላ የደራሲነት ማረጋገጫ ይስጡ።
ቁልፍ ያግኙ
- **https://run.secureauthor.com**ን ከፍተው በGoogle ይግቡ።
- የAPI ቁልፍ ክፍልን ከፍተው የAPI ቁልፍ ፍጠር (Generate API key)ን ይጫኑ።
- ቁልፉን ይቅዱ። እንደ
api-keyየጥያቄ መለኪያ (query parameter) ያስተላልፉት።
ሙሉ ማጣቀሻ፦ የ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"} | ወደ URLው ?api-key= ያክሉ |
{"code": 3, "error": "Invalid API key"} | ቁልፉን በዌብ መተግበሪያው ውስጥ እንደገና ይፍጠሩ |
| HTTP 400 | በmedia መስክ ውስጥ ፋይል የለም ወይም ጥያቄው የተሳሳተ ነው |