MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
Huvudmodul
- Source: MediaWiki
- License: GPL-2.0+
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.
- action
- Vilken åtgärd som ska utföras. 
- Ett av följande värden: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, 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, stashedit, tag, tokens, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, 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-maxagetill så här många sekunder. Fel cachelagras aldrig.
- Type: integer
- Default: 0
- maxage
- Ange headervärdet - max-agetill 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
- assertuser
- Verifiera att den nuvarande användaren är den namngivne användaren. 
- Type: user name
- 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)
- responselanginfo
- Inkluderar de språk som används för uselang och errorlang 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 - Originexakt, 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- Originoch 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
- errorformat
- Format to use for warning and error text output. - plaintext
- Wikitext with HTML tags removed and entities replaced.
- wikitext
- Unparsed wikitext.
- html
- HTML.
- raw
- Message key and parameters.
- none
- No text output, only the error codes.
- bc
- Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
 
- Ett av följande värden: plaintext, wikitext, html, raw, none, bc
- Default: bc
- errorlang
- Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter. 
- Default: uselang
- errorsuselocal
- If given, error texts will use locally-customized messages from the MediaWiki namespace. 
- Type: boolean (details)
- Hjälp för huvudmodul
- api.php?action=help [open in sandbox]
- All hjälp på en sida
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
Data types
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.
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
 
- alternative multiple-value separator
- 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.
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/.