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/API

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á.

abusefiltercheckmatch
Comprobar si un filtro antiabusos coincide con un conjunto de variables, una edición o un suceso registrado del filtro antiabusos.
abusefilterchecksyntax
Verificar el código de un filtro antiabusos.
abusefilterevalexpression
Evalúa una expresión del filtro antiabusos.
abusefilterunblockautopromote
Desbloquea a un usuario para que pueda recibir permisos de usuario otorgados automáticamente por el sistema, anteriormente impedido como consecuencia de un disparo del filtro antiabusos.
abuselogprivatedetails
Ver detalles privados de una entrada de AbuseLog (registro de abuso).
antispoof
Comprobar un nombre de usuario contra las verificaciones de normalización de AntiSpoof.
block
Bloquear a un usuario.
centralauthtoken
Obtener un "centralauthtoken" para realizar una solicitud autenticada a un wiki adjunto.
centralnoticecdncacheupdatebanner
Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language
centralnoticechoicedata
Get data needed to choose a banner for a given project and language
centralnoticequerycampaign
Get all configuration settings for a campaign.
changeauthenticationdata
Cambiar los datos de autentificación para el usuario actual.
changecontentmodel
Cambia el modelo de contenido de una página
chatgetnew
Get new messages in the chat.
chatkick
Kick a user from the chat
chatsend
Send a public message to the chat
chatsendpm
Send a private message to a user
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.
createlocalaccount
Forcibly create a local account
delete
Borrar una página.
deletedumps
deleteglobalaccount
Borrar un usuario global.
echomarkread
Marcar las notificaciones del usuario actual como leídas.
echomarkseen
Marcar notificaciones como vistas para el usuario actual.
echomute
Mute or unmute notifications from certain users or pages.
edit
Crear y editar páginas.
editmassmessagelist
Edit a mass message delivery list.
emailuser
Enviar un mensaje de correo electrónico a un usuario.
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.
generatedumps
globalblock
Bloquear o desbloquear globalmente a un usuario.
globalpreferenceoverrides
Cambiar preferencias locales para la cuenta de usuario actual.
globalpreferences
Cambiar las preferencias globales del usuario actual.
globaluserrights
Añadir o eliminar a un usuario de grupos globales.
graph
Access graph tag functionality.
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.
jsonconfig
Permite un acceso directo al subsistema JsonConfig.
linkaccount
Vincular una cuenta de un proveedor de terceros para el usuario actual.
linksuggest
Suggest link to editors on edit view
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.
massmessage
Send a message to a list of pages.
mergehistory
Fusionar historiales de páginas.
move
Trasladar una página.
opensearch
Buscar en el 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.
pollsubmitvote
Módulo API AJAXPoll
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).
setglobalaccountstatus
Establecer el estado de un usuario global.
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.
shortenurl
Acortar un URL largo.
spamblacklist
Validar una o más URLs contra la lista negra de spam (SpamBlacklist).
streamconfigs
Exposes event stream config. Returns only format=json with formatversion=2.
tag
Añadir o borrar etiquetas de modificación de revisiones individuales o entradas de registro.
templatedata
Recuperar datos almacenados por la extensión TemplateData.
thank
Enviar una notificación de agradecimiento a un editor.
titleblacklist
Validar el título de una página, nombre de archivo o nombre de usuario en la TitleBlacklist (lista negra de títulos).
transcodereset
Users with the 'transcode-reset' right can reset and re-run a transcode job.
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 del wiki.
viewdumps
Ver los volcados del tipo, nombre de archivo o fecha especificados.
watch
Añadir o borrar páginas de la lista de seguimiento del usuario actual.
webapp-manifest
Devuelve un manifiesto de aplicación web.
wikidiscover
Obtenga una lista de wikis de una granja de wiki de CreateWiki.
wikilove
Give WikiLove to another user.
mobileview
En desuso. Devuelve datos necesarios para las vistas móviles.
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.
jsondata
Interno. Recuperar datos en JSON regionalizados.
oathvalidate
Interno. Validar una clave de autenticación en dos pasos (OATH).
sanitize-mapdata
Interno. Realiza validación de datos para la extensión Kartographer
scribunto-console
Interno. Internal module for servicing XHR requests from the Scribunto console.
stashedit
Interno. Prepare an edit in shared cache.
timedtext
Interno. Proporciona contenido de texto cronometrado para su uso por parte de elementos <track>
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: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, chatgetnew, chatkick, chatsend, chatsendpm, checktoken, clearhasmsg, clientlogin, compare, createaccount, createlocalaccount, delete, deletedumps, deleteglobalaccount, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, generatedumps, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, graph, help, imagerotate, import, jsonconfig, linkaccount, linksuggest, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, pollsubmitvote, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, spamblacklist, streamconfigs, tag, templatedata, thank, titleblacklist, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, viewdumps, watch, webapp-manifest, wikidiscover, wikilove, mobileview, tokens, categorytree, cspreport, jsondata, oathvalidate, sanitize-mapdata, scribunto-console, stashedit, timedtext, 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 este 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 este 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)
centralauthtoken

Cuando accedas a la API mediante una petición AJAX entre dominios (CORS), utiliza esto para autenticarte como el usuario SUL actual. Utiliza action=centralauthtoken en este wiki para obtener el token antes de realizar la petición CORS. Cada token solo se puede utilizar una vez, y expira al cabo de 10 segundos. Esto debería incluirse en cualquier petición pre-vuelo, y por tanto debería incluirse en la URI de la petición (y no en el cuerpo del POST).

Permisos:
writeapi
Hacer uso de la API de escritura
Concedidos a: all, bot y user
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: bot y sysop

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 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/.