REST API · Swagger દસ્તાવેજીકરણ
તમે શું બનાવી શકો
- CMS અને બ્લૉગ: પ્રકાશિત થતાં જ દરેક લેખ કે ચિત્ર પર ટાઇમસ્ટેમ્પ.
- ડિઝાઇન અને ફોટો ટૂલ્સ: દરેક એક્સપોર્ટ આપોઆપ નોંધો.
- દસ્તાવેજ વર્કફ્લો: કરાર, ઑફર કે ઇન્વૉઇસની ચોક્કસ આવૃત્તિ નોંધી રાખો.
- કોડ પાઇપલાઇન: CI માં રિલીઝ આર્ટિફેક્ટ્સનો ફિંગરપ્રિન્ટ બનાવો.
- માર્કેટપ્લેસ: વેચનારાઓને દરેક અપલોડ માટે લેખકત્વનો પુરાવો આપો.
કી મેળવો
- https://run.secureauthor.com ખોલો અને Google થી સાઇન ઇન કરો.
- “API કી” વિભાગ ખોલો અને API કી જનરેટ કરવાનું બટન દબાવો.
- કી કૉપિ કરો. તેને
api-keyક્વેરી પેરામીટર તરીકે મોકલો.
સંપૂર્ણ સંદર્ભ: 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— આ ફાઇલ પહેલાં નોંધાઈ ચૂકી છે; મૂળ રસીદ પાછી મળે છે.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 ફીલ્ડમાં ફાઇલ નથી અથવા વિનંતી ખોટી રીતે બનેલી છે |