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.
- 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.
- block
- Bloquiar a un usuariu.
- 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.
- clearhasmsg
- Llimpia la marca
hasmsgdel 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.
- delete
- Desaniciar una páxina.
- edit
- Crear y editar páginas.
- emailuser
- Unviar un corréu electrónicu a un usuariu.
- 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.
- 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).
- 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.
- 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 de la wiki.
- watch
- Añadir o borrar páginas de la lista de seguimiento del usuario actual.
- 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.
- stashedit
- Interno. Prepare an edit in shared cache.
- Uno de los siguientes valores: acquiretempusername, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, stashedit
- 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-maxagede control de caché a esta cantidá de segundos. Los errores nunca se guarden na caché.- Tipo: entero
- El valor debe ser no menor de 0.
- Predeterminado: 0
- maxage
Establez l'encabezáu HTTP
max-agede control de caché a esta cantidá de segundos. Los errores nunca se guarden na caché.- Tipo: entero
- El valor debe ser no menor de 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.
- Tipo: boolean (más información)
- curtimestamp
Incluyir la marca de tiempu actual na resultancia.
- Tipo: boolean (más información)
- responselanginfo
Incluye les llingües utilizaes pa uselang y errorlang nel resultáu.
- Tipo: boolean (más información)
- 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 cabeceraOriginy l'orixe ta na llista blanca, van crease les cabeceresAccess-Control-Allow-OriginyAccess-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-Credentialsva serfalsey tolos datos que dependan del usuariu tarán torgaos.- crossorigin
Al acceder a la API mediante una solicitud AJAX entre dominios (CORS) y un proveedor de sesiones seguro contra ataques de falsificación de solicitudes entre sitios (CSRF) (como OAuth), utilice este parámetro en lugar de
origen=*para autenticar la solicitud (es decir, evitar el cierre de sesión). Este parámetro debe incluirse en cualquier solicitud pre-flight y, por lo tanto, debe formar parte de la URI de la solicitud (no del cuerpo POST).Tenga en cuenta que la mayoría de los proveedores de sesiones, incluidas las sesiones estándar basadas en cookies, no admiten CORS autenticado y no pueden utilizarse con este parámetro.
- Tipo: boolean (más información)
- 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 idioma. Solo funciona si el idioma original soporta variantes de conversión.
- 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
- 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 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.
- Tipo: boolean (más información)
- 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 mediawiki-api@lists.wikimedia.org o informa de un error en https://phabricator.wikimedia.org/.