MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Huvudmodul
- Source: MediaWiki
- License: GPL-2.0-or-later
Status: MediaWikis API är ett moget och stabilt gränssnitt som aktivt underhålls och förbättras. Vi försöker undvika det men ibland behöver vi kanske behöver göra störande ändringar; prenumerera på sändlistan mediawiki-api-announce för uppdateringsaviseringar.
Felaktiga begäran: När felaktiga begäran skickas till API:et kommer en HTTP-header skickas med nyckeln "MediaWiki-API-Error" och sedan kommer både värdet i headern och felkoden som skickades tillbaka anges som samma värde. För mer information se API: Fel och varningar.
Testning: För enkelt testning av API-begäran, se Special:ApiSandbox.
- action
Vilken åtgärd som ska utföras.
- block
- Blockera en användare.
- changeauthenticationdata
- Ändra autentiseringsdata för aktuell användare.
- changecontentmodel
- Ändra innehållsmodellen för en sida
- checktoken
- Kontrollera giltigheten av en nyckel från action=query&meta=tokens.
- clearhasmsg
- Rensa
hasmsg
-flaggan för den aktuella användaren. - clientlogin
- Logga till på wikin med det interaktiva flödet.
- compare
- Hämta skillnaden mellan två sidor.
- createaccount
- Skapa ett nytt användarkonto.
- delete
- Radera en sida.
- edit
- Skapa och redigera sidor.
- emailuser
- Skicka e-post till en användare.
- expandtemplates
- Expanderar alla mallar inom wikitext.
- feedcontributions
- Returnerar en användares bidragsflöde.
- feedrecentchanges
- Returnerar ett flöde med senaste ändringar.
- feedwatchlist
- Returnerar ett flöde från bevakningslistan.
- filerevert
- Återställ en fil till en äldre version.
- help
- Visa hjälp för de angivna modulerna.
- imagerotate
- Rotera en eller flera bilder.
- import
- Importer en sida från en annan wiki eller från en XML-fil.
- linkaccount
- Länka ett konto från en tredjepartsleverantör till nuvarande användare.
- login
- Logga in och hämta autentiseringskakor.
- logout
- Logga ut och rensa sessionsdata.
- managetags
- Utför hanterings uppgifter relaterade till förändrings taggar.
- mergehistory
- Sammanfoga sidhistoriker.
- move
- Flytta en sida.
- opensearch
- Sök wikin med protokollet OpenSearch.
- options
- Ändra inställningar för nuvarande användare.
- paraminfo
- Få information om API moduler.
- parse
- Parses content and returns parser output.
- patrol
- Patrullera en sida eller en version.
- protect
- Ändra skyddsnivån för en sida.
- purge
- Rensa cachen för angivna titlar.
- query
- Fetch data from and about MediaWiki.
- removeauthenticationdata
- Remove authentication data for the current user.
- resetpassword
- Send a password reset email to a user.
- revisiondelete
- Radera och återställ sidversioner.
- rollback
- Ångra den senaste redigeringen på sidan.
- rsd
- Export an RSD (Really Simple Discovery) schema.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Ändra språket på en sida.
- tag
- Lägg till eller ta bort ändringsmärken från individuella sidversioner eller loggposter.
- unblock
- Upphäv en användares blockering.
- undelete
- Återställ sidversioner för en raderad sida.
- unlinkaccount
- Ta bort ett länkat tredjepartskonto från aktuell användare.
- upload
- Ladda upp en fil eller hämta status för väntande uppladdningar.
- userrights
- Ändra en användares gruppmedlemskap.
- validatepassword
- Validate a password against the wiki's password policies.
- watch
- Lägg till eller ta bort sidor från aktuell användares bevakningslista.
- cspreport
- Intern. Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
- stashedit
- Intern. Prepare an edit in shared cache.
- Ett av följande värden: 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, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, stashedit
- Default: help
- format
Formatet för utdata.
- json
- Output data in JSON format.
- jsonfm
- Output data in JSON format (pretty-print in HTML).
- none
- Output nothing.
- php
- Output data in serialized PHP format.
- phpfm
- Output data in serialized PHP format (pretty-print in HTML).
- rawfm
- Output data, including debugging elements, in JSON format (pretty-print in HTML).
- xml
- Output data in XML format.
- xmlfm
- Output data in XML format (pretty-print in HTML).
- 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: anon, bot, user
- assertuser
Verifiera att den nuvarande användaren är den namngivne användaren.
- Typ: användare, genom användarnamn
- 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
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 headernOrigin
, returneras ett 403-svar. Om denna parameter överensstämmer med headernOrigin
och källan är vitlistad, sätts enAccess-Control-Allow-Origin
-header.- uselang
Språk som ska användas för meddelandeöversättningar. action=query&meta=siteinfo med siprop=languages returnerar en lista med språkkoder, 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
- variant
Variant of the language. Only works if the base language supports variant conversion.
- 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: bc, html, none, plaintext, raw, wikitext
- Default: bc
- errorlang
Språk att använda för varningar och fel. action=query&meta=siteinfo med siprop=languages returnerar en lista över språkkoder eller specifikt content för att använda innehållsspråket på denna wiki, eller specifikt uselang för att använda samma värde som parametern uselang.
- Default: uselang
- errorsuselocal
Om angivet kommer feltexter att använda lokalt anpassade meddelande från namnrymden MediaWiki.
- 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.
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.
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/.