Adjuta sur le API de MediaWiki

Iste es un pagina de documentation generate automaticamente sur le API de MediaWiki.

Documentation e exemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Modulo principal

Stato: Le API de MediaWiki es un interfacie matur e stabile que es activemente supportate e meliorate. Ben que nos tenta de evitar lo, es occasionalmente necessari apportar modificationes disruptive. Subscribe te al lista de diffusion mediawiki-api-announce pro esser informate de actualisationes.

Requestas erronee: Quando requestas erronee se invia al API, un capite HTTP essera inviate con le clave "MediaWiki-API-Error". Le valor de iste capite e le codice de error reinviate essera identic. Pro plus information vide API: Errores e avisos.

Parametros specific:
action

Qual action exequer.

acquiretempusername
Acquirer un nomine de usator temporari e memorar lo in le session actual, si le creation de contos temporari es activate e le usator actual non es in session. Si un nomine ha ja essite memorate, isto restitue le mesme nomine.
block
Blocar un usator.
changeauthenticationdata
Cambiar le datos de authentication pro le usator actual.
changecontentmodel
Cambiar le modello de contento de un pagina
checktoken
Verificar le validitate de un token ab action=query&meta=tokens.
clearhasmsg
Cancella le signal hasmsg pro le usator actual.
clientlogin
Aperir session in le wiki usante le fluxo interactive.
compare
Obtener le differentia inter duo paginas.
createaccount
Crear un nove conto de usator.
delete
Deler un pagina.
edit
Crear e modificar paginas.
emailuser
Inviar e-mail a un usator.
expandtemplates
Expande tote le patronos in le wikitexto.
feedcontributions
Restitue le fluxo de contributiones de un usator.
feedrecentchanges
Restitue un fluxo de cambiamentos recente.
feedwatchlist
Restitue un fluxo de observatorio.
filerevert
Reverter un file a un version ancian.
help
Monstrar adjuta pro le modulos specificate.
imagerotate
Rotar un o plure imagines.
import
Importar un pagina de un altere wiki, o de un file XML.
linkaccount
Ligar un conto de un fornitor tertie al usator actual.
login
Aperir session e obtener cookies de authentication.
logout
Clauder session e rader datos de session.
managetags
Executar cargas de gestion concernente le etiquettas de modification.
mergehistory
Fusionar historias de paginas.
move
Renominar un pagina.
opensearch
Cercar in le wiki usante le protocollo OpenSearch.
options
Cambiar le preferentias del usator actual.
paraminfo
Obtener information sur modulos API.
parse
Analysa le syntaxe del contento e restitue le sortita del analysator syntactic.
patrol
Patruliar un pagina o un version.
protect
Cambiar le nivello de protection de un pagina.
purge
Purgar le cache pro le titulos date.
query
Obtener datos desde e concernente MediaWiki.
removeauthenticationdata
Remover le datos de authentication pro le usator actual.
resetpassword
Inviar un message de e-mail pro reinitialisar le contrasigno a un usator.
revisiondelete
Deler e restaurar versiones.
rollback
Disfacer le ultime modification del pagina.
rsd
Exportar un schema RSD (Really Simple Discovery, discoperta multo simple).
setnotificationtimestamp
Actualisar le data e hora de notification pro paginas sub observation.
setpagelanguage
Cambiar le lingua de un pagina.
tag
Adder o remover etiquettas de cambiamento de versiones individual o entratas de registro.
unblock
Disblocar un usator.
undelete
Restaurar versiones de un pagina delite.
unlinkaccount
Remover un conto de tertio ligate del usator actual.
upload
Incargar un file, o obtener le stato del incargamentos pendente.
userrights
Cambiar le membrato de gruppo de un usator.
validatepassword
Validar un contrasigno contra le politicas de contrasigno del wiki.
watch
Adder paginas al, o remover paginas del observatorio del usator actual.
cspreport
Interne. Usate per navigatores pro reportar violationes del Politica de Securitate de Contento. Iste modulo non debe esser usate, excepte quando usate automaticamente per un navigator web conforme a CSP.
stashedit
Interne. Preparar un modification in cache condividite.
Un del sequente 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
Predefinite: help
format

Le formato del resultato.

json
Generar datos in formato JSON.
jsonfm
Generar datos in formato JSON (con coloration syntactic in HTML).
none
Non producer sortita.
php
Generar datos in formato PHP serialisate.
phpfm
Generar datos in formato PHP serialisate (con coloration syntactic in HTML).
rawfm
Generar datos, includente le elementos de debugging, in formato JSON (con coloration syntactic in HTML).
xml
Generator datos in formato XML.
xmlfm
Generar datos in formato XML (con coloration syntactic in HTML).
Un del sequente valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Predefinite: jsonfm
maxlag

Le latentia maximal pote esser usate quando MediaWiki es installate in un cluster de base de datos replicate. Pro evitar actiones que causa additional latentia de replication de sito, iste parametro pote facer le cliente attender usque le latentia de replication es minus que le valor specificate. In caso de latentia excessive, le codice de error maxlag es retornate con un message como Attende $host: $lag secundas de latentia.
Vide Manual: Maxlag parameter pro plus information.

Typo: numero integre
smaxage

Fixar le capite de controlo de cache HTTP s-maxage a iste numero de secundas. Errores nunquam es mittite in cache.

Typo: numero integre
Le valor non debe esser minus de 0.
Predefinite: 0
maxage

Fixar le capite de controlo de cache HTTP max-age a iste numero de secundas. Errores nunquam es mittite in cache.

Typo: numero integre
Le valor non debe esser minus de 0.
Predefinite: 0
assert

Verificar que le usator ha aperite session (pote esser como usator temporari) si le valor es user, o que non ha aperite session si le valor es anon, o que ha le derecto de usator robot si le valor es bot.

Un del sequente valores: anon, bot, user
assertuser

Verificar que le usator currente es le usator nominate.

Typo: usator, per un de nomine de usator e Usator temporari
requestid

Omne valor fornite hic essera includite in le responsa. Pote esser usate pro distinguer requestas.

servedby

Includer in le resultato le nomine del host que ha servite le requesta.

Typo: booleano (detalios)
curtimestamp

Includer le data e hora actual in le resultato.

Typo: booleano (detalios)
responselanginfo

Includer le linguas usate pro uselang e errorlang in le resultato.

Typo: booleano (detalios)
origin

Quando se accede al API usante un requesta AJAX inter-dominios (CORS), mitte le dominio de origine in iste parametro. Illo debe esser includite in omne requesta pre-flight, e dunque debe facer parte del URI del requesta (e non del corpore POST).

Pro requestas authenticate, isto debe corresponder exactemente a un del origines in le capite Origin, dunque debe esser mittite a qualcosa como http://ia.wikipedia.org o https://meta.wikimedia.org. Si iste parametro non corresponde al capite Origin, un responsa 403 essera retornate. Si iste parametro corresponde al capite Origin e le origine es permittite, le capites Access-Control-Allow-Origin e Access-Control-Allow-Credentials essera inserite.

Pro requestas non authenticate, specifica le valor *. Isto causara le insertion del capite Access-Control-Allow-Origin, ma Access-Control-Allow-Credentials essera mittite a false e tote le datos specific al usator essera restringite.

crossorigin

Quando se accede al API usante un requesta AJAX inter dominios (CORS) e usante un fornitor de sessiones que es secur contra le falsification de requestas inter sitos (CSRF) (como OAuth), usa isto in loco de origin=* pro rende le requesta authenticate (i.e., con session aperte). Isto debe esser includite in omne requesta preparatori, e dunque debe facer parte del URI del requesta (e non del corpore POST).

Nota que le major parte del fornitores de sessiones, includente le sessiones normal a base de cookies, non supporta le CORS authenticate e non pote esser usate con iste parametro.

Typo: booleano (detalios)
uselang

Lingua a usar pro traductiones de messages action=query&meta=siteinfo&siprop=languages retorna un lista de codices de lingua. Tu pote specificar user pro usar le preferentia de lingua del usator actual o content pro usar le lingua de contento de iste wiki.

Predefinite: user
variant

Variante del lingua. Functiona solmente si le lingua de base supporta le conversion de variantes.

errorformat

Le formato a usar pro le texto de avisos e errores

plaintext
Wikitexto con etiquettas HTML removite e entitates reimplaciate.
wikitext
Wikitexto brute.
html
HTML
raw
Clave e parametros del message.
none
Non producer texto, solmente le codices de error.
bc
Formato usate ante MediaWiki 1.29. errorlang e errorsuselocal es ignorate.
Un del sequente valores: bc, html, none, plaintext, raw, wikitext
Predefinite: bc
errorlang

Lingua a usar pro avisos e errores. action=query&meta=siteinfo&siprop=languages retorna un lista de codices de lingua. Specifica content pro usar le lingua de contento de iste wiki o uselang pro usar le valor del parametro uselang.

Predefinite: uselang
errorsuselocal

Si fornite, le textos de error usa le messages localmente personalisate del spatio de nomines MediaWiki.

Typo: booleano (detalios)
Exemplos:
Adjuta pro le modulo principal.
api.php?action=help [aperir in sabliera]
Tote le adjuta in un pagina.
api.php?action=help&recursivesubmodules=1 [aperir in sabliera]
Permission:
apihighlimits
Usa limites plus alte in requestas API (requestas lente: 500; requestas rapide: 5000). Le limites pro requestas lente tamben se applica a parametros de valores multiple.
Concedite a: bot e sysop

Typos de datos

Le entrata de texto in MediaWiki debe esser codificate in UTF-8 in forma normalisate canonic precomposite (NFC). MediaWiki pote tentar converter altere entrata, ma isto pote causar le fallimento de certe operationes (como modificationes con verificationes MD5).

Le parametros que prende valores multiple es normalmente submitte con lor valores separate con le character de barra vertical, p.ex. param=valor1|valor2 o param=valor1%7Cvalor2. Si un valor debe continer le character de barra vertical, usa U+001F (separator de unitate) como le separator e prefixa le valor con U+001F, p.ex. param=%1Fvalor1%1Fvalor2.

Alcun typos de parametro in requestas API require ulterior explication:

boolean

Le parametros boolean functiona como quadratos de selection HTML: si le parametro es specificate, independentemente del valor, illo es considerate como ver. Pro un valor false, omitte totalmente le parametro.

expiry

Valores de expiration pote esser relative (p.ex. 5 months (5 menses) o 2 weeks (2 septimanas)) o absolute (p.ex. 2014-09-18T12:34:56Z). Pro non haber alcun expiration, usa infinite, indefinite, infinity (infinitate) o never (nunquam).

timestamp

Le datas e horas pote esser specificate in varie formatos, vide le formatos de entrata del bibliotheca Timestamp documentate sur mediawiki.org pro detalios. Un data e hora ISO 8601 es recommendate: 2001-01-15T14:56:00Z. In ultra, le catena now (ora) pote esser usate pro specificar le data e hora currente.

Parametros de patrono

Le parametros de patrono supporta casos ubi un modulo API ha besonio de un valor pro cata valor de un altere parametro. Per exemplo, si il habeva un modulo API pro requestar fructos, illo poterea haber un parametro fructos pro specificar qual fructos es requestate e un parametro de patrono {fructo}-quantitate pro specificar quantes de cata fructo requestar. Un cliente API que vole 1 pomo, 5 bananas, e 20 fragas poterea alora facer un requesta como fructos=pomos|bananas|fragas&pomos-quantitate=1&bananas-quantitate=5&fragas-quantitate=20.

Creditos

Programmatores del API:

  • Yuri Astrakhan (creator, programmator dirigente Sept. 2006–Sept. 2007)
  • Roan Kattouw (programmator dirigente Sept. 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (programmator dirigente 2013–2020)

Invia tu commentos, suggestiones e questiones a mediawiki-api@lists.wikimedia.org o insere un reportage de bug a https://phabricator.wikimedia.org/.