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/Special:MyLanguage/API:Main_page

Módulo principal

Estado: A API de MediaWiki é unha interface estable e consolidada que ten un mantemento activo e está en constante mellora. Aínda que intentamos evitalo, ocasionalmente precisamos facer cambios importantes que rompen a estrutura anterior; podes apuntarte á lista de discusión mediawiki-api-announce para recibires información 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 devolto quedarán definidos co mesmo valor. Para máis información, consulta API: Erros e avisos.

Parámetros específicos:
action

Que acción se realizará.

abusefiltercheckmatch
Verificar se un filtro de abusos coincide cun conxunto de variables, unha edición ou un evento rexistrado do rexistro de abusos.
abusefilterchecksyntax
Revisar a sintaxe dun filtro de abusos.
abusefilterevalexpression
Avalía unha expresión do filtro de abusos.
abusefilterunblockautopromote
Desbloquea a un usuario de recibir autopromocións debido a unha consecuencia do filtro de abusos.
abuselogprivatedetails
Ver detalles privados dunha entrada do rexistro de abusos.
acquiretempusername
Adquirir un nome de usuario temporal e almacenalo na sesión actual, se a creación de contas temporais está habilitada e o usuario actual non iniciou a sesión. Se xa se gardou un nome, devolve ese mesmo nome.
antispoof
Comprobar un nome de usuario coas comprobacións de normalización de AntiSpoof
block
Bloquear un usuario.
centralauthtoken
Obter un identificador central de autorización para facer unha petición autenticada a un wiki asociado.
centralnoticecdncacheupdatebanner
Solicitar a purga do contido do cartel almacenado na caché CDN (cliente) para os usuarios anónimos, para o cartel e o idioma solicitados
centralnoticechoicedata
Obter os datos necesarios para escoller un cartel para un proxecto e lingua dados
centralnoticequerycampaign
Obter todos os parámetros de configuración dunha campaña.
changeauthenticationdata
Cambiar os datos de autenticación do usuario actual.
changecontentmodel
Cambiar o modelo de contido dunha páxina
checktoken
Verificar a validez dun identificador de action=query&meta=tokens.
cirrus-config-dump
Volcado da configuración CirrusSearch.
cirrus-mapping-dump
Descarga do mapeamento de CirrusSearch para este wiki.
cirrus-profiles-dump
Cópia em ficheiro dos perfis do CirrusSearch para esta wiki.
cirrus-settings-dump
Descarga dos parámetros de CirrusSearch para este wiki.
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.
createlocalaccount
Forzar a creación dunha conta local. Debe existir unha conta central.
delete
Borrar a páxina.
deleteglobalaccount
Eliminar un usuario global.
discussiontoolsedit
Publicar uma mensagem numa página de discussão.
discussiontoolsfindcomment
Encontrar um comentário pelo seu identificador ou nome.
discussiontoolsgetsubscriptions
Obter o estado de subscrição dos tópicos especificados.
discussiontoolssubscribe
Subscrever (ou cancelar a subscrição) para receber notificações sobre um tópico.
echomarkread
Marcar notificacións coma lidas para o usuario actual.
echomarkseen
Marcar notificacións coma vistas para o usuario actual.
echomute
Silenciar ou remover o silenciamento de notificações originadas por certos utilizadores ou páginas.
edit
Crear e editar páxinas.
editmassmessagelist
Editar unha lista de entrega de mensaxes en masa.
emailuser
Enviar un correo electrónico a un usuario.
expandtemplates
Expandir tódolos modelos dentro do wikitexto.
featuredfeed
Retorna unha fonte de novas de contidos destacados
feedcontributions
Devolve a lista de contribucións dun usuario.
feedrecentchanges
Devolve un ficheiro de cambios recentes.
feedwatchlist
Devolve o fluxo dunha lista de vixilancia.
filerevert
Revertir o ficheiro a unha versión anterior.
globalblock
Bloquear ou desbloquear globalmente a un usuario.
globalpreferenceoverrides
Cambiar preferencias locais para a conta de usuario actual.
globalpreferences
Cambiar as preferencias da conta de usuario actual.
globaluserrights
Engadir/eliminar un usuario a/de grupos globais.
help
Amosar axuda para os módulos indicados.
imagerotate
Este módulo foi desactivado.
import
Importar unha páxina doutra wiki, ou dun ficheiro XML.
jsonconfig
Permite o acceso directo ó subsistema JsonConfig.
languagesearch
Procurar nomes de lingua en calquera script.
linkaccount
Vincular unha conta dun provedor externo ó usuario actual.
login
Iniciar sesión e obter as cookies de autenticación.
logout
Terminar e limpar os datos de sesión.
managetags
Realizar tarefas de xestión relacionadas coa modificación de etiquetas.
massmessage
Enviar unha mensaxe a unha lista de páxinas.
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).
setglobalaccountstatus
Agochar ou bloquear (ou amosar ou desbloquear) unha conta de usuario global.
setnotificationtimestamp
Actualizar a data e hora de notificación das páxinas vixiadas.
setpagelanguage
Cambiar a lingua dunha páxina.
shortenurl
Acurtar unha URL longa nunha máis curta.
sitematrix
Obter a lista dos sitios da Wikimedia.
spamblacklist
Validar um ou mais URL contra a lista de barramento de spam.
streamconfigs
Expõe a configuração da transmissão de eventos. Só devolve format=json com formatversion=2.
strikevote
Permite ós administradores anular ou restaurar un voto.
tag
Engadir ou eliminar etiquetas de cambio de revisións individuais ou entradas de rexistro.
templatedata
Obter os datos almacenador pola extensión TemplateData.
thank
Enviar unha notificación de agradecemento a un editor.
titleblacklist
Validar un título de páxina, ficheiro ou nome de usuario contra a lista negra de títulos.
torblock
Verificar se um endereço IP está bloqueado pelo Tor.
transcodereset
Usuarios co permiso 'transcode-reset' poden reiniciar e reexecutar un traballo transcode.
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 vixilancia do usuario actual.
webapp-manifest
Devolve un manifesto de aplicación web.
webauthn
Módulo da API para comunicação entre servidor e cliente durante o processo de registo e autenticação.
bouncehandler
Interno. Recibir un correo electrónico rexeitado e procesalo para xestionar o destinatario erróneo.
categorytree
Interno. Módulo interno para a extensión CategoryTree.
cirrus-check-sanity
Interno. Reports on the correctness of a range of page ids in the search index
collection
Interno. Módulo da API para realizar várias operações na coleção de um utilizador da wiki.
cspreport
Interno. 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.
discussiontoolscompare
Interno. Obter informações sobre alterações de comentários entre duas revisões de página.
discussiontoolspageinfo
Interno. Devolve os metadados necessários para inicializar as ferramentas de discussão.
discussiontoolspreview
Interno. Antever uma mensagem numa página de discussão.
editcheckreferenceurl
Interno. Check the status of a URL for use as a reference.
fancycaptchareload
Interno. Obter un novo FancyCaptcha.
jsondata
Interno. Recuperar os datos JSON localizados.
oathvalidate
Interno. Validar un pase de autenticación en dous factores (OATH)
parser-migration
Interno. Fazer a análise sintática de uma página com duas configurações diferentes.
readinglists
Interno. Operações de escrita das listas de leitura.
sanitize-mapdata
Interno. Realiza a validación dos datos para a extensión Kartographer
scribunto-console
Interno. Módulo interno para servir peticións XHR dende a consola Scribunto.
securepollauth
Interno. Allows a remote wiki to authenticate users before granting access to vote in the election.
stashedit
Interno. Preparar unha edición na caché compartida.
timedtext
Interno. Fornece conteúdo de legendas para ser usado por elementos <track>
ulslocalization
Interno. Obter a localización do ULS na lingua dada.
ulssetlang
Interno. Actualiza a lingua da interface preferida do usuario.
visualeditor
Interno. Devolve o código HTML5 para unha páxina do servizo Parsoid.
visualeditoredit
Interno. Gardar unha páxina HTML5 en MediaWiki (convertida en texto wiki mediante o servizo do Parsoid).
wikimediaeventsblockededit
Interno. Informações do registo sobre tentativas de edição bloqueadas
Un valor dos seguintes 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
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: número enteiro
smaxage

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

Tipo: número enteiro
O valor non debe ser inferior a 0.
Por defecto: 0
maxage

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

Tipo: número enteiro
O valor non debe ser inferior a 0.
Por defecto: 0
assert

Verificar que o usuario está conectado (incluíndo a posibilidade de que sexa unha conta temporal) se ten o valor user, non conectado se ten o valor anon ou ten dereitos de bot se ten o valor bot.

Un valor dos seguintes valores: anon, bot, user
assertuser

Verificar que o usuario actual é o usuario nomeado.

Tipo: usuario, por calquera de nome de usuario e Usuario temporal
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), inicialice 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 establecerse 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á permitida, as cabeceiras Access-Control-Allow-Origin e Access-Control-Allow-Credentials quedará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 dos usuarios quedarán ocultos.

uselang

Lingua a usar para a tradución de mensaxes. action=query&meta=siteinfo&siprop=languages devolve unha lista de códigos de lingua. Podes especificar user para usar a preferencia de lingua do usuario actual ou content para usar a lingua do contido deste wiki.

Por defecto: user
variant

Variante da lingua. Só funciona se a lingua base admite a conversión de variantes.

errorformat

Formato a usar para a saída de texto de avisos e de erros

plaintext
Texto wiki sen as etiquetas HTML e coas entidades substituídas.
wikitext
Texto wiki sen analizar.
html
HTML
raw
Clave e parámetros da mensaxe.
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: bc, html, none, plaintext, raw, wikitext
Por defecto: bc
errorlang

Lingua a usar para as advertencias e os erros. action=query&meta=siteinfo&siprop=languages devolve unha lista de códigos de lingua. Podes especificar content para utilizar a lingua do contido deste wiki ou uselang para utilizar o mesmo valor có 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)
centralauthtoken

Cando se accede á API usando unha petición AJAX desde outro dominio (CORS), use isto para autenticarse como o usuario SUL actual. Use action=centralauthtoken neste wiki para obter o identificador, antes de facer a petición CORS. Cada identificador só pode usarse unha vez e caduca aos 10 segundos. Isto debe incluírse en calquera petición de esbozo, e por iso debe incluírse na URI da petición (non no corpo POST).

Permisos:
writeapi
Usar a API para modificar o wiki
Concedidas a: all, user e bot
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 de MediaWiki debería ser UTF-8 normalizada por NFC. MediaWiki pode intentar converter outras entradas, pero isto pode provocar que fallen algunhas operacións (como editar coas comprobacións MD5).

Os parámetros que toman varios valores envíanse normalmente cos valores separados mediante un carácter de barra vertical; por exemplo, param=value1|value2 ou param=value1%7Cvalue2. Se un valor debe conter unha barra vertical, usa U+001F (o separador de unidades) como separador e engade o prefixo U+001F ao valor; por exemplo, param=%1Fvalue1%1Fvalue2.

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

boolean

Os parámetros booleanos funcionan como as caixas de verificación HTML: se se especifica o parámetro, independentemente do seu valor, considérase verdadeiro. Para un valor falso, omite o parámetro por completo.

expiry

Os tempos de caducidade poden ser relativos (por exemplo, 5 months ou 2 weeks) ou absolutos (por exemplo, 2014-09-18T12:34:56Z). Para que non caduque, usa infinite, indefinite, infinity ou never.

timestamp

As marcas de tempo poden especificarse en varios formatos, consulta os formatos de entrada da biblioteca de marcas de tempo documentados en mediawiki.org para obter máis información. Recoméndase a data e hora ISO 8601: 2001-01-15T14:56:00Z. Ademais, a cadea now pódese usar para especificar a marca de tempo actual.

Parámetros modelados

Os parámetros modelados admiten casos nos que un módulo da API necesita un valor para cada valor dalgún outro parámetro. Por exemplo, se houbese un módulo da API para solicitar froita, podería ter un parámetro froitas para especificar que froitas se están solicitando e un parámetro modelado {froita}-cantidade para especificar cantas froitas de cada queres solicitar. Un cliente da API que queira 1 mazá, 5 plátanos e 20 amorodos podería facer unha solicitude como froitas=mazás|plátanos|amorodos&mazás-cantidade=1&plátanos-cantidade=5&amorodos-cantidade=20.

Créditos

Desenvolvedores da API:

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

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