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

;block:Bloquear a un usuario.

;categorytree:Módulo interno para la extensión CategoryTree.

;changeauthenticationdata:Cambiar los datos de autentificación para el usuario actual.

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

;cspreport: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.

;delete:Borrar una página.

;edit:Crear y editar páginas.

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

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

;oathvalidate:Validar una clave de autenticación en dos pasos (OATH).

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

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

;stashedit:Prepare an edit in shared cache.

;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 del 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.

Uno de los siguientes valores: block, categorytree, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, oathvalidate, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, stashedit, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens
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: user, bot
assertuser

Verificar el usuario actual es el usuario nombrado.

Tipo: 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.

Tipo: booleano/lógico (detalles)
curtimestamp

Incluir la marca de tiempo actual en el resultado.

Tipo: booleano/lógico (detalles)
responselanginfo

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

Tipo: booleano/lógico (detalles)
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: plaintext, wikitext, html, raw, none, bc
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.

Tipo: booleano/lógico (detalles)
Permisos:
writeapi
Hacer uso de la API de escritura
Concedidos a: all, user y bot
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

El formato de entrada de MediaWiki debe ser UTF-8 normalizado por NFC. MediaWiki puede intentar convertir otros formatos, pero ello podría causar que algunas operaciones, como las ediciones con comprobaciones MD5, fallen.

Algunos tipos de parámetros para las solicitudes de API requieren una explicación más a fondo:

boolean
Los parámetros booleanos funcionan como las casillas de verificación en HTML: si se especifica el parámetro, sin importar su valor, se considera verdadero. Para un valor falso, omítase el parámetro completamente.
timestamp
Los cronomarcadores pueden especificarse en varios formatos; para obtener detalles, consúltense los formatos de entrada de la biblioteca Timestamp documentados en mediawiki.org. Se recomienda el formato ISO 8601: 2001-01-15T14:56:00Z. Además, es posible utilizar la cadena now para especificar la fecha y la hora actuales.
separador alternativo para valores múltiples
Normalmente, los parámetros que reciben varios valores se envían con estos separados por una pleca; p. ej., parámetro=valor1|valor2 o parámetro=valor1%7Cvalor2. Si un valor debe contener una pleca, utilícese U+001F (separador de unidades) como el separador ''y'' prefíjese el valor con U+001F; p. ej., parámetro=%1Fvalor1%1Fvalor2.

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