REST API · Swagger ഡോക്യുമെന്റേഷൻ
നിങ്ങൾക്ക് എന്തൊക്കെ നിർമ്മിക്കാം
- CMS-ഉം ബ്ലോഗുകളും: പ്രസിദ്ധീകരിക്കുമ്പോൾ ഓരോ ലേഖനത്തിനും ചിത്രത്തിനും ടൈംസ്റ്റാമ്പ്.
- ഡിസൈൻ, ഫോട്ടോ ടൂളുകൾ: ഓരോ എക്സ്പോർട്ടും സ്വയമേവ രജിസ്റ്റർ ചെയ്യുക.
- ഡോക്യുമെന്റ് വർക്ക്ഫ്ലോകൾ: ഒരു കരാറിന്റെയോ ഓഫറിന്റെയോ ഇൻവോയ്സിന്റെയോ കൃത്യമായ പതിപ്പ് ഉറപ്പിക്കുക.
- കോഡ് പൈപ്പ്ലൈനുകൾ: CI-യിൽ റിലീസ് ആർട്ടിഫാക്റ്റുകളുടെ ഫിംഗർപ്രിന്റ് എടുക്കുക.
- മാർക്കറ്റ്പ്ലേസുകൾ: ഓരോ അപ്ലോഡിനും വിൽപ്പനക്കാർക്ക് കർതൃത്വത്തിന്റെ തെളിവ് നൽകുക.
കീ നേടുക
- https://run.secureauthor.com തുറന്ന് Google ഉപയോഗിച്ച് സൈൻ ഇൻ ചെയ്യുക.
- “API കീ” വിഭാഗം തുറന്ന് പുതിയ കീ ജനറേറ്റ് ചെയ്യാനുള്ള ബട്ടൺ അമർത്തുക.
- കീ കോപ്പി ചെയ്യുക. അത്
api-keyഎന്ന query പാരാമീറ്ററായി നൽകുക.
പൂർണ റഫറൻസ്: 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— ഈ ഫയൽ മുമ്പ് രജിസ്റ്റർ ചെയ്തതാണ്; യഥാർത്ഥ രസീത് തിരികെ നൽകുന്നു.- അടുത്ത റൺ വരെ
blockchainLinknullആയിരിക്കും, തുടർന്ന് അതിൽ 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 അല്ലെങ്കിൽ രസീത് ID — ഇവയിൽ ഒന്ന് നൽകുക.
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 ഫീൽഡിൽ ഫയൽ ഇല്ല, അല്ലെങ്കിൽ അഭ്യർത്ഥന തെറ്റായ രൂപത്തിലാണ് |