API:API के उपयोग को सीमित करना

This page is a translated version of the page API:Restricting API usage and the translation is 100% complete.

यह पृष्ठ मीडियाविकि प्रतिक्रिया API प्रलेख का हिस्सा है।

API (के कुछ हिस्सों) के उपयोग को सीमित करने के या फिर इसे पूरी तरह से अक्षम कर देने के कई तरीके हैं। इनमें से कुछ के लिए सदस्य समूह बदलने की ज़रूरत पड़ सकती है।

लेखन API के उपयोग को सीमित करना

आप विशिष्ट समूहों को writeapi अधिकार न देकर उन्हें लेखन API का उपयोग करने से रोक सकते हैं। डिफ़ॉल्ट से सभी समूहों के पास writeapi अधिकार होता है।

मोडल अक्षम करना

आप LocalSettings.php पर एक पंक्ति जोड़कर विशिष्ट मोडलों को सभी सदस्यों के लिए अक्षम कर सकते हैं। जोड़ना क्या है, यह उस मोडल के प्रकार पर निर्भर है जिसे आप अक्षम करना चाहते हैं:

action= मोडलों के लिए $wgAPIModules ['modulename'] = 'ApiDisabled'; का इस्तेमाल करें
prop= मोडलों के लिए $wgAPIPropModules ['modulename'] = 'ApiQueryDisabled'; का इस्तेमाल करें
list= मोडलों के लिए $wgAPIListModules ['modulename'] = 'ApiQueryDisabled'; का इस्तेमाल करें
meta= मोडलों के लिए $wgAPIMetaModules ['modulename'] = 'ApiQueryDisabled'; का इस्तेमाल करें

उदाहरण

बिना sysop अधिकार के सदस्यों के लिए action=edit का उपयोग अक्षम करना:

if ( !in_array( 'sysop', $wgUser->getGroups() ) ) {
	$wgAPIModules['edit'] = 'ApiDisabled';
}

API ऐक्शन को सीमित करने के लिए ApiCheckCanExecute के लिए यह हुक जोड़ें:

static function onApiCheckCanExecute( $module, $user, &$message ) {
    $moduleName = $module->getModuleName();
    if (
        $moduleName == 'action' &&
        !in_array( 'right', $user->getRights() )
    ) {
        $message = 'apierror-action-notallowed';
        return false;
    }
    return true;
}

'action', 'right' और 'apierror-action-notallowed' को उनके वैल्यूओं से बदल दें।