MediaWiki API ajuda
Esta es una pàgina de documentació autogenerada de l'API de MediaWiki.
Documentació i eixemples: https://www.mediawiki.org/wiki/API
Módul principal
- Font: MediaWiki
- Llicència: GPL-2.0-or-later
Estat: La API de MediaWiki és una interfaç madura i estable que es millora i prova activament. Encara que tractem d'evitar-ho, és possible que ocasionalment degam fer canvis importants. Subscriu-te a la llista de correu mediawiki-api-announce per a rebre avisos d'actualisacions.
Solicituts errònees: Quan s'envien solicituts errònees a la API, s'enviarà un encapçalat HTTP en la clau «MediaWiki-API-Error» i, en acabant, el valor de l'encapçalat i el còdic d'erro proveït s'establiran en el mateix valor. Per a obtindre més informació, consulta Erros i advertències.
Proves: Per a facilitar la comprovació de les solicituts de API, consulta Special:ApiSandbox.
- action
Quina acció es realisarà.
- block
- Bloquejar a un usuari.
- changeauthenticationdata
- Canviar les senyes d'autentificació per a l'usuari actual.
- changecontentmodel
- Canvia el model de contingut d'una pàgina
- checktoken
- Comprova la validea d'una ficha des de action=query&meta=tokens.
- clearhasmsg
- Neteja la marca
hasmsg
de l'usuari actual. - clientlogin
- Entrar en wiki usant el fluix interactiu.
- compare
- Obtindre la diferència entre 2 pàgines.
- createaccount
- Crear un nou conte d'usuari.
- delete
- Borrar una pàgina.
- edit
- Crear i editar pàgines.
- emailuser
- Enviar un mensage de correu electrònic a un usuari.
- expandtemplates
- Expandix totes les plantilles en wikitext.
- feedcontributions
- Proporciona el suministre de contribucions d'un usuari.
- feedrecentchanges
- Proporciona un suministre de canvis recents.
- feedwatchlist
- Proporciona el suministre d'una llista de seguiment.
- filerevert
- Revertir l'archiu a una versió anterior.
- help
- Mostrar l'ajuda per als mòduls especificats.
- imagerotate
- Girar una o més imàgens.
- import
- Importar una pàgina des d'atra wiki, o des d'un archiu XML.
- linkaccount
- Vincular un conte d'un proveïdor de tercers per a l'usuari actual.
- login
- Iniciar sessió i obtindre les cookies d'autenticació.
- logout
- Eixir i buidar los senyes de la sessió.
- managetags
- Realisar tasques d'administració relacionades en el canvi d'etiquetes.
- mergehistory
- Fusionar historials de pàgines.
- move
- Traslladar una pàgina.
- opensearch
- Buscar en el wiki per mig del protocol OpenSearch.
- options
- Canviar preferències de l'usuari actual.
- paraminfo
- Obtindre informació al voltant dels móduls de l'API.
- parse
- Analisa el contingut i torna l'eixida de l'analisador sintàctic.
- patrol
- Verificar una pàgina o revisió.
- protect
- Canviar el nivell de protecció d'una pàgina.
- purge
- Porgar la caché dels títuls proporcionats.
- query
- Obtindre senyes de i sobre MediaWiki.
- removeauthenticationdata
- Elimina les senyes d'autentificació de l'usuari actual.
- resetpassword
- Enviar un correu electrònic de reinicialisació de la contrasenya a un usuari.
- revisiondelete
- Eliminar i restaurar revisions
- rollback
- Desfer l'última edició de la pàgina.
- rsd
- Exportar un esquema RSD (Really Simple Discovery; Descobriment Molt Simple).
- setnotificationtimestamp
- Actualisar la marca de temps de notificació de les pàgines en la llista de seguiment.
- setpagelanguage
- Canviar l'idioma d'una pàgina.
- spamblacklist
- Validar una o més URLs contra la llista negra de spam (SpamBlacklist).
- tag
- Afegir o borrar etiquetes de modificació de revisions individuals o entrades de registre.
- templatedata
- Recuperar senyes almagasenades per l'extensió TemplateData.
- titleblacklist
- Validar el títul d'una pàgina, nom d'archiu o nom d'usuari en la TitleBlacklist (llista negra de títuls).
- unblock
- Desbloquejar un usuari.
- undelete
- Restaurar revisions d'una pàgina borrada.
- unlinkaccount
- Elimina un conte de tercers vinculat a l'usuari actual.
- upload
- Carrega un archiu o obtin l'estat de carregues pendents.
- userrights
- Canviar la pertinença a grups d'un usuari.
- validatepassword
- Valida una contrasenya contra les polítiques de contrasenyes de la wiki.
- watch
- Afegir o borrar pàgines de la llista de seguiment de l'usuari actual.
- webapp-manifest
- Proveïx un manifest d'aplicació web.
- mobileview
- En desús. Proveix senyes necessàries per a les vistes mòvils.
- tokens
- En desús. Obtin fiches (tokens) per a accions de modificació de senyes.
- categorytree
- Intern. Mòdul intern per a l'extensió CategoryTree.
- cspreport
- Intern. Utilisat pels navegadors per a informar de violacions a la normativa de seguritat de continguts. Este mòdul no deu usar-se mai, excepte quan s'usa automàticament per un navegador web compatible en CSP.
- oathvalidate
- Intern. Validar una clau d'autenticació en dos passos (OATH).
- scribunto-console
- Intern. Mòdul intern per a atendre solicituts XHR des de la consola Scribunto.
- stashedit
- Intern. Preparar una edició en cache compartida.
- visualeditor
- Intern. Proveïx el còdic HTML5 d'una pàgina per mig del servici Parsoid.
- visualeditoredit
- Intern. Guardar una pàgina HTML5 en MediaWiki (convertida en wikicòdic per mig del servici Parsoid).
- U dels següents valors: 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, spamblacklist, tag, templatedata, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, mobileview, tokens, categorytree, cspreport, oathvalidate, scribunto-console, stashedit, visualeditor, visualeditoredit
- Predeterminat: help
- format
El format de l'eixida.
- json
- Extraure les senyes d'eixida en format JSON.
- jsonfm
- Produir les senyes d'eixida en format JSON (en resaltat sintàctic en HTML).
- none
- No extraure res.
- php
- Extraure les senyes d'eixida en format serialisat PHP.
- phpfm
- Produir les senyes d'eixida en format PHP serialisat (en resaltat sintàctic en HTML).
- rawfm
- Extraure les senyes d'eixida, inclosos els elements de depuració, en format JSON (embellit en HTML).
- xml
- Produir les senyes d'eixida en format XML.
- xmlfm
- Produir les senyes d'eixida en format XML (en resaltat sintàctic en HTML).
- U dels següents valors: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- Predeterminat: jsonfm
- maxlag
El retràs (lag) màxim pot ser utilisat quan MediaWiki està instalat en un conjunt de bases de senyes replicades. Per a evitar qualsevol acció que poguera causar un retràs encara major en la replicació del lloc, este paràmetro pot causar que el client espere fins que el retràs de replicació siga menor que el valor especificat. En cas d'excés de retràs, es retorna un còdic d'erro maxlag en un mensage similar a Esperant a $host: $lag segons de retràs.
Vore Manual:Paràmetro maxlag per a més informació.- Tipo: entero
- smaxage
Establix la capçalera HTTP
s-maxage
de control d'antememòria a esta cantitat de segons. Els erros mai s'almagasenen en l'antememòria.- Tipo: entero
- Predeterminat: 0
- maxage
Establix la capçalera HTTP
max-age
de control d'antememòria a esta cantitat de segons. Els erros mai s'almagasenaran en l'antememòria.- Tipo: entero
- Predeterminat: 0
- assert
Comprovar que l'usuari haja iniciat sessió si el valor és user o si té el permís de bot si és bot.
- U dels següents valors: anon, bot, user
- assertuser
Verificar que l'usuari actual és l'usuari nomenat.
- Tipo: nom d'usuari
- requestid
Qualsevol valor donat ací s'inclourà en la resposta. Es pot utilisar per a distinguir solicituts.
- servedby
Incloure el nom del host que ha servit la solicitut en els resultats.
- Tipo: boolean (detalls)
- curtimestamp
Incloure la marca de temps actual en el resultat.
- Tipo: boolean (detalls)
- responselanginfo
Inclou els idiomes utilisats per a uselang i errorlang en el resultat.
- Tipo: boolean (detalls)
- origin
Quan s'accedix a la API usant una petició AJAX de distint domini (CORS), s'establix este valor al domini d'orige. Deu de ser inclòs en qualsevol petició pre-vol, i per tant deu de ser part de la URI de la petició (no del cos POST).
En les peticions en autenticació, deu coincidir exactament en u dels orígens de la capçalera
Origin
, per lo que deuria ser alguna cosa com https://en.wikipedia.org o https://meta.wikimedia.org. Si este paràmetro no coincidix en la capçaleraOrigin
, es tornarà una resposta 403. Si este paràmetro coincidix en la capçaleraOrigin
i l'orige està en la llista blanca, es crearà una capçaleraAccess-Control-Allow-Origin
.En les peticions sense autenticació, introduïx el valor *. Açò crearà una capçalera
Access-Control-Allow-Origin
, pero el valor deAccess-Control-Allow-Credentials
seràfalse
i totes les senyes que depenguen de l'usuari estaran restringides.- uselang
l'idioma que s'utilisarà per a les traduccions de mensages. action=query&meta=siteinfo en siprop=languages proporciona una llista de còdics d'idiomes. També pots introduir user per a usar la preferència d'idioma de l'usuari actual, o content per a usar l'idioma de contingut d'esta wiki.
- Predeterminat: user
- errorformat
Format utilisat per a l'eixida de text d'avisos i erros.
- plaintext
- Wikitext en el que s'han eliminat les etiquetes HTML i reemplaçat les entitats.
- wikitext
- Wikitext sense analisar.
- html
- HTML.
- raw
- Clau del mensage i paràmetros.
- none
- Cap eixida de text, només còdics d'erro.
- bc
- Format amprat en versions de MediaWiki anteriors a la 1.29. No es tenen en conte errorlang i errorsuselocal.
- U dels següents valors: bc, html, none, plaintext, raw, wikitext
- Predeterminat: bc
- errorlang
Idioma amprat per a advertències i erros. action=query&meta=siteinfo en siprop=languages proveïx una llista de còdics d'idioma. Pots especificar content per a utilisar l'idioma del contingut d'esta wiki o uselang per a utilisar el valor del paràmetro uselang.
- Predeterminat: uselang
- errorsuselocal
Si es proveïx, els texts d'erro ampraran mensages localment personalisats de l'espai de noms MediaWiki.
- Tipo: boolean (detalls)
- Ajuda del mòdul principal
- api.php?action=help [obrir en la zona de proves]
- Tota l'ajuda en una pàgina
- api.php?action=help&recursivesubmodules=1 [obrir en la zona de proves]
Tipos de senyes
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 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édits
Desarrolladores de la API:
- Roan Kattouw (desarrollador principal, sep. 2007-2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Yuri Astrakhan (creador y desarrollador principal, sep. 2006-sep. 2007)
- Brad Jorsch (desarrollador principal, 2013-actualidad)
Envía comentarios, sugerencias y preguntas a mediawiki-api@lists.wikimedia.org o informa de un error en https://phabricator.wikimedia.org/.