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 av följande värden: block, changeauthenticationdata, 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, stashedit, tag, tokens, unblock, undelete, unlinkaccount, upload, userrights, watch
Default: help
format

Formatet för utdata.

Ett av följande värden: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
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.

Type: integer
smaxage

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

Type: integer
Default: 0
maxage

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

Type: integer
Default: 0
assert

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

Ett av följande värden: 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.

Type: boolean (details)
curtimestamp

Inkludera den aktuella tidsstämpeln i resultatet.

Type: boolean (details)
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
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

Data types

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.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now

Credits

API developers:

  • Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
  • Roan Kattouw (lead developer Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • 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/.