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 bör fungera, men API:et är fortfarande under utveckling och kan ändras när som helst. 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.

Parametrar:
action

Vilken åtgärd som ska utföras.

adddomainalias
Add a domain alias to wiki
annotatewikinotspam
Annotate Wiki as not spam
block
Blockera en användare.
categorytree
Intern modul för tillägget CategoryTree.
changeauthenticationdata
Ändra autentiseringsdata för aktuell användare.
checktoken
Kontrollera giltigheten av en nyckel från action=query&meta=tokens.
checkwikistatus
Checks if Create New Wiki process finished and returns the status of the whole process as well as the statuses for each individual step.
clearhasmsg
Rensa hasmsg-flaggan för den aktuella användaren.
clearwikiconfigcache
Clear the configuration cache for a wiki.
clientlogin
Logga till på wikin med det interaktiva flödet.
compare
Hämta skillnaden mellan två sidor.
createaccount
Skapa ett nytt användarkonto.
createnewwiki
Initiates Create New Wiki process.
createwikiconfigvariabledefinition
Create config variable.
cspreport
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.
delete
Radera en sida.
details
edit
Skapa och redigera sidor.
emailuser
Skicka e-post till en användare.
embedvideo
Get generated video embed code for given parameters.
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.
gettheme
help
Visa hjälp för de angivna modulerna.
imagerotate
Rotera en eller flera bilder.
imageserving
This module is used to return one image URL for the specified article given either the article ID or article title (with prefix if applicable).
import
Importer en sida från en annan wiki eller från en XML-fil.
infobox
This module provides infobox parser
linkaccount
Länka ett konto från en tredjepartsleverantör till nuvarande användare.
linksuggest
Suggest link to editors on edit view
listusersnamesearch
listuserssearchuser
listwikiswithextension
Get a list of wikis where extension is enabled.
listwikiswithvariable
Get a list of wikis where a variable is in a given state.
login
Logga in och hämta autentiseringskakor.
logout
Logga ut och rensa sessionsdata.
lookupcontribs
Lookup user contributions
maintenance
managetags
Utför hanterings uppgifter relaterade till förändrings taggar.
markwikiclosed
Mark given wiki as closed (not publicly available).
markwikiopen
Mark given wiki as open (available and public).
markwikiprotected
Mark given wiki as protected so it's not possible to close it.
masseditwikis
Edit config variables for list of wikis.
mergehistory
Sammanfoga sidhistoriker.
mobileview
Returnerar data som krävs för mobilt visningsläge.
modifydomainalias
Modify a domain alias to wiki
move
Flytta en sida.
multidelete
multifindcharacter
notifications
Retrieve notifications for the current user.
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.
parsoid-batch
Batch API for Parsoid
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.
removedomainalias
Remove a domain alias to wiki
removephalanxblock
removewikiconfigvariable
Remove a config variable on a wiki.
reopenwiki
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.
savetheme
savewikiconfigvariable
Set a config variable for a wiki.
schedulesearchindexupdate
scribunto-console
Internal module for servicing XHR requests from the Scribunto console.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Ändra språket på en sida.
stashedit
Prepare an edit in shared cache.
suggestwiki
suggestwikis
Get list of wikis that domains contain search phrase.
tag
Lägg till eller ta bort ändringsmärken från individuella sidversioner eller loggposter.
tagsreport
templatedata
Hämta data som lagras av TemplateData-tillägget.
titleblacklist
Validera en sidtitel, filnamn eller användare mot TitleBlacklist.
transcodereset
Users with the 'transcode-reset' right can reset and re-run a transcode job.
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.
updateHubs
Updates categories and vertical for wiki
updateprimarydomain
Update primary domain of a wiki
updatewikiconfigvariabledefinition
Update properties of existing config variable.
upload
Ladda upp en fil eller hämta status för väntande uppladdningar.
uploadimage
userrights
Ändra en användares gruppmedlemskap.
validatepassword
Validate a password against the wiki's password policies.
variableinfo
Get detailed information about given configuration variable.
variableupdate
Update variable info
verifytask
visualeditor
Returnerar HTML5 för en sida från Parsoid-tjänsten.
visualeditoredit
Spara en HTML5-sida till MediaWiki (konverterad till wikitext via Parsoid-tjänsten).
watch
Lägg till eller ta bort sidor från aktuell användares bevakningslista.
webapp-manifest
Returnerar ett webbappsmanifest.
tokens
Föråldrad. Hämta nycklar för datamodifierande handlingar.
Ett av följande värden: adddomainalias, annotatewikinotspam, block, categorytree, changeauthenticationdata, checktoken, checkwikistatus, clearhasmsg, clearwikiconfigcache, clientlogin, compare, createaccount, createnewwiki, createwikiconfigvariabledefinition, cspreport, delete, details, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, gettheme, help, imagerotate, imageserving, import, infobox, linkaccount, linksuggest, listusersnamesearch, listuserssearchuser, listwikiswithextension, listwikiswithvariable, login, logout, lookupcontribs, maintenance, managetags, markwikiclosed, markwikiopen, markwikiprotected, masseditwikis, mergehistory, mobileview, modifydomainalias, move, multidelete, multifindcharacter, notifications, opensearch, options, paraminfo, parse, parsoid-batch, patrol, protect, purge, query, removeauthenticationdata, removedomainalias, removephalanxblock, removewikiconfigvariable, reopenwiki, resetpassword, revisiondelete, rollback, rsd, savetheme, savewikiconfigvariable, schedulesearchindexupdate, scribunto-console, setnotificationtimestamp, setpagelanguage, stashedit, suggestwiki, suggestwikis, tag, tagsreport, templatedata, titleblacklist, transcodereset, unblock, undelete, unlinkaccount, updateHubs, updateprimarydomain, updatewikiconfigvariabledefinition, upload, uploadimage, userrights, validatepassword, variableinfo, variableupdate, verifytask, visualeditor, visualeditoredit, watch, webapp-manifest, tokens
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: 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 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. 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
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

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)
Permissions:
writeapi
Använda skriv-API:et
Granted to: all, user och 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, staff, helper, soap, wiki-representative och wiki-specialist

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.

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/.