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
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; suscríbete a la llista de corréu mediawiki-api-announce p'avisos sobro anovamientos.
Solicitúes incorreutes: Cuando s'unvíen solicitúes incorreutes a la API, unvíase una cabecera HTTP cola clave "MediaWiki-API-Error" y, darréu, tanto'l valor de la cabecera como'l códigu d'error devueltu pondránse al mesmu valor. Pa más información, consulta API: Errores y avisos.
Pruebes: Pa facilitar les pruebes de solicitúes API, consulta Special:ApiSandbox.
- action
Qué aición facer.
- abusefiltercheckmatch
- Comprobar si un filtru d'abusos casa con un conxuntu de variables, una edición o un socesu rexistráu d'AbuseFilter.
- abusefilterchecksyntax
- Comprobar la sintaxis d'un filtru de la Peñera d'abusos.
- abusefilterevalexpression
- Evaluar una espresión de la Peñera d'abusos.
- abusefilterunblockautopromote
- Desbloquia a un usuariu de recibir autopromociones como consecuencia de la peñera d'abusos.
- abuselogprivatedetails
- Ver detalles privaos d'una entrada de AbuseLog.
- 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 nome d'usuariu escontra les comprobaciones de normalización AntiSpoof.
- block
- Bloquiar a un usuariu.
- centralauthtoken
- Algamar un centralauthtoken pa facer una solicitú autenticada a una wiki anexa.
- centralnoticecdncacheupdatebanner
- Solicitar la purga del conteníu d'anuncios guardáu na caché CDN (frontal) pa usuarios anónimos, pa la llingua y anunciu solicitáu
- centralnoticechoicedata
- Obtener los datos necesarios pa escoyer un cartelu pa un proyeutu y llingua daos
- centralnoticequerycampaign
- Obtener tolos parámetros de configuración d'una campaña.
- changeauthenticationdata
- Camudar los datos d'identificación del usuariu actual.
- changecontentmodel
- Cambia el modelo de contenido de una página
- checktoken
- Comprueba la validez d'un pase dende action=query&meta=tokens.
- cirrus-config-dump
- Volcáu de la configuración de CirrusSearch.
- cirrus-mapping-dump
- Volcáu del mapéu de CirrusSearch pa esta wiki.
- cirrus-profiles-dump
- Volcáu de los perfiles de CirrusSearch pa esta wiki.
- cirrus-settings-dump
- Volcáu de les preferencies de CirrusSearch pa esta wiki.
- clearhasmsg
- Llimpia la marca
hasmsg
del usuariu actual. - clientlogin
- Aniciar sesión na wiki usando'l fluxu interactivu.
- compare
- Llograr la diferencia ente dos páxines.
- createaccount
- Crear una cuenta d'usuariu nueva.
- createlocalaccount
- Forcibly create a local account
- delete
- Desaniciar una páxina.
- deleteglobalaccount
- Desaniciar un usuariu 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.
- echomarkread
- Marcar les notificaciones como lleíes 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 páginas.
- edit
- Crear y editar páginas.
- editmassmessagelist
- Editar una llista d'entrega de mensaxes en masa.
- emailuser
- Unviar un corréu electrónicu a un usuariu.
- expandtemplates
- Expande todas las plantillas en wikitexto.
- featuredfeed
- Devuelve una canal de noticies de conteníu destacáu
- 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
- 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.
- help
- Mostrar la ayuda para los módulos especificados.
- imagerotate
- Esti módulu deshabilitóse.
- import
- Importar una página 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 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
- Unviar un mensaxe a una llista de páxines.
- 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
- Definir l'estáu d'un usuariu 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
- Acurtiar una URL llarga a una más curtia.
- sitematrix
- Obtener la llista 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 los alministradores anular o restaurar un votu.
- tag
- Añadir o borrar etiquetas de modificación de revisiones individuales o entradas de registro.
- templatedata
- Traer los datos almacenaos pola estensión TemplateData.
- thank
- Unviar una notificación d'agradecimientu a un editor.
- titleblacklist
- Validar un títulu de páxina, o nome de ficheru o d'usuariu escontra la llista prieta de títulos.
- torblock
- Comprobar si una dirección IP está 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 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 manifest de webapp.
- webauthn
- API Module to communicate between server and client during registration/authentication process.
- bouncehandler
- Interno. Recibir un corréu electrónicu de rebote y procesalu pa xestionar el receptor fallíu.
- categorytree
- Interno. Módulu internu pa la estensión CategoryTree.
- cirrus-check-sanity
- Interno. Informes sobre la exactitud de una serie de identificadores de páginas en el índice de búsqueda.
- 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. Solicitar un FancyCaptcha nuevu.
- jsondata
- Interno. Recuperar datos JSON llocalizaos.
- oathvalidate
- Interno. Validar un pase d'identificación de dos factores (OATH)
- parser-migration
- Interno. Analizar una páxina con dos configuraciones de tidy distintes.
- readinglists
- Interno. Reading list write operations.
- sanitize-mapdata
- Interno. Fai la convalidación de datos pa la estensión Kartographer
- scribunto-console
- Interno. Módulu internu pa dar serviciu a les solicitúes 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.
- timedtext
- Interno. Proporciona contenido de texto cronometrado para su uso por parte de elementos <track>
- ulslocalization
- Interno. Obtener la llocalización de ULS na llingua dada.
- ulssetlang
- Interno. Update user's preferred interface language.
- visualeditor
- Interno. Devuelve HTML5 pa una páxina dende'l serviciu Parsoid.
- visualeditoredit
- Interno. Guardar una páxina 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, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, 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, 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 formatu 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
El retrasu (lag) máximu puede utilizase cuando MediaWiki ta instaláu nun conxuntu de bases de datos replicaes. Pa evitar les aiciones que pudieran causar un retrasu entá mayor na replicación del sitiu, esti parámetru puede causar que'l cliente espere hasta que'l retrasu de replicación sía menor que'l valor especificáu. En casu de retrasu escesivu, devuélvese un códigu d'error maxlag con un mensaxe asemeyáu a Esperando a $host: $lag segundos de retrasu.
Ver Manual:Parámetru maxlag pa más información.- Tipo: entero
- smaxage
Establez l'encabezáu HTTP
s-maxage
de control de caché a esta cantidá de segundos. Los errores nunca se guarden na caché.- Tipo: entero
- The value must be no less than 0.
- Predeterminado: 0
- maxage
Establez l'encabezáu HTTP
max-age
de control de caché a esta cantidá de segundos. Los errores nunca se guarden na caché.- Tipo: entero
- The value must be no less than 0.
- Predeterminado: 0
- assert
Comprobar que l'usuariu tien sesión 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 nomáu.
- Tipu: usuariu, por cualquiera ente nome d'usuariu y Usuario temporal
- requestid
Cualquier valor dau equí va incluyise na respuesta. Puede utilizase pa estremar solicitúes.
- servedby
Incluyir el nome del host que sirvió la solicitú nes resultancies.
- Type: boolean (details)
- curtimestamp
Incluyir la marca de tiempu actual na resultancia.
- Type: boolean (details)
- responselanginfo
Incluye les llingües utilizaes pa uselang y errorlang nel resultáu.
- Type: boolean (details)
- origin
Cuando s'accede a la API usando una solicitú AJAX dende otru dominiu (CORS), establezse esti valor al dominiu d'orixe. Tien d'incluíse en cualquier solicitú pre-vuelu, y polo tanto ten de ser parte de la URI de la solicitú (non del cuerpu POST).
Nes solicitúes con autenticación, tien de coincidir exautamente con unu de los orixes de la cabecera
Origin
, polo que tendría de ser daqué como https://en.wikipedia.org o https://meta.wikimedia.org. Si esti parámetru nun coincide cola cabeceraOrigin
, va devolvese una respuesta 403. Si esti parámetru coincide cola cabeceraOrigin
y l'orixe ta na llista blanca, van crease les cabeceresAccess-Control-Allow-Origin
yAccess-Control-Allow-Credentials
.Nes solicitúes ensin autenticación, introduz el valor *. Esto va crear una cabecera
Access-Control-Allow-Origin
, pero'l valor deAccess-Control-Allow-Credentials
va serfalse
y tolos datos que dependan del usuariu tarán torgaos.- uselang
La llingua que va utilizase pa les traducciones de mensaxes. action=query&meta=siteinfo con siprop=languages devuelve una llista de códigos de llingua, o puedes introducir user pa usar la preferencia d'idioma del usuariu actual, o content pa usar l'idioma del conteníu d'esta wiki.
- Predeterminado: user
- variant
Variante del lenguaje. Solo funciona si el lenguaje original soporta conversión variante.
- errorformat
Formatu utilizáu 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 parámetros del mensaxe.
- none
- Nenguna salida de testu, solo los códigos d'error.
- bc
- Formatu emplegáu 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 emplegáu p'avisos y errores. action=query&meta=siteinfo con siprop=languages devuelve una llista de códigos d'idioma, o especifica content pa utilizar la llingua del conteníu d'esta wiki o uselang pa utilizar el mesmu valor del parámetru uselang.
- Predeterminado: uselang
- errorsuselocal
Si se da, los testos d'error emplegarán los mensaxes personalizaos llocalmente del espaciu de nomes MediaWiki.
- Type: boolean (details)
- centralauthtoken
Al tener accesu a la API usando una solicitú 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 solicitú CORS. Cada pase sólo puede usase una vegada, y espira después de 10 segundos. Esto tendría d'incluise'n toa solicitú pre-vuelu, y poro tendría d'incluise na URI de la solicitú (non nel cuerpu 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:
- 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/.