API:Restringiendo API uso

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 Obtener un token para las operaciones que modifican datos Login Cierre de sesión Cuentas y usuarios Crear una cuenta (Des)bloquear usuarios Obtener información sobre el usuario activo 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 Crear y editar páginas Consigue los contenidos de una página Cargar archivos Importar páginas Borrar páginas Analizar sintácticamente el contenido de una página 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 Restringiendo API uso Regionalización Implementation Strategy Tutoriales Tutorial de la API de acciones Article ideas generator Nearby places viewer Picture of the day viewer Holidays viewer

Hay varias maneras de restringir el uso de (ciertas partes de) el API a ciertos grupos de usuarios, o deshabilitarla por completo. Algunos de estos requieren cambiar los permisos de grupo.

Deshabilitar toda la API

Puedes deshabilitar la API en su conjunto configurando $wgEnableAPI = false; en LocalSettings.php . La API está habilitada por defecto.

Este ajuste de configuración se desactivó a partir de MediaWiki 1.31.0 y se eliminará en futuras versiones, lo que significa que ya no será posible deshabilitar la API.

Deshabilitar la API de escritura

Puedes deshabilitar todos escribir módulos configurando $wgEnableWriteAPI = false; en LocalSettings.php. La API de escritura está habilitada por defecto a partir de MediaWiki 1.14, y está deshabilitada por defecto en las versiones anteriores.

Este ajuste de configuración se desactivó a partir de MediaWiki 1.31.0 y se eliminará en futuras versiones, lo que significa que ya no será posible deshabilitar la API de escritura.

Restringiendo el acceso a la API de escritura

Puedes denegar a ciertos grupos el derecho a usar la API de escritura negándoles el derecho writeapi. Por defecto, todos los grupos tienen el derecho writeapi. Sin embargo, se requieren ambos, el writeapi correcto y $wgEnableWriteAPI = true; para usar la API de escritura.

Deshabilitar módulos

Puedes deshabilitar módulos individuales para todos los usuarios agregando una línea a LocalSettings.php. Exactamente qué añadir, depende del tipo de módulo que desee deshabilitar:

• Para módulos action=, use $wgAPIModules ['modulename'] = 'ApiDisabled';
• Para módulos prop=, use $wgAPIPropModules ['modulename'] = 'ApiQueryDisabled';
• Para módulos list=, use $wgAPIListModules ['modulename'] = 'ApiQueryDisabled';
• Para módulos meta=, use $wgAPIMetaModules ['modulename'] = 'ApiQueryDisabled';

Ejemplo

Para deshabilitar a cualquiera que no sea un sysop usando action=edit:

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

Para limitar el acceso de una acción de API, agrega el siguiente enlace para 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;
}

Reemplaza 'action', 'right' y 'apierror-action-notallowed' con los valores apropiados.