API:FAQ/hi

अवलोकन
इस पृष्ठ पर मीडियाविकि प्रतिक्रिया API के बारे में कुछ अक्सर पूछे जाने वाले प्रश्नों के उत्तर मौजूद हैं। This page is intended for technical contributors and software developers who wish to understand and use the MediaWiki Action API.

भी पढ़ें। यह कुछ अनुत्तरित सवालों के जवाब और दूसरे उपयोगी पृष्ठों की ओर इशारा करता है।



API-ओं के बारे में


एक API क्या है?
API ऐप्लिकेशन प्रोग्रामिंग इंटरफ़ेस का एक संक्षिप्त रूप है। इससे अलग-अलग ऐप्लिकेशन्स एक-दूसरे से संपर्क कर सकते हैं। Sometimes an API allows an application to request an action to be done by the application which implements the API. मीडियाविकि के शब्दों में, यह वेब-आधारित API-ओं को दर्शाता है, जो HTTP अनुरोध-उत्तर तंत्र का इस्तेमाल करके JSON/XML संरचित डेटा का निर्माण करते हैं।



एक REST API क्या है?
REST, REpresentational State Transfer का एक संक्षिप्त रूप है। एक RESTful प्रणाली को कुछ सिद्धांतों और बाधाओं के एक समूह द्वारा परिभाषित किया जाता है।



एक API क्या कर सकता है?
API के कुछ उपयोग देखें।



मैं API-ओं के बारे में और जानकारी कहाँ मिलेगी?
ये रहे कुछ संसाधन:


 * API समझना
 * API का परिचय
 * REST क्या है - नए लोगों के लिए एक साधारण व्याख्या, भाग 1: परिचय

साधारण


मीडियाविकि प्रतिक्रिया API क्या है?
मीडियाविकि प्रतिक्रिया API एक RESTful वेब सेवा है जिससे सदस्य पृष्ठ निर्माण, प्रमाणीकरण, पार्सिंग, खोज, आदि जैसे विकि-कार्य कर सकते हैं।



मीडियाविकि प्रतिक्रिया API का इस्तेमाल कैसे किया जा सकता है?
मीडियाविकि प्रतिक्रिया API की मदद से:


 * विकि की सुविधाओं तक पहुँचा जा सकता है।
 * विकि पर कार्य किए जा सकते हैं।
 * विकियों और सार्वजनिक सदस्यों के बारे में मेटा-जानकारी प्राप्त की जा सकती है।

दाएँ साइडबार पर API द्वारा समर्थित कई सुविधाओं की कड़ियाँ हैं। और कुछ विकिमीडिया परियोजनाएँ देखें जो मीडियाविकि प्रतिक्रिया API का इस्तेमाल करते हैं।



मैं मीडियाविकि प्रतिक्रिया का इस्तेमाल कैसे करूँ (या इसे कॉल कैसे करूँ)?
आम तौर पर HTTP अनुरोधों की मदद से प्रतिक्रिया API को कॉल किया जाता है। विस्तृत विधि के लिए ट्यूटोरियल पढ़ें।

प्रतिक्रिया API के साथ खिलवाड़ के लिए:


 * Special:ApiSandbox का इस्तेमाल करें।
 * अपने ब्राउज़र का विकासक कंसोल खोजें और विकि पर कार्य करते हुए  पर नेट अनुरोधों पर गौर करें।



एक मॉड्यूल, सबमॉड्यूल, और एक पैरामीटर क्या है?
मीडियाविकि प्रतिक्रिया API में कई मॉड्यूल्स हैं जिनसे हम अलग-अलग कार्य कर सकते हैं। तकनीकी शब्दों में, एक मॉड्यूल ApiBase का एक उपवर्ग है। एक मॉड्यूल में पैरामीटर्स की ज़रूरत होती है। ये पैरामीटर्स सबमॉड्यूल्स हो (और न भी हो) सकते हैं।

यह अनुरोध मानें:

यहाँ:


 * main मुख्य मॉड्यूल का एक पैरामीटर है।
 * एक और मॉड्यूल है। इसे क्वेरी मॉड्यूल कहा जाता है।
 * क्वेरी मॉड्यूल का एक पैरामीटर है।
 * भी एक मॉड्यूल है। इसे  का एक सबमॉड्यूल कहा जा सकता है।
 * खोज मॉड्यूल का एक पैरामीटर है। इसमें खोज स्ट्रिंग 'abc' है।
 * मुख्य मॉड्यूल का एक पैरामीटर है।
 * आउटपुट का प्रारूप है।

परिचय और दिशानिर्देश भी देखें। इसमें  मॉड्यूल के सबमॉड्यूल्स को वर्णित किया गया है।



मुझे कैसे पता चलेगा कि किस सबमॉड्यूल को कॉल करना है?
मीडियाविकि प्रतिक्रिया API काफ़ी बड़ी है, और एक्सटेंशन्स इसे और भी विस्तृत करते हैं। अपना API अनुरोध गढ़ने के कुछ तरीके हैं:


 * साइडबार में वह सुविधा ढूँढ़ें जिसे आप लागू करना चाहते हैं, और कॉल करने के लिए मॉड्यूल्स के बारे में अधिक जानकारी के लिए कड़ी पर क्लिक करें।
 * स्वतः प्रलेखित API पृष्ठों संक्षिप्त विवरणों के साथ सभी मॉड्यूल्स और सबमॉड्यूल्स की सूची मौजूद होगी। आप मुख्य मॉड्यूल पर शुरुआत कर सकते हैं और अलग-अलग सबमॉड्यूल्स की कड़ियों पर क्लिक कर सकते हैं। (विस्तृत संस्करण देखने के लिए अंत में  जोड़ें)



मुझे API मॉड्यूल्स के उपयोग के लिए कोड के नमूने कहाँ मिलेंगे?
The API documentation pages contain an 'Examples' section to demonstrate how different modules and submodules can be used. The auto-generated docs also have examples trailing the module descriptions.

See Mediawiki-API-demos for code snippets in Python and JavaScript.



मैं आउटपुट के प्रारूप को कैसे नियंत्रित करूँ?
The default output format is JSON. Other output formats have been deprecated or removed in the latest stable MediaWiki version, and their use is discouraged.

In older versions, to control the output format, you can pass  in the query string.

For information, see API:Data formats.



क्या मुझे किसी पहुँच टोकन की ज़रूरत है?
You will require an access token to perform data modifying actions like logging in, editing, moving pages, etc.

To learn more, refer to API:Tokens or the sidebar category 'Authentication'.



मैं API की मदद से क्रॉस-साइट अनुरोध कैसे करूँ?
You must use JSONP or CORS to make cross-site requests in MediaWiki.

For details, see API:Cross-site requests.



क्या क्वेरी के परिणामों की कोई सीमा है?
हाँ, यह क्वेरी के पैरामीटर पर निर्भर होता है। उदाहरणस्वरूप,  और   के लिए साधारण सदस्यों को अधिकतम 500 परिणाम दिखाए जाएँगे। The API pages contain information about these limits in the 'Additional notes' section or the 'Limits' section. Note that some modules impose stricter limits under certain conditions.

If you are unsure about what limit to set and just want as many results as possible, set the limit to.



क्या API कॉल्स की कोई सीमा है?
There is no concrete limit. Yet, we recommend making a reasonable number of calls to prevent getting blocked. If you want to make many requests, contact the administrators beforehand.

API:शिष्टाचार भी देखें।

<span id="Where_can_I_get_updates_about_the_MediaWiki_Action_API?">

मुझे मीडियाविकि प्रतिक्रिया API के बारे में अपडेट्स कैसे मिलेंगे?
आप घोषणाएँ और अपडेट्स प्राप्त करने के लिए MediaWiki-API-Announce मेलिंग सूची में सदस्यता ले सकते हैं।

<span id="What_are_wiki_dumps_and_how_can_I_work_with_them?">

विकि डम्प्स क्या हैं और मैं इनके साथ काम कैसे करूँ?
Wikimedia’s data dumps are dumps of wiki collections, content, metadata, search indices, etc. To work with dumps, see using dumps and public dumps.

<span id="Where_can_I_get_more_help?">

मुझे और सहायता कहाँ मिलेगी?
If you can't find answers in the MediaWiki API documentation or the auto-generated documentation pages, feel free to reach out in the following ways.


 * एक विकिमीडिया खाता बनाएँ (अगर आपके पास पहले से खाता नहीं है) और API चर्चा पृष्ठ पर एक नया विषय जोड़ें।
 * अपना सवाल पूछें:
 * पर IRC चैनल में।
 * MediaWiki-API मेलिंग सूची में.

<span id="Extension_developers_and_wiki_owners">

एक्सटेंशनों के विकासक और विकियों के मालिक
<span id="How_can_I_create_an_API_module_in_an_extension?">

मैं किसी एक्सटेंशन में एक API मॉड्यूल कैसे बनाऊँ?
API:एक्सटेंशन पर एक्सटेंशन में API मॉड्यूल बनाने की पूरी प्रक्रिया बताई गई है।

<span id="What_is_the_internal_structure_of_the_API?">

API की आंतरिक संरचना कैसी है?
API:Implementation Strategy में मीडियाविकि मूल में API तंत्र के कार्यान्वयन की व्याख्या है।

<span id="How_can_I_restrict_the_API_usage?">

मैं API के उपयोग को सीमित कैसे करूँ?
API के उपयोग को सीमित करने के लिए आप लेखन API के इस्तेमाल को रोक सकते हैं या फिर चुनिंदा मॉड्यूल्स को अक्षम कर सकते हैं।

अनुदेशों और उदाहरणों के लिए 'API:API के उपयोग को सीमित करना' देखें।

How can I allow/restrict users from modifying the wiki content using the API?
Users are allowed to modify the wiki content by default. To restrict, you have to set  in.

For more information, see API:Changing wiki content.

<span id="Errors_and_troubleshooting">

त्रुटियाँ और समस्या निवारण
<span id="How_do_I_detect_an_error?">

मैं किसी त्रुटि का पता कैसे लगाऊँ?
अगर आपको कोई त्रुटि आती है, API का त्रुटि संदेश,  HTTP हैडर सेट कर देगा और एक त्रुटि संरचना लौटाएगा।

<span id="What_does_this_error_mean?">

इस त्रुटि का मतलब क्या है?
अपनी त्रुटि मानक त्रुटि संदेशों की सूची में ढूँढ़कर पता लगाएँ कि त्रुटि का मतलब क्या है।

<span id="How_do_I_file_a_bug/feature_requests?">

मैं कोई बग/सुविधा का अनुरोध कैसे फ़ाइल करूँ?
आप विकिमीडिया के टास्क ट्रैकिंग उपकरण, Phabricator पर बग्स रिपोर्ट कर सकते हैं और सुविधा के अनुरोध फ़ाइल कर सकते हैं।

नोट:


 * अपने टास्क पर MediaWiki-API परियोजना टैग जोड़ें।
 * अगर आपका रिपोर्ट/अनुरोध किसी एक्सटेंशन द्वारा दिया गया है, उस एक्सटेंशन की परियोजना जोड़ें। (जैसे MediaWiki-extensions-AbuseFilter,  MediaWiki-extensions-FlaggedRevs आदि)
 * Verify for duplicates before creating a new task.
 * Understand the task creation terms on Phabricator before proceeding.

See How to report a bug for more details.

Am I facing errors due to my API version?
If a website runs a different version of MediaWiki, it would also run a different version of the API. Some module parameters supported in one version might be deprecated (or removed) in others. Such parameters will throw an exception if used. The API pages document any such deprecations.

See the release notes for information regarding different API versions.