Ayuda de la API de MediaWiki

Esta es una pagina de documentacion autogenerada de la API de MediaWiki.

Documentacion y ejemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Modulo principal

Estau: L'API de MediaWiki ye una interfaz madura y estable que tien encontu y ameyoramientu activu. Anque facemos por evitalo, de xemes en cuando necesitamos facer cambios non compatibles colo anterior; suscribete a la llista de correu mediawiki-api-announce p'avisos sobro anovamientos.

Solicitues incorreutes: Cuando s'unvien solicitues incorreutes a la API, unviase una cabecera HTTP cola clave "MediaWiki-API-Error" y, darreu, tanto'l valor de la cabecera como'l codigu d'error devueltu pondranse al mesmu valor. Pa mas informacion, consulta API: Errores y avisos .

Parametros especificos:
action

Que aicion facer.

abusefiltercheckmatch
Comprobar si un filtru d'abusos casa con un conxuntu de variables, una edicion o un socesu rexistrau d'AbuseFilter.
abusefilterchecksyntax
Comprobar la sintaxis d'un filtru de la Penera d'abusos.
abusefilterevalexpression
Evaluar una espresion de la Penera d'abusos.
abusefilterunblockautopromote
Desbloquia a un usuariu de recibir autopromociones como consecuencia de la penera d'abusos.
abuselogprivatedetails
Ver detalles privaos d'una entrada de AbuseLog.
acquiretempusername
Adquiera un nombre de usuario de usuario temporal y guardelo en la sesion actual, si la creacion de una cuenta temporal esta habilitada y el usuario actual esta desconectado. Si un nombre ya ha sido guardado, devuelve el mismo nombre.
antispoof
Comprobar un nome d'usuariu escontra les comprobaciones de normalizacion AntiSpoof.
block
Bloquiar a un usuariu.
centralauthtoken
Algamar un centralauthtoken pa facer una solicitu autenticada a una wiki anexa.
centralnoticecdncacheupdatebanner
Solicitar la purga del conteniu d'anuncios guardau na cache CDN (frontal) pa usuarios anonimos, pa la llingua y anunciu solicitau
centralnoticechoicedata
Obtener los datos necesarios pa escoyer un cartelu pa un proyeutu y llingua daos
centralnoticequerycampaign
Obtener tolos parametros de configuracion d'una campana.
changeauthenticationdata
Camudar los datos d'identificacion del usuariu actual.
changecontentmodel
Cambia el modelo de contenido de una pagina
checktoken
Comprueba la validez d'un pase dende action=query&meta=tokens .
cirrus-config-dump
Volcau de la configuracion de CirrusSearch.
cirrus-mapping-dump
Volcau del mapeu de CirrusSearch pa esta wiki.
cirrus-profiles-dump
Volcau de los perfiles de CirrusSearch pa esta wiki.
cirrus-settings-dump
Volcau de les preferencies de CirrusSearch pa esta wiki.
clearhasmsg
Llimpia la marca hasmsg del usuariu actual.
clientlogin
Aniciar sesion na wiki usando'l fluxu interactivu.
compare
Llograr la diferencia ente dos paxines.
createaccount
Crear una cuenta d'usuariu nueva.
createlocalaccount
Forcibly create a local account
cxdelete
Desaniciar un borrador de traduccion creau usando la estension Content Translation.
cxsuggestionlist
Xestionar les llistes de suxerencies. Amestar suxerencies a les llistes y desaniciales.
cxtoken
Recibir pases (tokens) JWT pa identificase col cxserver.
delete
Desaniciar una paxina.
deleteglobalaccount
Desaniciar un usuariu global.
discussiontoolsedit
Publicar un mensaje en una pagina de discusion.
discussiontoolsfindcomment
Encontrar un comentario por su ID o nombre.
discussiontoolsgetsubscriptions
Obtiene los estados de suscripcion de los temas dados.
discussiontoolssubscribe
Subscribe (or unsubscribe) to receive notifications about a topic.
echocreateevent
Activar manualmente una notificacion a un usuario
echomarkread
Marcar les notificaciones como lleies pal usuariu actual.
echomarkseen
Marcar les notificaciones como vistes pal usuariu actual.
echomute
Silenciar o anular el silencio de las notificaciones de determinados usuarios o paginas.
edit
Crear y editar paginas.
editmassmessagelist
Editar una llista d'entrega de mensaxes en masa.
emailuser
Unviar un correu electronicu a un usuariu.
expandtemplates
Expande todas las plantillas en wikitexto.
featuredfeed
Devuelve una canal de noticies de conteniu destacau
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 version anterior.
globalblock
Bloquiar o desbloquiar a un usuariu globalmente.
globalpreferenceoverrides
Cambiar les variaciones llocales de les preferencies globales del usuariu actual.
globalpreferences
Camudar les preferencies globales del usuariu actual.
globaluserrights
Amestar/desaniciar un usuariu a/de grupos globales.
growthmanagementorlist
Gestiona la informacion de la lista estructurada de mentores (normalmente almacenada en MediaWiki:GrowthMentors.json ). Este modulo puede ser utilizado tanto por los mentores actuales como por los futuros (para anadirse o cambiar su informacion) y por los bibliotecarios (para todos los usuarios).
growthmentordashboardupdatedata
Programar una actualizacion extraordinaria del modulo de vision general de los aprendices en el panel de mentoria. Solo se puede programar una actualizacion cada dos horas por razones de rendimiento.
growthsetmenteestatus
Establecer el estado de los aprendices (les permite activar/desactivar el modulo de mentoria, o abandonarlo por completo, lo que elimina la relacion aprendiz/mentor)
growthsetmentor
Establecer el mentor o mentora del usuario. El cambio se registrara publicamente.
growthstarmentee
Marcar o desmarcar a un aprendiz como destacado por el usuario actual (se almacena de forma privada y no se registra)
help
Mostrar la ayuda para los modulos especificados.
homepagequestionstore
Obtener preguntas con formato publicadas a traves de los modulos de la pagina de inicio
imagerotate
Esti modulu deshabilitose.
import
Importar una pagina desde otra wiki, o desde un archivo XML.
jsonconfig
Permite l'accesu direutu al subsistema JsonConfig.
languagesearch
Buscar nomes de llingua en cualquier alfabetu.
linkaccount
Vincular una cuenta de un proveedor de terceros para el usuario actual.
login
Iniciar sesion y obtener las cookies de autenticacion.
logout
Salir y vaciar los datos de la sesion.
managetags
Realizar tareas de administracion relacionadas con el cambio de etiquetas.
massmessage
Unviar un mensaxe a una llista de paxines.
mergehistory
Fusionar historiales de paginas.
move
Trasladar una pagina.
opensearch
Buscar en la wiki mediante el protocolo OpenSearch.
options
Cambiar preferencias del usuario actual.
paraminfo
Obtener informacion acerca de los modulos de la API.
parse
Analiza el contenido y devuelve la salida del analizador sintactico.
patrol
Verificar una pagina o revision.
protect
Cambiar el nivel de proteccion de una pagina.
purge
Purgar la cache de los titulos proporcionados.
query
Obtener datos de y sobre MediaWiki.
removeauthenticationdata
Elimina los datos de autentificacion del usuario actual.
resetpassword
Enviar un email de reinicializacion de la contrasena a un usuario.
revisiondelete
Eliminar y restaurar revisiones
rollback
Deshacer la ultima edicion de la pagina.
rsd
Exportar un esquema RSD (Really Simple Discovery; Descubrimiento Muy Simple).
setglobalaccountstatus
Definir l'estau d'un usuariu global.
setnotificationtimestamp
Actualizar la marca de tiempo de notificacion de las paginas en la lista de seguimiento.
setpagelanguage
Cambiar el idioma de una pagina.
shortenurl
Acurtiar una URL llarga a una mas curtia.
sitematrix
Obtener la llista de sitios de Wikimedia.
spamblacklist
Validar una o mas URLs contra la lista negra de spam.
streamconfigs
Exposes event stream config. Returns only format=json with formatversion=2.
strikevote
Permite a los alministradores anular o restaurar un votu.
sxdelete
Delete the draft section translation and its parallel corpora from database.
tag
Anadir o borrar etiquetas de modificacion de revisiones individuales o entradas de registro.
templatedata
Traer los datos almacenaos pola estension TemplateData.
thank
Unviar una notificacion d'agradecimientu a un editor.
titleblacklist
Validar un titulu de paxina, o nome de ficheru o d'usuariu escontra la llista prieta de titulos.
torblock
Comprobar si una direccion IP esta bloqueada como nodo de salida Tor.
transcodereset
Los usuarios col permisu 'transcode-reset' pueden reaniciar y volver a executar un trabayu transcode.
unblock
Desbloquear un usuario.
undelete
Restaurar revisiones de una pagina 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 contrasena contra las politicas de contrasenas de la wiki.
watch
Anadir o borrar paginas de la lista de seguimiento del usuario actual.
webapp-manifest
Devuelve un manifest de webapp.
webauthn
API Module to communicate between server and client during registration/authentication process.
bouncehandler
Interno. Recibir un correu electronicu de rebote y procesalu pa xestionar el receptor falliu.
categorytree
Interno. Modulu internu pa la estension CategoryTree.
cirrus-check-sanity
Interno. Informes sobre la exactitud de una serie de identificadores de paginas en el indice de busqueda.
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 modulo no debe usarse nunca, excepto cuando se usa automaticamente por un navegador web compatible con CSP.
cxcheckunreviewed
Interno. Compruebe si se ha publicado recientemente alguna traduccion rapida y sin revisar para el usuario actual.
cxpublish
Interno. Guardar una paxina creada cola estension Content Translation.
cxpublishsection
Interno. Save a section created using the Content Translation extension's section translation feature.
cxsave
Interno. Esti modulu permite guardar borradores de traducciones por seccion p'aforrar anchor de banda y pa collechar corpora paralelos.
cxsplit
Interno. Create and save a section translation to database, for every translated section of the given article translation
discussiontoolscompare
Interno. Obtenga informacion sobre los cambios en los comentarios entre dos revisiones de la pagina.
discussiontoolspageinfo
Interno. Devuelve los metadatos requeridos para inicializar las herramientas de discusion.
discussiontoolspreview
Interno. Previsualizar un mensaje en una pagina de discusion.
echopushsubscriptions
Interno. Gestiona las notificaciones push del usuario actual.
editcheckreferenceurl
Interno. Check the status of a URL for use as a reference.
fancycaptchareload
Interno. Solicitar un FancyCaptcha nuevu.
growthinvalidateimagerecommendation
Interno. Invalidar una recomendacion de imagen
growthinvalidatepersonalizedpraisesuggestion
Interno. Invalida la sugerencia de un aprendiz digno de elogio en el modulo de elogios personalizados del panel de mentoria.
helppanelquestionposter
Interno. Manejar las preguntas publicadas a traves del panel de ayuda para el usuario actual.
jsondata
Interno. Recuperar datos JSON llocalizaos.
oathvalidate
Interno. Validar un pase d'identificacion de dos factores (OATH)
parser-migration
Interno. Analizar una paxina con dos configuraciones de tidy distintes.
readinglists
Interno. Reading list write operations.
sanitize-mapdata
Interno. Fai la convalidacion de datos pa la estension Kartographer
scribunto-console
Interno. Modulu internu pa dar serviciu a les solicitues XHR de la consola de Scribunto.
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.
sxsave
Interno. Save the draft section translation and store the parallel corpora
timedtext
Interno. Proporciona contenido de texto cronometrado para su uso por parte de elementos <track>
ulslocalization
Interno. Obtener la llocalizacion de ULS na llingua dada.
ulssetlang
Interno. Update user's preferred interface language.
visualeditor
Interno. Devuelve HTML5 pa una paxina dende'l serviciu Parsoid.
visualeditoredit
Interno. Guardar una paxina HTML5 en MediaWiki (convertida en testu wiki mediante'l serviciu 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 , cirrus-config-dump , cirrus-mapping-dump , cirrus-profiles-dump , cirrus-settings-dump , clearhasmsg , clientlogin , compare , createaccount , createlocalaccount , cxdelete , cxsuggestionlist , cxtoken , delete , deleteglobalaccount , discussiontoolsedit , discussiontoolsfindcomment , discussiontoolsgetsubscriptions , discussiontoolssubscribe , echocreateevent , echomarkread , echomarkseen , echomute , edit , editmassmessagelist , emailuser , expandtemplates , featuredfeed , feedcontributions , feedrecentchanges , feedwatchlist , filerevert , globalblock , globalpreferenceoverrides , globalpreferences , globaluserrights , growthmanagementorlist , growthmentordashboardupdatedata , growthsetmenteestatus , growthsetmentor , growthstarmentee , help , homepagequestionstore , 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 , sxdelete , tag , templatedata , thank , titleblacklist , torblock , transcodereset , unblock , undelete , unlinkaccount , upload , userrights , validatepassword , watch , webapp-manifest , webauthn , bouncehandler , categorytree , cirrus-check-sanity , collection , cspreport , cxcheckunreviewed , cxpublish , cxpublishsection , cxsave , cxsplit , discussiontoolscompare , discussiontoolspageinfo , discussiontoolspreview , echopushsubscriptions , editcheckreferenceurl , fancycaptchareload , growthinvalidateimagerecommendation , growthinvalidatepersonalizedpraisesuggestion , helppanelquestionposter , jsondata , oathvalidate , parser-migration , readinglists , sanitize-mapdata , scribunto-console , securepollauth , stashedit , sxsave , timedtext , ulslocalization , ulssetlang , visualeditor , visualeditoredit , wikimediaeventsblockededit
Predeterminado: help
format

El formatu de la salida.

json
Extraer los datos de salida en formato JSON.
jsonfm
Producir los datos de salida en formato JSON (con resaltado sintactico 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 sintactico en HTML).
rawfm
Extraer los datos de salida, incluidos los elementos de depuracion, 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 sintactico en HTML).
Uno de los siguientes valores: json , jsonfm , none , php , phpfm , rawfm , xml , xmlfm
Predeterminado: jsonfm
maxlag

El retrasu (lag) maximu puede utilizase cuando MediaWiki ta instalau nun conxuntu de bases de datos replicaes. Pa evitar les aiciones que pudieran causar un retrasu enta mayor na replicacion del sitiu, esti parametru puede causar que'l cliente espere hasta que'l retrasu de replicacion sia menor que'l valor especificau. En casu de retrasu escesivu, devuelvese un codigu d'error maxlag con un mensaxe asemeyau a Esperando a $host: $lag segundos de retrasu .
Ver Manual:Parametru maxlag pa mas informacion.

Tipo: entero
smaxage

Establez l'encabezau HTTP s-maxage de control de cache a esta cantida de segundos. Los errores nunca se guarden na cache.

Tipo: entero
The value must be no less than 0.
Predeterminado: 0
maxage

Establez l'encabezau HTTP max-age de control de cache a esta cantida de segundos. Los errores nunca se guarden na cache.

Tipo: entero
The value must be no less than 0.
Predeterminado: 0
assert

Comprobar que l'usuariu tien sesion aniciada si'l valor ye user , que nun la tien si ye anon , o que tien permisu de bot si ye bot .

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

Comprobar que'l usuariu actual ye l'usuariu nomau.

Tipu: usuariu, por cualquiera ente nome d'usuariu y Usuario temporal
requestid

Cualquier valor dau equi va incluyise na respuesta. Puede utilizase pa estremar solicitues.

servedby

Incluyir el nome del host que sirvio la solicitu nes resultancies.

Type: boolean ( details )
curtimestamp

Incluyir la marca de tiempu actual na resultancia.

Type: boolean ( details )
responselanginfo

Incluye les llingues utilizaes pa uselang y errorlang nel resultau.

Type: boolean ( details )
origin

Cuando s'accede a la API usando una solicitu AJAX dende otru dominiu (CORS), establezse esti valor al dominiu d'orixe. Tien d'incluise en cualquier solicitu pre-vuelu, y polo tanto ten de ser parte de la URI de la solicitu (non del cuerpu POST).

Nes solicitues con autenticacion, tien de coincidir exautamente con unu de los orixes de la cabecera Origin , polo que tendria de ser daque como https://en.wikipedia.org o https://meta.wikimedia.org . Si esti parametru nun coincide cola cabecera Origin , va devolvese una respuesta 403. Si esti parametru coincide cola cabecera Origin y l'orixe ta na llista blanca, van crease les cabeceres Access-Control-Allow-Origin y Access-Control-Allow-Credentials .

Nes solicitues ensin autenticacion, introduz el valor * . Esto va crear una cabecera Access-Control-Allow-Origin , pero'l valor de Access-Control-Allow-Credentials va ser false y tolos datos que dependan del usuariu taran torgaos.

uselang

La llingua que va utilizase pa les traducciones de mensaxes. action=query&meta=siteinfo con siprop=languages devuelve una llista de codigos de llingua, o puedes introducir user pa usar la preferencia d'idioma del usuariu actual, o content pa usar l'idioma del conteniu d'esta wiki.

Predeterminado: user
variant

Variante del lenguaje. Solo funciona si el lenguaje original soporta conversion variante.

errorformat

Formatu utilizau pa la salida del testu d'avisos y errores.

plaintext
Testu Wiki coles etiquetes HTML desaniciaes y les entidaes reemplazaes.
wikitext
Testu Wiki ensin analizar.
html
HTML.
raw
Clave y parametros del mensaxe.
none
Nenguna salida de testu, solo los codigos d'error.
bc
Formatu emplegau en versiones de MediaWiki anteriores a la 1.29.

Nun se tienen en cuenta errorlang y errorsuselocal .

plaintext
Wikitext with HTML tags removed and entities replaced.
wikitext
Unparsed wikitext.
html
HTML
raw
Message key and parameters.
none
No text output, only the error codes.
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
Uno de los siguientes valores: bc, html, none, plaintext, raw, wikitext
Predeterminado: bc
errorlang

Idioma emplegau p'avisos y errores. action=query&meta=siteinfo con siprop=languages devuelve una llista de codigos d'idioma, o especifica content pa utilizar la llingua del conteniu d'esta wiki o uselang pa utilizar el mesmu valor del parametru uselang .

Predeterminado: uselang
errorsuselocal

Si se da, los testos d'error emplegaran los mensaxes personalizaos llocalmente del espaciu de nomes MediaWiki.

Type: boolean ( details )
centralauthtoken

Al tener accesu a la API usando una solicitu AJAX ente dominios (CORS), usa esto pa identificate como l'usuariu SUL actual. Usa action=centralauthtoken nesta wiki pa recibir el pase, antes de facer la solicitu CORS. Cada pase solo puede usase una vegada, y espira despues de 10 segundos. Esto tendria d'incluise'n toa solicitu pre-vuelu, y poro tendria d'incluise na URI de la solicitu (non nel cuerpu POST).

Permisos:
writeapi
Usar l'API d'escritura
Concedidos a: all, user y bot
apihighlimits
Usa limites mas altos para consultas a traves de la API (consultas lentas: 500; consultas rapidas: 5000). Los limites para las consultas lentas tambien se aplican a los parametros 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 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 - 15 T 14 : 56 : 00 Z . 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 .

Creditos

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)

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