REST API · Swagger ஆவணங்கள்
நீங்கள் என்ன உருவாக்கலாம்
- CMS மற்றும் வலைப்பதிவுகள்: வெளியிடும்போதே ஒவ்வொரு கட்டுரைக்கும் படத்துக்கும் நேர முத்திரை.
- வடிவமைப்பு மற்றும் புகைப்படக் கருவிகள்: ஒவ்வொரு ஏற்றுமதியையும் (export) தானாகப் பதிவு செய்தல்.
- ஆவணப் பணிப்பாய்வுகள்: ஒப்பந்தம், சலுகை அல்லது இன்வாய்ஸின் சரியான பதிப்பை நிலைநிறுத்துதல்.
- குறியீட்டுப் பைப்லைன்கள்: CI-இல் வெளியீட்டுக் கோப்புகளுக்கு (release artifacts) கைரேகை.
- மார்க்கெட்பிளேஸ்கள்: ஒவ்வொரு பதிவேற்றத்துக்கும் விற்பனையாளர்களுக்குப் படைப்புரிமைச் சான்று.
சாவியைப் பெறுங்கள்
- https://run.secureauthor.com ஐத் திறந்து Google மூலம் உள்நுழையுங்கள்.
- “API சாவி” பகுதியைத் திறந்து, API சாவியை உருவாக்கும் பொத்தானை அழுத்துங்கள்.
- சாவியை நகலெடுங்கள். அதை
api-keyquery அளவுருவாக அனுப்புங்கள்.
முழு விவரம்: 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 புலத்தில் கோப்பு இல்லை அல்லது கோரிக்கை தவறான வடிவில் உள்ளது |