Antcas API
Antcas API डेटा को कई एप्लिकेशनों के बीच आदान-प्रदान करने की अनुमति देता है।
| चेतावनी: इस API का उपयोग करते समय सुरक्षा पर ध्यान दें। केवल TLS का उपयोग करें और कभी भी एक सार्वजनिक रूप से सुलभ पते पर पोर्ट का उपयोग न करें। |
नोट: हर कॉल पर टोकन की जांच करने के लिए, यह उच्च प्रणाली लोड का कारण बन सकता है।
एक API पोर्ट सेटअप करना
प्रोजेक्ट मैनेजमेंट के तहत , एक नया
API पोर्ट जोड़ा जा सकता है। विवरण अध्याय में मिलेगा पोर्ट को प्रोजेक्ट असाइन करना.
एक अनुरोध बनाने के लिए, इसे टोकन द्वारा प्रमाणित किया जाना चाहिए। एक टोकन बनाना अध्याय में विस्तार से समझाया गया है टोकन मैनेज करना.
फॉर्मेट और वैल्यूज़
API कई इनपुट फॉर्मेट्स का समर्थन करता है: HTTP-Queries, JSON और XML. आउटपुट HTML, टेक्स्ट, JSON या XML हो सकता है। चर कोडिंग हमेशा UTF-8 होता है।
नोट: ब्राउज़र में एक तत्व द्वारा कॉल करने से 428 (Precondition Required) एरर होता है। यह XSS-Attack सुरक्षा है, इसे हटाया नहीं जा सकता। यह Antcas Control पर एक हैक अटैक को रोकता है।
एक POST या PUT अनुरोध में डेटा को संबंधित फॉर्मेट में कंटेंट के माध्यम से लिखा जा सकता है। हर चर केस सेंसिटिव होता है, इसका मतलब है कि बड़े और छोटे अक्षरों के बीच अंतर किया जाता है। हालांकि, रिटर्न हमेशा घोषित फॉर्मेट में होता है। आउटपुट फॉर्मेट को हेडर या चर format द्वारा वर्णित किया जा सकता है। इनपुट फॉर्मेट हमेशा स्वचालित रूप से पहचाना जाता है।
GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json
निम्नलिखित फॉर्मेट्स हेडर और चर format में समर्थित हैं:
| Content-Type | Variable | Format |
|---|---|---|
| application/json | json | JSON |
| application/xml | xml | XML |
| text/plain | text | टेक्स्ट |
| text/csv | csv | CSV* |
| (अन्य) | html | HTML |
*केवल आउटपुट फॉर्मेट के रूप में समर्थित है।
नोट: टेक्स्ट और CSV फॉर्मेट्स में UTF-8 BOM होता है। इसे चर bom=FALSE द्वारा निष्क्रिय किया जा सकता है।
अगर एक वैल्यू को कई फॉर्मेट्स द्वारा वर्णित किया जाता है, तो अंतिम फॉर्मेट प्राथमिकता रखता है:
- HTTP-Header (केवल आउटपुट फॉर्मेट Content-Type के माध्यम से)
- GET
- POST
- JSON/XML (POST या PUT कंटेंट के रूप में)
इनपुट चर
निम्नलिखित चर ग्लोबल रूप से परिभाषित किए गए हैं।
| Variable | विवरण |
|---|---|
| format | आउटपुट का फॉर्मेट। |
| bom | UTF-8 फॉर्मेट में BOM. डिफ़ॉल्ट TRUE है। |
| key | केवल एक चर पढ़ता है जो घोषित किया गया था। यह विधि अप्रभावी है क्योंकि सभी डेटा तैयार किए जाते हैं और फिर फ़िल्टर किए जाते हैं। इसे केवल छोटे डेटा सेट्स के साथ उपयोग करना चाहिए। |
| header | हेडर आउटपुट. डिफ़ॉल्ट TRUE है। |
| compact | सभी सब-इलेमेंट्स को एक साथ लाता है। अगर कोई बूलियन वैल्यू घोषित नहीं किया जाता है, तो यह वैल्यू ली जाती है ताकि चर को मिलाया जा सके। अन्यथा, वैल्यू . का उपयोग किया जाएगा। |
| values | केवल वैल्यूज़ और चर नाम नहीं लौटाता है। यह विकल्प केवल HTML, CSV और टेक्स्ट में उपलब्ध है। |
| minimal | header=FALSE, compact=minimal और values=TRUE के लिए एक एलियास है। |
| csvdel | CSV-Delimiter. डिफ़ॉल्ट ; है |
| csvenc | CSV-Enclosure ब्रैकेट्स. डिफ़ॉल्ट " है |
| csvesc | CSV-Escape चिह्न. डिफ़ॉल्ट \ है |
निम्नलिखित चर ग्लोबल रूप से, साथ ही साथ एकल चरों के लिए भी उपयोग किए जा सकते हैं। एकल चर को संबोधित करने के लिए, इसे इस प्रकार परिभाषित किया जाता है:
time*:hr=true
उपरोक्त उदाहरण सभी चरों को संबोधित करता है जो time से शुरू होते हैं और time खुद। नियमों की जांच की जाती है क्रमानुसार। इस प्रकार, अंतिम मिलान वाला नियम प्राथमिकता रखता है। खोज रेगुलर एक्सप्रेशन के माध्यम से की जाती है।
| Variable | विवरण |
|---|---|
| hr | मानव पठनीय. चर, अगर संभव हो, मानव द्वारा पढ़ने योग्य डेटा में परिवर्तित किए जाते हैं। डिफ़ॉल्ट TRUE है फॉर्मेट HTML, CSV और टेक्स्ट के लिए। |
| numdec | डेसीमल के बाद स्थानों की संख्या। |
| numths | हजार विभाजक चिह्न। |
| numdot | डेसीमल विभाजक चिह्न। |
| prefix | चर से पहले टेक्स्ट जोड़ें। |
| suffix | चर के बाद टेक्स्ट जोड़ें। |
पथ
नीचे के अध्यायों में API के सभी अनुप्रयोग परिभाषित किए गए हैं।