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
- Fonte: MediaWiki
- Licentia: GPL-2.0-or-later
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.
Tests: Pro facilitar le test de requestas API, vide Special:ApiSandbox.
- action
Qual action exequer.
- abusefiltercheckmatch
- Verificar si un filtro anti-abuso corresponde a un insimul de variabiles (un redactor registrava un evento AbuseFilter).
- abusefilterchecksyntax
- Verificar le syntaxe de un filtro anti-abuso.
- abusefilterevalexpression
- Evaluta un expression de filtro anti-abuso.
- abusefilterunblockautopromote
- Permitte que un usator recipe autopromotiones a causa de un consequentia de filtro anti-abuso.
- abuselogprivatedetails
- Vider le detalios private de un entrata del registro de abusos.
- 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.
- antispoof
- Verificar un nomine de usator contra le normas de AntiSpoof.
- block
- Blocar un usator.
- centralauthtoken
- Obtener un token "centralauthtoken" pro inviar un requesta authenticate a un wiki attachate.
- centralnoticecdncacheupdatebanner
- Requestar le purga de contento de bandieras immagazinate in le CDN (cliente) pro usatores anonyme, pro le bandiera e lingua requestate
- centralnoticechoicedata
- Obtener datos necessari pro seliger un bandiera pro un projecto e lingua date
- centralnoticequerycampaign
- Obtener tote le parametros de configuration pro un campania.
- 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.
- communityconfigurationedit
- Change the content of a configuration provider in Community configuration
- compare
- Obtener le differentia inter duo paginas.
- createaccount
- Crear un nove conto de usator.
- createlocalaccount
- Fortiar le creation de un conto local. Le conto central debe exister.
- delete
- Deler un pagina.
- deleteglobalaccount
- Deler un usator global.
- discussiontoolsedit
- Publicar un message sur un pagina de discussion.
- discussiontoolsfindcomment
- Cercar un commento per su ID o nomine.
- discussiontoolsgetsubscriptions
- Obtener le statos de subscription de topicos date.
- discussiontoolssubscribe
- Subscriber (o cancellar subscription) pro reciper notificationes sur un topico.
- discussiontoolsthank
- Inviar un notification public de regratiamento pro un commento.
- echocreateevent
- Activar manualmente le invio de un notification a un usator
- echomarkread
- Marcar notificationes como legite pro le usator actual.
- echomarkseen
- Marcar notificationes como vidite pro le usator actual.
- echomute
- Silentiar o non plus silentiar notificationes de certe usatores o paginas.
- edit
- Crear e modificar paginas.
- editmassmessagelist
- Modificar un lista de livration de messages in massa.
- emailuser
- Inviar e-mail a un usator.
- expandtemplates
- Expande tote le patronos in le wikitexto.
- featuredfeed
- Retorna un fluxo de contento mittite in evidentia.
- 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.
- globalblock
- Blocar o disblocar globalmente un usator.
- globalpreferenceoverrides
- Cambiar le valores de reimplaciamento local pro preferentias global pro le usator actual.
- globalpreferences
- Cambiar le preferentias global del usator actual.
- globaluserrights
- Adder/remover un usator a/de gruppos global.
- help
- Monstrar adjuta pro le modulos specificate.
- imagerotate
- Iste modulo ha essite disactivate.
- import
- Importar un pagina de un altere wiki, o de un file XML.
- jsonconfig
- Permitte le accesso directe al subsystema JsonConfig.
- languagesearch
- Cercar nomines de lingua in non importa qual systema de scriptura.
- 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.
- massmessage
- Inviar un message a un lista de paginas.
- 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).
- setglobalaccountstatus
- Celar o serrar (o revelar o disserrar) un conto de usator global.
- setnotificationtimestamp
- Actualisar le data e hora de notification pro paginas sub observation.
- setpagelanguage
- Cambiar le lingua de un pagina.
- shortenurl
- Reducer un URL longe in un plus curte.
- sitematrix
- Obtener le lista del sitos de Wikimedia.
- spamblacklist
- Validar un o plure URLs contra le lista de blocage de spam.
- streamconfigs
- Expone le configuration del fluxo de eventos. Restitue solmente format=json con formatversion=2.
- strikevote
- Permitte al administratores de annullar o de restaurar un voto.
- tag
- Adder o remover etiquettas de cambiamento de versiones individual o entratas de registro.
- templatedata
- Recuperar datos immagazinate per le extension TemplateData.
- thank
- Inviar un notification de regratiamento a un contributor.
- titleblacklist
- Validar un titulo de pagina, nomine de file, o nomine de usator contra le lista de titulos prohibite.
- torblock
- Verificar si un adresse IP es blocate como un nodo de exito de Tor.
- transcodereset
- Usatores con le derecto 'transcode-reset' pote reinitialisar e re-executar un travalio de transcodification.
- 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.
- webapp-manifest
- Retorna un manifesto de application web.
- webauthn
- Modulo API pro communicar inter le servitor e le cliente durante le processo de registration/authentication.
- bouncehandler
- Interne. Reciper un message retrosaltate e processar lo pro gerer le destinatario fallite.
- categorytree
- Interne. Modulo interne pro le extension CategoryTree.
- cirrus-check-sanity
- Interne. Reporta le correctessa de un intervallo de IDs de pagina in le indice de recerca
- cirrus-config-dump
- Interne. Copia del configuration CirrusSearch.
- cirrus-mapping-dump
- Interne. Copia del mappatura de CirrusSearch pro iste wiki.
- cirrus-profiles-dump
- Interne. Copia del profilos de CirrusSearch pro iste wiki.
- cirrus-settings-dump
- Interne. Copia del parametros de CirrusSearch pro iste wiki.
- collection
- Interne. Modulo API pro exequer varie operationes sur le collection de un usator del wiki.
- 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.
- discussiontoolscompare
- Interne. Obtener information sur le cambios de commento inter duo versiones de un pagina.
- discussiontoolspageinfo
- Interne. Retorna metadatos requirite pro initialisar le instrumentos de discussion.
- discussiontoolspreview
- Interne. Previsualisar un message sur un pagina de discussion.
- editcheckreferenceurl
- Interne. Check the status of a URL for use as a reference.
- fancycaptchareload
- Interne. Obtener un nove FancyCaptcha.
- jsondata
- Interne. Recuperar datos JSON localisate.
- oathvalidate
- Interne. Validar un clave de authentication bifactorial (OATH).
- parser-migration
- Interne. Analysar le syntaxe de un pagina con duo configurationes differente del analysator syntactic.
- readinglists
- Interne. Operationes de scriptura de listas de lectura.
- sanitize-mapdata
- Interne. Exeque le validation de datos pro le extension Kartographer
- scribunto-console
- Interne. Modulo interne pro responder a requestas XHR ab le consola Scribunto.
- securepollauth
- Interne. Permitte que un wiki distante authentica usatores ante de conceder accesso pro votar in le election.
- stashedit
- Interne. Preparar un modification in cache condividite.
- timedtext
- Interne. Forni texto chronometrate pro usar in elementos <track>
- ulslocalization
- Interne. Obtener le localisation de ULS in le lingua specificate.
- ulssetlang
- Interne. Actualisar le lingua de interfacie preferite del usator.
- visualeditor
- Interne. Retorna HTML5 pro un pagina ab le servicio Parsoid.
- visualeditoredit
- Interne. Salveguardar un pagina HTML5 in MediaWiki (convertite in wikitexto per le servicio Parsoid).
- wikimediaeventsblockededit
- Interne. Registra information sur tentativas de modification blocate.
- Un del sequente valores: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, 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, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, collection, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, fancycaptchareload, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit
- 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 https://meta.wikimedia.org. Si iste parametro non corresponde al capiteOrigin
, un responsa 403 essera retornate. Si iste parametro corresponde al capiteOrigin
e le origine es permittite, le capitesAccess-Control-Allow-Origin
eAccess-Control-Allow-Credentials
essera inserite.Pro requestas non authenticate, specifica le valor *. Isto causara le insertion del capite
Access-Control-Allow-Origin
, maAccess-Control-Allow-Credentials
essera mittite afalse
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)
- centralauthtoken
Quando tu accede al API con un requesta AJAX inter dominios (CORS), usa isto pro authenticar te como le usator SUL actual. Usa action=centralauthtoken sur iste wiki pro obtener le token ante de facer le requesta CORS. Cata token pote solmente esser usate un vice e expira post 10 secundas. Isto debe esser includite in omne requesta pre-volo, e dunque debe esser includite in le URI del requesta (non in le corpore POST).
- 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]
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 [email protected] o insere un reportage de bug a https://phabricator.wikimedia.org/.