MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

Huvudmodul

Status: Alla funktioner som visas på denna sida borde fungera. API:et är dock fortfarande under aktiv utveckling och kan ändras när som helst. Prenumerera på e-postlistan för att få aviseringar om uppdateringar.

Felaktiga förfrågningar: När felaktiga förfrågningar skickas till API:et skickas en HTTP-header med nyckeln "MediaWiki-API-Error" och sedan sätts både värdet på headern och den felkoden som returneras till samma värde. För mer information läs API: Fel och varningar.

Parametrar:
action

Vilken åtgärd som ska utföras.

ett värde: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
Default: help
format

Formatet för utdata.

ett värde: dbg, dbgfm, dump, dumpfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm
Default: jsonfm
maxlag

Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.

smaxage

Ange headervärdet s-maxage till så här många sekunder. Fel cachelagras aldrig.

Default: 0
maxage

Ange headervärdet max-age till så här många sekunder. Fel cachelagras aldrig.

Default: 0
assert

Bekräftar att användaren är inloggad om satt till user, eller har bot-användarrättigheter om satt till bot.

ett värde: user, bot
requestid

Alla värde som anges här kommer att inkluderas i svaret. Kan användas för att särskilja förfrågningar.

servedby

Inkludera det värdnamn som besvarade förfrågan i resultatet.

curtimestamp

Inkludera den aktuella tidsstämpeln i resultatet.

origin

När API:et används genom en cross-domain AJAX-begäran (CORS), ange detta till den ursprungliga domänen. Detta måste inkluderas i alla pre-flight-begäran, och mpste därför vara en del av den begärda URI:n (inte i POST-datat). Detta måste överensstämma med en av källorna i headern Origin exakt, så den måste sättas till något i stil med http://en.wikipedia.org eller https://meta.wikimedia.org. Om denna parameter inte överensstämmer med headern Origin, returneras ett 403-svar. Om denna parameter överensstämmer med headern Origin och källan är vitlistad, sätts en Access-Control-Allow-Origin-header.

uselang

Språk som ska användas för meddelandeöversättningar. En lista med koder kan hämtas från action=query&meta=siteinfo med siprop=languages, eller ange user för att använda den aktuella användarens språkpreferenser, eller ange content för att använda innehållsspråket.

Default: user
Examples:
Hjälp för huvudmodul
api.php?action=help
All hjälp på en sida
api.php?action=help&recursivesubmodules=1
Permissions:
writeapi
Använda skriv-API:et
Granted to: all, user, bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Granted to: bot, sysop

Credits

API developers:

  • Roan Kattouw (lead developer Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
  • Brad Jorsch (lead developer 2013–present)

Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org or file a bug report at https://phabricator.wikimedia.org/.