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

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.

Parametrar:
action

Vilken ÄtgÀrd som ska utföras.

acquiretempusername
Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.
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.
cxdelete
Radera ett översÀttningsutkast som skapats med hjÀlp av tillÀgget InnehÄllsöversÀttning.
cxtoken
HÀmta JWT-nyckel för att autentisera med cxserver.
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.
globalpreferenceoverrides
Ändra lokala Ă„sidosĂ€ttanden för globala instĂ€llningar till nuvarande anvĂ€ndare.
globalpreferences
Ändra globala instĂ€llningar för nuvarande anvĂ€ndare.
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.
sxdelete
Radera översÀttningen av utkastsavsnittet och dess parallella korpus frÄn databasen.
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.
webapp-manifest
Returnerar ett webbappsmanifest.
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.
cxcheckunreviewed
Intern. Kontrollera om en snabb ogranskad översÀttning nyligen har publicerats för den aktuella anvÀndaren.
cxfavoritesuggestions
Intern. LÀgg till eller ta bort ett favoritförslag frÄn den aktuella anvÀndarens lista.
cxpublish
Intern. Spara en sida skapad med tillÀgget för innehÄllsöversÀttning.
cxpublishsection
Intern. Spara ett avsnitt som skapades med avsnittsöversÀttningsfunktionen i tillÀgget InnehÄllsöversÀttning.
cxsave
Intern. Denna modul lÄter översÀttningsutkast sparas efter avsnitt för att spara bandbredd och för att samla in parallell text.
cxsplit
Intern. Skapa och spara en avsnittsöversÀttning till databasen för varje översatt avsnitt i den angivna artikelöversÀttningen
editcheckreferenceurl
Intern. Check the status of a URL for use as a reference.
stashedit
Intern. Prepare an edit in shared cache.
sxsave
Intern. Spara översÀttningsskiss för avsnittet och lagra den parallella texten
ulslocalization
Intern. FÄ lokalanpassningen av ULS pÄ ett visst sprÄk.
ulssetlang
Intern. Uppdatera det sprÄk som anvÀndaren valt för grÀnssnittet.
visualeditor
Intern. Returnerar HTML5 för en sida frÄn Parsoid-tjÀnsten.
visualeditoredit
Intern. Spara en HTML5-sida till MediaWiki (konverterad till wikitext via Parsoid-tjÀnsten).
Ett av följande vÀrden: acquiretempusername, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, cxdelete, cxtoken, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalpreferenceoverrides, globalpreferences, 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, sxdelete, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, cspreport, cxcheckunreviewed, cxfavoritesuggestions, cxpublish, cxpublishsection, cxsave, cxsplit, editcheckreferenceurl, stashedit, sxsave, ulslocalization, ulssetlang, visualeditor, visualeditoredit
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

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.

Typ: heltal
smaxage

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

Typ: heltal
VÀrdet fÄr inte vara mindre Àn 0.
Standard: 0
maxage

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

Typ: heltal
VÀrdet fÄr inte vara mindre Àn 0.
Standard: 0
assert

BekrÀfta att anvÀndaren Àr inloggad om satt till user, inte inloggad om satt till anon,eller har bot-anvÀndarrÀttigheten 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 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 ö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.

crossorigin

When accessing the API using a cross-domain AJAX request (CORS) and using a session provider that is safe against cross-site request forgery (CSRF) attacks (such as OAuth), use this instead of origin=* to make the request authenticated (i.e., not logged out). This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

Note that most session providers, including standard cookie-based sessions, do not support authenticated CORS and cannot be used with this parameter.

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

Standard: 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
Standard: 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.

Standard: uselang
errorsuselocal

Om angivet kommer feltexter att anvÀnda lokalt anpassade meddelande frÄn namnrymden MediaWiki.

Type: boolean (details)
Examples:
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]
Permission:
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 och sysop

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

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

HĂ€mtad frĂ„n ”https://sv.islamd.ru/Special:ApiHelp”