अनुरोध

"# अनुरोध

एक अनुरोध बनाना

होस्ट

Web API v1 अनुरोधों के लिए हमेशा https://api.iafcertsearch.org/api/client/v1 होता है

सभी अनुरोधों को HTTPS के माध्यम से ही किया जाना चाहिए। API HTTP का समर्थन नहीं करती है।

अधिकृतता हैडर

आपको प्रमाणीकरण में वर्णित तरीके से प्राधिकृतता हैडर प्रदान करना होगा।

HTTP धाराओं

• GET एक संसाधन या संसाधन समूह प्राप्त करें

• POST एक नया संसाधन बनाएँ

• PUT मौजूदा संसाधन को अद्यतन करें

• DELETE मौजूदा संसाधन को हटाएँ

• OPTIONS एक विशिष्ट संसाधन के खिलाफ अनुमति धाराओं को देखें

स्वीकारन हैडर

API JSON प्रतिक्रियाएँ प्रदान करता है। वर्तमान में यह स्वीकार हैडर की आवश्यकता नहीं है, लेकिन भविष्य में हो सकता है। यदि निर्धारित नहीं किया जाता है, तो API application/json का उपयोग करेगा।

GET https://api.iafcertsearch.org/api/client/v1/endpoint HTTP/1.1
Accept: application/json

डेटा के निरूपण

जब आप किसी GET अनुरोध में डेटा का एक अर्रेले भेजते हैं, तो आप URL पर पैरामीटर को कई बार शामिल करेंगे। पैरामीटर नाम को कोई ब्रैकेट की आवश्यकता नहीं होती है।

GET https://api.iafcertsearch.org/api/client/v1/endpoint?parameter=data1&parameter=data2 HTTP/1.1

अनुरोध का स्वरूपीकरण

अनुरोध बॉडी

POST या PUT के माध्यम से संसाधन को डेटा दाखिल करते समय, आपको अपने पेलोड को JSON में जमा करना होगा।

POST https://api.iafcertsearch.org/api/client/v1/example/ HTTP/1.1
Content-Type: application/json

{
  "name": "new example name"
}

पृष्ठांकन

कुछ GET संसाधनों की जानकारी के दल को प्राप्त करने की अनुमति है। जब लाये गए वस्तुओं की मांग की जाएगी तब हम संसाधन दस्तावेज़ीकरण में पूछताछ पैरामीटर प्रदान करेंगे।

अधिक संख्या में अनुरोध करते समय, हम अनुरोध limit को 20 वस्तुओं पर डिफ़ॉल्ट करेंगे। जब आपको इसकी आवश्यकता हो तो आप limit पैरामीटर का उपयोग करके एक अलग लिमिट निर्दिष्ट कर सकते हैं। हमारे द्वारा स्वीकार किया जाने वाले limit पैरामीटर के लिए अधिकतम मूल्य 100 है।

नीचे आप एक उदाहरण देख सकते हैं जिसमें एपीआई रिक्वेस्ट सामग्री की पहली 100 रिकॉर्ड प्राप्त करता है जैसा कि limit=100 और offset=0 पैरामीटरों द्वारा निर्दिष्ट किया गया है।

रिकॉर्ड के अगले बैच को प्राप्त करने के लिए, आफ़सेट पैरामीटर को 1 से बढ़ाएँ।

GET https://api.iafcertsearch.org/api/client/v1/resource?limit=100&offset=0 HTTP/1.1

सफल अनुरोध

धारा	संसाधन वस्तु लौटेंगी
GET	एकल संसाधन वस्तु या संसाधन वस्तुओं का एक समूह लौटाता है
PATCH	अद्यतित संसाधन वस्तु लौटाता है
PUT	अद्यतित संसाधन वस्तु लौटाता है
DELETE	कोई सामग्री लौटाई नहीं जाती है
POST	नई संसाधन वस्तु लौटाई जाती है