Axuda da API de MediaWiki

Esta é unha páxina de documentación da API de MediaWiki xerada automaticamente.

Documentación e exemplos: https://www.mediawiki.org/wiki/API

Módulo principal

Estado: Tódalas funcionalidades mostradas nesta páxina deberían estar funcionanado, pero a API aínda está desenrolo, e pode ser modificada en calquera momento. Apúntese na lista de discusión mediawiki-api-announce para estar informado acerca das actualizacións.

Solicitudes incorrectas: Cando se envían solicitudes incorrectas á API, envíase unha cabeceira HTTP coa chave "MediaWiki-API-Error" e, a seguir, tanto o valor da cabeceira como o código de erro retornado serán definidos co mesmo valor. Para máis información, consulte API: Erros e avisos.

Test: Para facilitar as probas das peticións da API, consulte Special:ApiSandbox.

Parámetros:
action

Que acción se realizará.

block
Bloquear un usuario.
changeauthenticationdata
Cambiar os datos de autenticación do usuario actual.
checktoken
Verificar a validez dun identificador de action=query&meta=tokens.
clearhasmsg
Limpar a bandeira hasmsg para o usuario actual
clientlogin
Conectarse á wiki usando o fluxo interactivo.
compare
Obter as diferencias entre dúas páxinas.
createaccount
Crear unha nova conta de usuario.
cspreport
Usado polos navegadores para informar de violacións da política de confidencialidade de contido. Este módulo non debe se usado nunca, excepto cando é usado automaticamente por un navegador web compatible con CSP.
delete
Borrar a páxina.
edit
Crear e editar páxinas.
emailuser
Enviar un correo electrónico a un usuario.
expandtemplates
Expandir tódolos modelos dentro do wikitexto.
feedcontributions
Devolve a lista de contribucións dun usuario.
feedrecentchanges
Devolve un ficheiro de cambios recentes.
feedwatchlist
Devolve o fluxo dunha lista de vixiancia.
filerevert
Revertir o ficheiro a unha versión anterior.
help
Mostrar axuda para os módulos indicados.
imagerotate
Xirar unha ou máis imaxes.
import
Importar unha páxina doutra wiki, ou dun ficheiro XML.
linkaccount
Vincular unha conta dun provedor externo ó usuario actual.
login
Iniciar sesión e obter as cookies de autenticación.
logout
Terminar e limpar datos de sesión.
managetags
Realizar tarefas de xestión relacionadas coa modificación de etiquetas.
mergehistory
Fusionar os historiais das páxinas.
move
Mover unha páxina.
opensearch
Buscar no wiki mediante o protocolo OpenSearch.
options
Cambiar as preferencias do usuario actual.
paraminfo
Obter información sobre módulos API.
parse
Fai a análise sintáctica do contido e devolve o resultado da análise.
patrol
Patrullar unha páxina ou edición.
protect
Cambiar o nivel de protección dunha páxina.
purge
Borrar a caché para os títulos indicados.
query
Consultar datos de e sobre MediaWiki.
removeauthenticationdata
Elimina os datos de autenticación do usuario actual.
resetpassword
Envía un correo de inicialización de contrasinal a un usuario.
revisiondelete
Borrar e restaurar revisións.
rollback
Desfacer a última edición da páxina.
rsd
Exportar un esquema RSD (Really Simple Discovery, Descubrimento Moi Simple).
setnotificationtimestamp
Actualizar a data e hora de notificación das páxinas vixiadas.
setpagelanguage
Cambiar a lingua dunha páxina.
stashedit
Preparar unha edición na caché compartida.
tag
Engadir ou eliminar etiquetas de cambio de revisións individuais ou entradas de rexistro.
unblock
Desbloquear un usuario.
undelete
Restaurar modificacións dunha páxina borrada.
unlinkaccount
Elimina unha conta vinculada do usuario actual.
upload
Subir un ficheiro, ou obter o estado das subas pendentes.
userrights
Cambiar a pertencia dun usuario a un grupo.
validatepassword
Valida un contrasinal contra as políticas de contrasinais da wiki.
watch
Engadir ou borrar páxinas da lista de vixiancia do usuario actual.
tokens
Obsoleto. Obter os identificadores para accións de modificación de datos.
Un valor dos seguintes valores: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, 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, stashedit, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens
Por defecto: help
format

O formato de saída.

json
Datos de saída en formato JSON.
jsonfm
Datos de saída en formato JSON(impresión en HTML).
none
Ningunha saída.
php
Datos de saída en formato serializado de PHP.
phpfm
Datos de saída en formato serializado de PHP(impresión en HTML).
rawfm
Datos de saída, incluíndo os elementos de depuración, en formato JSON (impresión en HTML).
xml
Datos de saída en formato XML.
xmlfm
Datos de saída en formato XML(impresión en HTML).
Un valor dos seguintes valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Por defecto: jsonfm
maxlag

O retardo máximo pode usarse cando MediaWiki está instalada nun cluster de base de datos replicadas. Para gardar accións que causen calquera retardo máis de replicación do sitio, este parámetro pode facer que o cliente espere ata que o retardo de replicación sexa menor que o valor especificado. No caso de retardo excesivo, é devolto o código de erro maxlag cunha mensaxe como esperando por $host: $lag segundos de retardo.
Para máis información, ver Manual: Maxlag parameter.

Tipo: enteiro
smaxage

Fixar a cabeceira HTTP de control de caché s-maxage a esos segundos. Os erros nunca se gardan na caché.

Tipo: enteiro
Por defecto: 0
maxage

Fixar a cabeceira HTTP de control de caché max-age a esos segundos. Os erros nunca se gardan na caché.

Tipo: enteiro
Por defecto: 0
assert

Verificar se o usuario está conectado como usuario ou ten a marca de bot.

Un valor dos seguintes valores: user, bot
assertuser

Verificar que o usuario actual é o usuario nomeado.

Tipo: nome de usuario
requestid

Calquera valor dado aquí será incluído na resposta. Pode usarse para distingir peticións.

servedby

Inclúa o nome do servidor que servía a solicitude nos resultados.

Tipo: booleano (detalles)
curtimestamp

Incluir a marca de tempo actual no resultado.

Tipo: booleano (detalles)
responselanginfo

Incluír no resultado as linguas usada para uselang e errorlang.

Tipo: booleano (detalles)
origin

Cando se accede á API usando unha petición AJAX entre-dominios (CORS), inicializar o parámetro co dominio orixe. Isto debe incluírse en calquera petición pre-flight, e polo tanto debe ser parte da petición URI (non do corpo POST). Para peticións autenticadas, isto debe coincidir exactamente cunha das orixes na cabeceira Origin, polo que ten que ser fixado a algo como https://en.wikipedia.org ou https://meta.wikimedia.org. Se este parámetro non coincide coa cabeceira Origin, devolverase unha resposta 403. Se este parámetro coincide coa cabeceira Origin e a orixe está na lista branca, as cabeceiras Access-Control-Allow-Origin e Access-Control-Allow-Credentials serán fixadas.

Para peticións non autenticadas, especifique o valor *. Isto fará que se fixe a cabeceira Access-Control-Allow-Origin, pero Access-Control-Allow-Credentials será false e todos os datos específicos do usuario serán ocultados.

uselang

Linga a usar para a tradución de mensaxes. action=query&meta=siteinfo con siprop=languages devolve unha lista de códigos de lingua, ou especificando user coa preferencia de lingua do usuario actual, ou especificando content para usar a lingua do contido desta wiki.

Por defecto: user
errorformat

Formato a usar para a saída do texto de aviso e de erroː

plaintext
texto wiki sen as etiquetas HTML e coas entidades substituídas.
wikitext
texto wiki sen analizar.
html
HTML.
raw
Clave de mensaxe e parámetros.
none
Sen saída de texto, só os códigos de erro.
bc
Formato utilizado antes de MediaWiki 1.29. errorlang e errorsuselocal non se teñen en conta.
Un valor dos seguintes valores: plaintext, wikitext, html, raw, none, bc
Por defecto: bc
errorlang

Lingua usada para advertencias e erros. action=query&meta=siteinfo con siprop=languages devolve unha lista de códigos de lingua. Pode especificar content para utilizar a lingua do contido deste wiki ou uselang para utilizar o mesmo valor que o do parámetro uselang.

Por defecto: uselang
errorsuselocal

Se se indica, os textos de erro empregarán mensaxes adaptadas á lingua do espazo de nomes MediaWiki.

Tipo: booleano (detalles)
Permisos:
writeapi
Usar a API para modificar o wiki
Concedidas a: all, user, bot e editores
apihighlimits
Usar os valores superiores das consultas da API (consultas lentas: 500; consultas rápidas: 5000). Os límites para as consultas lentas tamén se aplican ós parámetros multivaluados.
Concedidas a: bot e sysop

Tipos de datos

A entrada a MediaWiki debe ser normalizada NFC UTF-8. MediaWiki puede intentar converter outras entradas, pero isto pode provocar que algunhas operacións (como as edición con comprobación MD5) fallen.

Algúns tipos de parámetros nas solicitudes de API necesitan máis explicación:

boolean
Os parámetros booleanos traballan como caixas de verificación HTML: se o parámetro se especifica, independentemente do seu valor, considérase verdadeiro. Para un valor falso, omíta o parámetro completo.
timestamp
Os selos de tempo poden especificarse en varios formatos. Recoméndase o ISO 8601 coa data e a hora. Todas as horas están en UTC, a inclusión da zona horaria é ignorada.
  • ISO 8601 con data e hora, 2001-01-15T14:56:00Z (signos de puntuación e Z son opcionais)
  • ISO 8601 data e hora (omítense) fraccións de segundo, 2001-01-15T14:56:00.00001Z (guións, dous puntos e, Z son opcionais)
  • Formato MediaWiki, 20010115145600
  • Formato numérico xenérico, 2001-01-15 14:56:00 (opcional na zona horaria GMT, +##, o -## omítese)
  • Formato EXIF, 2001:01:15 14:56:00
  • Formato RFC 2822 (a zona horaria pódese omitir), Mon, 15 Xan 2001 14:56:00
  • Formato RFC 850 (a zona horaria pódese omitir), luns, 15-xaneiro-2001 14:56:00
  • Formato C ctime, luns xaneiro 15 14:56:00 de 2001
  • Segundos desde 1970-01-01T00:00:00Z como de 1 a 13, díxitos enteiros (excluíndo o 0)
  • O texto now (agora)

Créditos

Desenvolvedores da API:

  • Roan Kattouw (desenvolvedor principal, set. 2007-2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (creador e desenvolvedor principal, set. 2006-sep. 2007)
  • Brad Jorsch (desenvolvedor principal, 2013-actualidade)

Envía comentarios, suxerencias e preguntas a mediawiki-api@lists.wikimedia.org ou informa dun erro en https://phabricator.wikimedia.org/.