REST API · Swagger డాక్యుమెంటేషన్
మీరు ఏమి నిర్మించవచ్చు
- CMS మరియు బ్లాగ్లు: ప్రచురించిన ప్రతి వ్యాసానికి లేదా చిత్రానికి టైమ్స్టాంప్.
- డిజైన్ మరియు ఫోటో టూల్స్: ప్రతి ఎక్స్పోర్ట్ను ఆటోమేటిక్గా నమోదు చేయండి.
- డాక్యుమెంట్ వర్క్ఫ్లోలు: ఒప్పందం, ఆఫర్ లేదా ఇన్వాయిస్ యొక్క ఖచ్చితమైన వెర్షన్ను స్థిరపరచండి.
- కోడ్ పైప్లైన్లు: CIలో రిలీజ్ ఆర్టిఫ్యాక్ట్లకు డిజిటల్ వేలిముద్ర.
- మార్కెట్ప్లేస్లు: ప్రతి అప్లోడ్కు అమ్మకందారులకు రచయితత్వ రుజువు ఇవ్వండి.
కీ పొందండి
- https://run.secureauthor.com తెరిచి Googleతో సైన్ ఇన్ చేయండి.
- “API కీ” విభాగాన్ని తెరిచి, API కీని జనరేట్ చేసే బటన్ (Generate API key) నొక్కండి.
- కీని కాపీ చేయండి. దాన్ని
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 లేదా రసీదు 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 ఫీల్డ్లో ఫైల్ లేదు లేదా అభ్యర్థన తప్పుగా ఉంది |