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
- Fuente: MediaWiki
- Licencia: GPL-2.0-or-later
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.
Pruebas: Para facilitar la comprobación de las solicitudes de API, consulta Special:ApiSandbox.
- 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).
- acquiretempusername
- Adquiera un nombre de usuario de usuario temporal y guárdelo en la sesión actual, si la creación de una cuenta temporal está habilitada y el usuario actual está desconectado. Si un nombre ya ha sido guardado, devuelve el mismo nombre.
- 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 una wiki adjunta.
- 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
- 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.
- communityconfigurationedit
- Change the content of a configuration provider in Community configuration
- compare
- Obtener la diferencia entre 2 páginas.
- createaccount
- Crear una nueva cuenta de usuario.
- createlocalaccount
- Forzar la creación de una cuenta local. La cuenta central debe existir.
- delete
- Borrar una página.
- deleteglobalaccount
- Borrar un usuario global.
- discussiontoolsedit
- Publicar un mensaje en una página de discusión.
- discussiontoolsfindcomment
- Encontrar un comentario por su ID o nombre.
- discussiontoolsgetsubscriptions
- Obtiene los estados de suscripción de los temas dados.
- discussiontoolssubscribe
- Subscribe (or unsubscribe) to receive notifications about a topic.
- discussiontoolsthank
- Send a public thank-you notification for a comment.
- echocreateevent
- Activar manualmente una notificación a un usuario
- 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.
- editmassmessagelist
- Editar una lista de envío de mensajes masivos.
- emailuser
- Enviar un mensaje de correo electrónico a un usuario.
- expandtemplates
- Expande todas las plantillas en wikitexto.
- featuredfeed
- Devuelve un suministro de contenido destacado.
- 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.
- 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.
- help
- Mostrar la ayuda para los módulos especificados.
- imagerotate
- Se desactivó este módulo.
- import
- Importar una página desde otra wiki, o desde un archivo XML.
- jsonconfig
- Permite un acceso directo al subsistema JsonConfig.
- languagesearch
- Search for language names in any script.
- 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.
- massmessage
- Send a message to a list of pages.
- 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).
- 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.
- sitematrix
- Obtener la lista de sitios de Wikimedia.
- spamblacklist
- Validar una o más URLs contra la lista negra de spam.
- streamconfigs
- Exposes event stream config. Returns only format=json with formatversion=2.
- strikevote
- Permite a administradores tachar o destachar un voto.
- 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).
- torblock
- Comprobar si una dirección IP está bloqueada como nodo de salida Tor.
- 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 de la wiki.
- watch
- Añadir o borrar páginas de la lista de seguimiento del usuario actual.
- webapp-manifest
- Devuelve un manifiesto de aplicación web.
- webauthn
- API Module to communicate between server and client during registration/authentication process.
- bouncehandler
- Interno. Receive a bounce email and process it to handle the failing recipient.
- categorytree
- Interno. Módulo interno para la extensión CategoryTree.
- cirrus-check-sanity
- Interno. Informes sobre la exactitud de una serie de identificadores de páginas en el índice de búsqueda.
- cirrus-config-dump
- Interno. Volcado de la configuración de CirrusSearch.
- cirrus-mapping-dump
- Interno. Volcado de las asignaciones de CirrusSearch para esta wiki.
- cirrus-profiles-dump
- Interno. Volcado de perfiles de CirrusSearch para esta wiki.
- cirrus-settings-dump
- Interno. Volcado de la configuración de CirrusSearch para esta wiki.
- collection
- Interno. API module for performing various operations on a wiki user's collection.
- 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.
- discussiontoolscompare
- Interno. Obtenga información sobre los cambios en los comentarios entre dos revisiones de la página.
- discussiontoolspageinfo
- Interno. Devuelve los metadatos requeridos para inicializar las herramientas de discusión.
- discussiontoolspreview
- Interno. Previsualizar un mensaje en una página de discusión.
- editcheckreferenceurl
- Interno. Check the status of a URL for use as a reference.
- fancycaptchareload
- Interno. Obtener un FancyCaptcha nuevo.
- jsondata
- Interno. Recuperar datos en JSON regionalizados.
- oathvalidate
- Interno. Validar una clave de autenticación en dos pasos (OATH).
- parser-migration
- Interno. Parse a page with two different parser configurations.
- readinglists
- Interno. Reading list write operations.
- 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.
- securepollauth
- Interno. Allows a remote wiki to authenticate users before granting access to vote in the election.
- stashedit
- Interno. Prepare an edit in shared cache.
- timedtext
- Interno. Proporciona contenido de texto cronometrado para su uso por parte de elementos <track>
- ulslocalization
- Interno. Get the localization of ULS in the given language.
- ulssetlang
- Interno. Update user's preferred interface language.
- 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).
- wikimediaeventsblockededit
- Interno. Log information about blocked edit attempts
- Uno de los siguientes valores: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, bouncehandler, categorytree, cirrus-check-sanity, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, collection, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, fancycaptchareload, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit
- 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
- El valor debe ser no menor de 0.
- 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
- El valor debe ser no menor de 0.
- Predeterminado: 0
- assert
Comprobar que el usuario ha iniciado sesión (aunque sea como usuario temporal) si el valor es user, que no ha iniciado sesión si el valor es anon o que 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 cualquiera de nombre de usuario y Usuario temporal
- 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: boolean (más información)
- curtimestamp
Incluir la marca de tiempo actual en el resultado.
- Tipo: boolean (más información)
- responselanginfo
Incluye los idiomas utilizados para uselang y errorlang en el resultado.
- Tipo: boolean (más información)
- 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://meta.wikimedia.org. Si este parámetro no coincide con la cabeceraOrigin
, se devolverá una respuesta 403. Si este parámetro coincide con la cabeceraOrigin
y el origen está permitido, se creará una cabeceraAccess-Control-Allow-Origin
.En las peticiones sin autenticación, introduce el valor *. Esto creará una cabecera
Access-Control-Allow-Origin
, pero el valor deAccess-Control-Allow-Credentials
seráfalse
y todos los datos que dependan del usuario estarán restringidos.- crossorigin
When accessing the API using a cross-domain AJAX request (CORS) and using a session provider that is safe against cross-site request forgery (CSRF) attacks (such as OAuth), use this instead of
origin=*
to make the request authenticated (i.e., not logged out). This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).Note that most session providers, including standard cookie-based sessions, do not support authenticated CORS and cannot be used with this parameter.
- Tipo: boolean (más información)
- uselang
El idioma que se utilizará para las traducciones de mensajes. action=query&meta=siteinfo&siprop=languages devuelve una lista de códigos. Puedes especificar user («usuario») para usar la preferencia de idioma del usuario actual o content («contenido») para usar el idioma de contenido de esta wiki.
- Predeterminado: user
- variant
Variante del idioma. Solo funciona si el idioma original soporta variantes de conversión.
- errorformat
Formato utilizado para la salida de texto de avisos y errores.
- plaintext
- Wikitexto al que se han eliminado las etiquetas HTML y sustituido las entidades.
- wikitext
- Wikitexto sin analizar.
- html
- HTML
- raw
- Clave y parámetros del mensaje.
- none
- Sin salida de texto, solo los códigos de error.
- bc
- Formato utilizado antes de MediaWiki 1.29. Se ignoran 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&siprop=languages devuelve una lista de códigos de idioma. 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.
- Tipo: boolean (más información)
- 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 esta 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).
- Ayuda del módulo principal
- api.php?action=help [abrir en la zona de pruebas]
- Toda la ayuda en una página
- api.php?action=help&recursivesubmodules=1 [abrir en la zona de pruebas]
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:
- Yuri Astrakhan (creador y desarrollador principal, sep. 2006-sep. 2007)
- Roan Kattouw (desarrollador principal, sep. 2007-2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (desarrollador principal, 2013-2020)
Envía comentarios, sugerencias y preguntas a [email protected] o informa de un error en https://phabricator.wikimedia.org/.