MediaWiki API help

This is an auto-generated MediaWiki Action API documentation page.

General information

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.

Request methods

Action API requests may use GET and POST methods. Prefer using the GET method, which allows requests to be routed to faster replica servers and responses to be cached, unless the length of the URL with parameters would exceed its length limit (commonly 8000 bytes), or a module only accepts POST requests.

Parameters for POST requests may be sent in the query part of the request URL (like in GET requests) and in the POST request body, and mixing both ways in one request is allowed. Certain parameters such as passwords must be sent in the request body. If the same parameter is sent as part of the URL and also in the request body, it must have the same value in both places.

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 may 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. The string now may be used to specify the current time.

Limits

Most API modules can accept up to 50 inputs in multivalue parameters, and can return up to 500 results per query (50 results for slow queries).

For users with the apihighlimits right (Robotar och Administratörer), the limits are increased to 500 inputs and 5 000 results (500 results for slow queries).

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.

Huvudmodul

Specify the action to perform, the format of the response, and options that apply to all API modules.

Specifika parametrar:
action

Vilken åtgärd som ska utföras.

acquiretempusername
Hämta ett tillfälligt användarnamn och lagra det i den aktuella sessionen, om skapande av tillfälliga konton är aktiverat och den aktuella användaren är utloggad. Om ett namn redan har lagrats returneras samma namn.
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.
languagesearch
Sök efter språknamn i valfritt skriftsystem.
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 revisioner 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: acquiretempusername, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, languagesearch, 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
Standard: 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
Standard: jsonfm
maxlag

Maximal fördröjning kan användas när MediaWiki är installerat på ett databasreplikerat kluster. För att spara åtgärder som orsakar ytterligare fördröjning vid webbplatsreplikering kan den här parametern få klienten att vänta tills replikeringsfördröjningen är mindre än det angivna värdet. Vid för lång fördröjning returneras felkoden maxlag med ett meddelande som Väntar på $host: $lag sekunder lagged .
Se Manual: Maxlag-parameter för mer information.

Typ: heltal
smaxage

Ställ in s-maxage HTTP-cachekontrollhuvudet till detta antal sekunder. Fel cachas aldrig.

Typ: heltal
Värdet får inte vara mindre än 0.
Standard: 0
maxage

Ställ in HTTP-cachekontrollens max-age till detta antal sekunder. Fel cachas aldrig.

Typ: heltal
Värdet får inte vara mindre än 0.
Standard: 0
assert

Verifiera att användaren är inloggad (inklusive eventuellt som en tillfällig användare) om den är inställd på user , inte inloggad om den är inställd på anon , eller har bot-användarrättigheten om 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 något av användarnamn och Tillfällig användare
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 inkluderas i alla pre-flight-begäranden och måste därför vara en del av begäran-URI:n (inte POST-texten).

För autentiserade förfrågningar måste detta matcha ett av ursprungen i Origin headern exakt, så den måste vara inställd på något i stil med https://en.wikipedia.org eller https://meta.wikimedia.org . Om den här parametern inte matchar Origin headern returneras ett 403-svar. Om den här parametern matchar Origin headern och ursprunget är tillåtet, kommer rubrikerna Access-Control-Allow-Origin och Access-Control-Allow-Credentials att ställas in.

För icke-autentiserade förfrågningar, ange värdet * . Detta kommer att göra att Access-Control-Allow-Origin headern ställs in, men Access-Control-Allow-Credentials kommer att vara false och all användarspecifik data kommer att begränsas.

crossorigin

När du ansluter till API:et med en AJAX-begäran över flera domäner (CORS) och använder en sessionsleverantör som är säker mot CSRF-attacker (cross-site request forgery) (t.ex. OAuth), använd detta istället för origin=* för att autentisera begäran (dvs. inte logga ut). Detta måste inkluderas i alla pre-flight-begäranden och måste därför vara en del av begäran-URI:n (inte POST-texten).

Observera att de flesta sessionsleverantörer, inklusive vanliga cookie-baserade sessioner, inte stöder autentiserade CORS och inte kan användas med denna parameter.

Type: boolean (details)
uselang

Språk som ska användas för meddelandeöversättningar. action=query&meta=siteinfo&siprop=languages returnerar en lista med språkkoder. Du kan ange att användaren ska använda den aktuella användarens språkinställning eller att innehållet ska använda denna wikis innehållsspråk.

Standard: user
variant

Variant av språket. Fungerar bara om basspråket stöder variantkonvertering.

errorformat

Format att använda för utdata av varnings- och feltexter

plaintext
Wikitext med borttagna HTML-taggar och ersatta entiteter.
wikitext
Oanalyserad wikitext.
html
HTML
raw
Meddelandenyckel och parametrar.
none
Ingen textutmatning, bara felkoder.
bc
Format som användes före MediaWiki 1.29. errorlang och errorsuselocal ignoreras.
Ett av följande värden: bc, html, none, plaintext, raw, wikitext
Standard: bc
errorlang

Språk som ska användas för varningar och fel. action=query&meta=siteinfo&siprop=languages returnerar en lista med språkkoder. Ange innehåll för att använda denna wikis innehållsspråk eller uselang för att använda samma värde som uselang- parametern.

Standard: uselang
errorsuselocal

Om angivet kommer feltexter att använda lokalt anpassade meddelande från namnrymden MediaWiki.

Type: boolean (details)

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–2020)

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