Ayuda de la API de MediaWiki

Esta es una página de documentación autogenerada de la API de MediaWiki.

Documentación y ejemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Módulo principal

Estado: La API de MediaWiki es una interfaz madura y estable que se mejora y prueba activamente. Aunque tratamos de evitarlo, es posible que ocasionalmente debamos hacer cambios importantes. Suscríbete a la lista de correo mediawiki-api-announce para recibir avisos de actualizaciones.

Solicitudes erróneas: Cuando se envían solicitudes erróneas a la API, se enviará un encabezado HTTP con la clave «MediaWiki-API-Error» y, luego, el valor del encabezado y el código de error devuelto se establecerán en el mismo valor. Para obtener más información, consulta API: Errores y advertencias.

Parámetros:
action

Qué acción se realizará.

block
Bloquear a un usuario.
bs-adminuser-store
Enumera todos los usuarios de la base de datos con datos confidenciales adicionales. Permite ordenar, filtrar y paginar. Implementa los parámetros de almacenamiento de ExtJS.
bs-avatars-tasks
Cargar, generar y configurar avatares de usuario
bs-category-store
Enumera todas las categorías. Permite ordenar, filtrar y paginar. Implementa los parámetros de almacenamiento de ExtJS.
bs-category-treestore
Enumera las subcategorías de una categoría específica
bs-categorylinks-store
Enumera todas las categorías de un enlace inclusivo de página a una categoría y marcador para las categorías explícitas e implícitas.
bs-checklist-available-options-store
Enumera todas las opciones disponibles para las plantillas de listas de comprobación. Permite ordenar, filtrar y paginar. Implementa los parámetros de ExtJS Store.
bs-checklist-tasks
Proporciona operaciones para la extensión Checklist
bs-checklist-template-store
Enumera todas las plantillas que son fuentes válidas de listas de comprobación. Permite ordenar, filtrar y paginar. Implementa los parámetros de ExtJS Store.
bs-configmanager-store
Administrar roles
bs-configmanager-tasks
Gestionar tareas
bs-contextmenu-tasks
Proporciona los elementos de menú contextual, en contexto
bs-dashboards-store
Lista de todos los portlets disponibles
bs-dashboards-tasks
Guarda la configuración del tablero
bs-dashboards-widgets-tasks
Devuelve el contenido de algunos widgets del panel de control
bs-filebackend-store
Enumera todos los archivos del archivo de fondo. Permite ordenar, filtrar y paginar. Implementa los parámetros de almacenamiento de ExtJS.
bs-group-store
Enumera todos los grupos excepto $wgImplicitGroups. Permite ordenar, filtrar y paginar. Implementa los parámetros de almacenamiento de ExtJS.
bs-groupmanager
Provides the tasks for the extension GroupManager.
bs-insertfile-license-store
Enumera las licencias para la extensión InsertFile.
bs-insertmagic-data-store
Enumera todos los elementos del diálogo InsertMagic
bs-interwiki-store
Enumera todos los enlaces interwiki. Permite ordenar, filtrar y paginar. Implementa los parámetros de almacenamiento de ExtJS.
bs-interwikilinks-tasks
Provides the tasks for the extension InterWikiLinks.
bs-js-var-config
Proporciona un punto final del API para recuperar variables de configuración del lado del cliente
bs-linker
Muestra links a páginas generadas por Linker
bs-mypageassignment-store
Devuelve las páginas asignadas al usuario actual
bs-namespace-store
Lists all namespaces and arbitrary configuration. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.
bs-namespace-tasks
Permite modificar la configuración del espacio de nombres.
bs-pageaccess-store
Control de acceso a nivel de página
bs-pageassignable-store
Devuelve la lista de asignados
bs-pageassignment-store
Devuelve las asignaciones de la página específica
bs-pageassignment-tasks
Obtener o editar la lista de asignaciones para una página específica
bs-pageauthors-store
Lista todos los autores de una página proporcionada en el contexto
bs-pagetemplates-store
Lists all page templates. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.
bs-pagetemplates-tasks
Permite la manipulación de plantillas de páginas
bs-permissionmanager-tasks
Brinda tareas para el Gestor de permisos
bs-ping-tasks
Tarea ping que proporciona un intercambio continuo de datos
bs-qr-code
Get QR code as base64 data URI for a page
bs-readers-data-store
Obtener información del lector de una página específica.
bs-readers-page-readers-store
Gets all readers of all pages
bs-readers-revision-readers-store
Gets all readers of all revisions of a page
bs-readers-tasks
Proporciona operaciones comunes para los lectores
bs-readers-users-store
Get all readers info of specific page.
bs-recentchanges-store
Enumera todos los cambios recientes. Permite ordenarlos, filtrarlos y paginarlos. Implementa parámetros de almacenamiento.
bs-role-permission-store
Provide role description for the PermissionManager
bs-rss-standards-pages-store
Devolver una lista de las páginas disponibles para RSSFeeder
bs-rssfeeder-tasks
Provides common tasks for the RSSFeeder
bs-smartlist-tasks
API functions to serve portlet data for page and user statistics.
bs-statistics-available-diagrams-store
Proporciona un almacén con los diagramas disponibles
bs-statistics-search-options-store
Proporciona una tienda con opciones de búsqueda disponibles
bs-statistics-tasks
Proporciona tareas comunes para las estadísticas
bs-task
Proporciona el punto final del API para ejecutar tareas registradas
bs-templatelinks-store
Enumera todas las plantillas de una página, incluido el enlace a la plantilla.
bs-titlequery-store
Enumera títulos de página y (opcionalmente) prefijos de espacio de nombres basados ​​en un término de consulta. Implementa los parámetros de almacenamiento de ExtJS.
bs-upload-license-store
Enumera todas las licencias disponibles para una carga de archivo
bs-usagetracker-store
Holds statistical data about extension use
bs-user-store
Enumera todos los usuarios de la base de datos. Permite ordenar, filtrar y paginar. Implementa los parámetros de almacenamiento de ExtJS.
bs-usermanager-group-store
Provides the user manager tasks api for BlueSpice.
bs-usermanager-tasks
Provides operations for Checklist extension
bs-watchlist-store
Enumera todas las entradas de la lista de seguimiento. Permite su ordenamiento y filtrado y consultarlas mediante paginación. Implementa parámetros de almacenamiento.
bs-wikipage-store
Enumera todas las páginas de la wiki. Permite ordenarlas, filtrarlas y paginarlas. Implanta parámetros de la ExtJS Store.
bs-wikipage-tasks
Proporciona operaciones comunes para páginas wiki
bs-wikisubpage-treestore
Enumera las subpáginas de una página concreta de la wiki
changeauthenticationdata
Cambiar los datos de autentificación para el usuario actual.
changecontentmodel
Cambia el modelo de contenido de una página
checktoken
Comprueba la validez de una ficha desde action=query&meta=tokens.
clearhasmsg
Limpia la marca hasmsg del usuario actual.
clientlogin
Entrar en wiki usando el flujo interactivo.
compare
Obtener la diferencia entre 2 páginas.
createaccount
Crear una nueva cuenta de usuario.
delete
Borrar una página.
echomarkread
Marcar las notificaciones del usuario actual como leídas.
echomarkseen
Marcar notificaciones como vistas para el usuario actual.
echomute
Silenciar o anular el silencio de las notificaciones de determinados usuarios o páginas.
edit
Crear y editar páginas.
emailuser
Enviar un mensaje de correo electrónico a un usuario.
embedvideo
expandtemplates
Expande todas las plantillas en wikitexto.
feedcontributions
Devuelve el suministro de contribuciones de un usuario.
feedrecentchanges
Devuelve un suministro de cambios recientes.
feedwatchlist
Devuelve el suministro de una lista de seguimiento.
filerevert
Revertir el archivo a una versión anterior.
flexiskin-activation
El módulo «activate»
flexiskin-delete
El módulo «delete»
flexiskin-preview
El módulo «preview»
flexiskin-save
El módulo «save»
help
Mostrar la ayuda para los módulos especificados.
imagerotate
Girar una o más imágenes.
import
Importar una página desde otra wiki, o desde un archivo XML.
linkaccount
Vincular una cuenta de un proveedor de terceros para el usuario actual.
login
Iniciar sesión y obtener las cookies de autenticación.
logout
Salir y vaciar los datos de la sesión.
managetags
Realizar tareas de administración relacionadas con el cambio de etiquetas.
mergehistory
Fusionar historiales de páginas.
move
Trasladar una página.
opensearch
Buscar en la wiki mediante el protocolo OpenSearch.
options
Cambiar preferencias del usuario actual.
paraminfo
Obtener información acerca de los módulos de la API.
parse
Analiza el contenido y devuelve la salida del analizador sintáctico.
patrol
Verificar una página o revisión.
protect
Cambiar el nivel de protección de una página.
purge
Purgar la caché de los títulos proporcionados.
query
Obtener datos de y sobre MediaWiki.
removeauthenticationdata
Elimina los datos de autentificación del usuario actual.
resetpassword
Enviar un email de reinicialización de la contraseña a un usuario.
revisiondelete
Eliminar y restaurar revisiones
rollback
Deshacer la última edición de la página.
rsd
Exportar un esquema RSD (Really Simple Discovery; Descubrimiento Muy Simple).
setnotificationtimestamp
Actualizar la marca de tiempo de notificación de las páginas en la lista de seguimiento.
setpagelanguage
Cambiar el idioma de una página.
tag
Añadir o borrar etiquetas de modificación de revisiones individuales o entradas de registro.
unblock
Desbloquear un usuario.
undelete
Restaurar revisiones de una página borrada.
unlinkaccount
Remove a linked third-party account from the current user.
upload
Upload a file, or get the status of pending uploads.
userrights
Cambiar la pertenencia a grupos de un usuario.
validatepassword
Valida una contraseña contra las políticas de contraseñas de la wiki.
watch
Añadir o borrar páginas de la lista de seguimiento del usuario actual.
tokens
En desuso. Get tokens for data-modifying actions.
categorytree
Interno. Módulo interno para la extensión CategoryTree.
cspreport
Interno. Utilizado por los navegadores para informar de violaciones a la normativa de seguridad de contenidos. Este módulo no debe usarse nunca, excepto cuando se usa automáticamente por un navegador web compatible con CSP.
stashedit
Interno. Prepare an edit in shared cache.
visualeditor
Interno. Devuelve el código HTML5 de una página por medio del servicio Parsoid.
visualeditoredit
Interno. Guardar una página HTML5 en MediaWiki (convertida en wikicódigo mediante el servicio Parsoid).
Uno de los siguientes valores: block, bs-adminuser-store, bs-avatars-tasks, bs-category-store, bs-category-treestore, bs-categorylinks-store, bs-checklist-available-options-store, bs-checklist-tasks, bs-checklist-template-store, bs-configmanager-store, bs-configmanager-tasks, bs-contextmenu-tasks, bs-dashboards-store, bs-dashboards-tasks, bs-dashboards-widgets-tasks, bs-filebackend-store, bs-group-store, bs-groupmanager, bs-insertfile-license-store, bs-insertmagic-data-store, bs-interwiki-store, bs-interwikilinks-tasks, bs-js-var-config, bs-linker, bs-mypageassignment-store, bs-namespace-store, bs-namespace-tasks, bs-pageaccess-store, bs-pageassignable-store, bs-pageassignment-store, bs-pageassignment-tasks, bs-pageauthors-store, bs-pagetemplates-store, bs-pagetemplates-tasks, bs-permissionmanager-tasks, bs-ping-tasks, bs-qr-code, bs-readers-data-store, bs-readers-page-readers-store, bs-readers-revision-readers-store, bs-readers-tasks, bs-readers-users-store, bs-recentchanges-store, bs-role-permission-store, bs-rss-standards-pages-store, bs-rssfeeder-tasks, bs-smartlist-tasks, bs-statistics-available-diagrams-store, bs-statistics-search-options-store, bs-statistics-tasks, bs-task, bs-templatelinks-store, bs-titlequery-store, bs-upload-license-store, bs-usagetracker-store, bs-user-store, bs-usermanager-group-store, bs-usermanager-tasks, bs-watchlist-store, bs-wikipage-store, bs-wikipage-tasks, bs-wikisubpage-treestore, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, echomarkread, echomarkseen, echomute, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flexiskin-activation, flexiskin-delete, flexiskin-preview, flexiskin-save, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens, categorytree, cspreport, stashedit, visualeditor, visualeditoredit
Predeterminado: help
format

El formato de la salida.

json
Extraer los datos de salida en formato JSON.
jsonfm
Producir los datos de salida en formato JSON (con resaltado sintáctico en HTML).
none
No extraer nada.
php
Extraer los datos de salida en formato serializado PHP.
phpfm
Producir los datos de salida en formato PHP serializado (con resaltado sintáctico en HTML).
rawfm
Extraer los datos de salida, incluidos los elementos de depuración, en formato JSON (embellecido en HTML).
xml
Producir los datos de salida en formato XML.
xmlfm
Producir los datos de salida en formato XML (con resaltado sintáctico en HTML).
Uno de los siguientes valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Predeterminado: jsonfm
maxlag

Se puede usar el retardo máximo cuando se instala MediaWiki en un clúster replicado de base de datos. Para evitar acciones que causen más retardo en la replicación del sitio, este parámetro puede hacer que el cliente espere hasta que el retardo en la replicación sea menor que el valor especificado. En caso de retardo excesivo, se devuelve el código de error maxlag con un mensaje como Esperando a $host: $lag segundos de retardo.
Consulta Manual: parámetro Maxlag para más información.

Tipo: entero
smaxage

Establece la cabecera HTTP s-maxage de control de antememoria a esta cantidad de segundos. Los errores nunca se almacenan en la antememoria.

Tipo: entero
Predeterminado: 0
maxage

Establece la cabecera HTTP max-age de control de antememoria a esta cantidad de segundos. Los errores nunca se almacenan en la antememoria.

Tipo: entero
Predeterminado: 0
assert

Comprobar que el usuario haya iniciado sesión si el valor es user o si tiene el permiso de bot si es bot.

Uno de los siguientes valores: anon, bot, user
assertuser

Verificar el usuario actual es el usuario nombrado.

Tipo: usuario, por nombre de usuario
requestid

Cualquier valor dado aquí se incluirá en la respuesta. Se puede utilizar para distinguir solicitudes.

servedby

Incluir el nombre del host que ha servido la solicitud en los resultados.

Type: boolean (details)
curtimestamp

Incluir la marca de tiempo actual en el resultado.

Type: boolean (details)
responselanginfo

Incluye los idiomas utilizados para uselang y errorlang en el resultado.

Type: boolean (details)
origin

Cuando se accede a la API usando una petición AJAX de distinto dominio (CORS), se establece este valor al dominio de origen. Debe ser incluido en cualquier petición pre-vuelo, y por lo tanto debe ser parte de la URI de la petición (no del cuerpo POST).

En las peticiones con autenticación, debe coincidir exactamente con uno de los orígenes de la cabecera Origin, por lo que debería ser algo como https://en.wikipedia.org o https://meta.wikimedia.org. Si este parámetro no coincide con la cabecera Origin, se devolverá una respuesta 403. Si este parámetro coincide con la cabecera Origin y el origen está en la lista blanca, se creará una cabecera Access-Control-Allow-Origin.

En las peticiones sin autenticación, introduce el valor *. Esto creará una cabecera Access-Control-Allow-Origin, pero el valor de Access-Control-Allow-Credentials será false y todos los datos que dependan del usuario estarán restringidos.

uselang

El idioma que se utilizará para las traducciones de mensajes. action=query&meta=siteinfo con siprop=languages devuelve una lista de códigos de idiomas. También puedes introducir user para usar la preferencia de idioma del usuario actual, o content para usar el idioma de contenido de esta wiki.

Predeterminado: user
errorformat

Formato utilizado para la salida de texto de avisos y errores.

plaintext
Wikitexto en el que se han eliminado las etiquetas HTML y reemplazado las entidades.
wikitext
Wikitexto sin analizar.
html
HTML.
raw
Clave del mensaje y parámetros.
none
Ninguna salida de texto, solo códigos de error.
bc
Formato empleado en versiones de MediaWiki anteriores a la 1.29. No se tienen en cuenta errorlang y errorsuselocal.
Uno de los siguientes valores: bc, html, none, plaintext, raw, wikitext
Predeterminado: bc
errorlang

Idioma empleado para advertencias y errores. action=query&meta=siteinfo con siprop=languages devuelve una lista de códigos de idioma. Puedes especificar content para utilizar el idioma del contenido de esta wiki o uselang para utilizar el valor del parámetro uselang.

Predeterminado: uselang
errorsuselocal

Si se da, los textos de error emplearán mensajes localmente personalizados del espacio de nombres MediaWiki.

Type: boolean (details)
Permisos:
writeapi
Hacer uso de la API de escritura
Concedidos a: all, user, sysop, bureaucrat, editor y reviewer
apihighlimits
Usa límites más altos para consultas a través de la API (consultas lentas: 500; consultas rápidas: 5000). Los límites para las consultas lentas también se aplican a los parámetros multivalorados.
Concedidos a:

Tipos de datos

Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.

Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.

Some parameter types in API requests need further explanation:

boolean

Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.

expiry

Expiry values may be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). For no expiry, use infinite, indefinite, infinity or never.

timestamp

Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.

Templated parameters

Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

Créditos

Desarrolladores de la API:

  • Roan Kattouw (desarrollador principal, sep. 2007-2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (creador y desarrollador principal, sep. 2006-sep. 2007)
  • Brad Jorsch (desarrollador principal, 2013-actualidad)

Envía comentarios, sugerencias y preguntas a mediawiki-api@lists.wikimedia.org o informa de un error en https://phabricator.wikimedia.org/.