API:Restricting API usage/es

API de acciones de MediaWiki
Uso básico Todos los módulos de consultas Obtener propiedades de páginas Hacer una lista de páginas que cumplan un criterio Obtener información de los parámetros de los módulos Obtener metainformación sobre el wiki y el usuario Autentificación Get tokens for data modifying operations Login Cierre de sesión Assert user Cuentas y usuarios Crear una cuenta (Des)bloquear usuarios Get info about the current user Obtener la lista de seguimiento del usuario activo en forma de canal Opciones de usuario Cambiar los miembros del grupo Enviar correo electrónico Operaciones en páginas Analizar sintácticamente el contenido de una página Crear y editar páginas Cargar archivos Importar páginas Borrar páginas Vigilar o dejar de vigilar páginas Purga de la antememoria de las páginas Revertir una página Trasladar páginas Patrullar cambios Restablecer revisiones borradas (Des)proteger páginas Cambiar el idioma de una página Más… Búsqueda Buscar un título o un texto Obtener resultados en formato Open Search Buscar páginas wiki cercanas a una ubicación Buscar un idioma Realizar una búsqueda de prefijo de títulos de página Herramientas de desarrollador Acceder a bibliotecas Peticiones en sitios cruzados Crear un módulo de la API en una extensión Usar la API en MediaWiki y extensiones Restricting API usage Regionalización Implementation Strategy Tutorials Action API Tutorial Article ideas generator Nearby places viewer Picture of the day viewer

There are several ways to restrict usage of (certain parts of) the API to certain groups of users, or to disable it altogether. Some of these require changing group permissions.

Disabling the entire API

You can disable the API as a whole by setting $wgEnableAPI = false; in LocalSettings.php . The API is enabled by default.

This configuration setting was deprecated starting with MediaWiki 1.31.0 and will be removed in future versions meaning that disabling the API will no longer be possible.

Disabling the write API

You can disable all write modules by setting $wgEnableWriteAPI = false; in LocalSettings.php. The write API is enabled by default as of MediaWiki 1.14, and disabled by default in older versions.

This configuration setting was deprecated starting with MediaWiki 1.31.0 and will be removed in future versions meaning that disabling the write API will no longer be possible.

Restricting access to the write API

You can deny certain groups the right to use the write API by denying them the writeapi right. By default, all groups have the writeapi right. However, both the writeapi right and $wgEnableWriteAPI = true; are required in order to use the write API.

Disabling modules

You can disable individual modules for all users by adding a line to LocalSettings.php. Exactly what to add depends on the type of module you want to disable:

• For action= modules, use $wgAPIModules ['modulename'] = 'ApiDisabled';
• For prop= modules, use $wgAPIPropModules ['modulename'] = 'ApiQueryDisabled';
• For list= modules, use $wgAPIListModules ['modulename'] = 'ApiQueryDisabled';
• For meta= modules, use $wgAPIMetaModules ['modulename'] = 'ApiQueryDisabled';

Ejemplo

To disable anyone who isn't a sysop from using action=edit:

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

To limit the access of an API action, add the following hook for ApiCheckCanExecute :

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

Replace 'action', 'group' and 'apierror-action-notallowed' with the appropriate values.