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
- Licens: 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.
- abusefiltercheckmatch
- Kontrollera om ett missbruksfilter matchar en grupp variabler, en redigering eller en händelse som är loggad i missbruksfiltret.
- abusefilterchecksyntax
- Kontrollera syntaxen för ett missbruksfilter.
- abusefilterevalexpression
- Utvärderar uttryck i ett missbruksfilter.
- abusefilterunblockautopromote
- Upphäver blockering för en användare från att få automatiska befordringar p.g.a. konsekvenser från ett missbruksfilter.
- abuselogprivatedetails
- Visa privata detaljer för en post i missbruksloggen.
- 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.
- antispoof
- Kontrollera ett användarnamn mot AntiSpoofs normaliseringskontroller.
- block
- Blockera en användare.
- centralauthtoken
- Hämta en centralauthtoken för att göra en autentiserad begäran till en ansluten wiki.
- centralnoticecdncacheupdatebanner
- Begär rensning av bannerinnehåll lagrat i CDN (front-end) cache för anonyma användare, för den begärda bannern och språket
- centralnoticechoicedata
- Få information som behövs för att välja en banner för ett visst projekt och språk
- centralnoticequerycampaign
- Få alla konfigurationsinställningar för en kampanj.
- 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.
- communityconfigurationedit
- Change the content of a configuration provider in Community configuration
- compare
- Hämta skillnaden mellan två sidor.
- createaccount
- Skapa ett nytt användarkonto.
- createlocalaccount
- Tvångsskapa ett lokalt konto. Det centrala kontot måste finnas.
- delete
- Radera en sida.
- deleteglobalaccount
- Radera en global användare.
- discussiontoolsedit
- Posta ett inlägg på en diskussionssida.
- discussiontoolsfindcomment
- Hitta en kommentar via dess ID eller namn.
- discussiontoolsgetsubscriptions
- Hämta prenumerationsstatus för angivna ämnen.
- discussiontoolssubscribe
- Prenumerera (eller sluta prenumerera) för att ta emot aviseringar om ett ämne.
- discussiontoolsthank
- Skicka ett offentligt tackmeddelande för en kommentar.
- echocreateevent
- Utlös en avisering till en användare manuellt
- echomarkread
- Markera aviseringar som lästa för den aktuella användaren.
- echomarkseen
- Märk aviseringar som lästa för aktuell användare.
- echomute
- Tysta eller sluta tysta aviseringar från vissa användare eller sidor.
- edit
- Skapa och redigera sidor.
- editmassmessagelist
- Redigera leveranslista för massmeddelanden
- emailuser
- Skicka e-post till en användare.
- expandtemplates
- Expanderar alla mallar inom wikitext.
- featuredfeed
- Returnerar ett flöde för utvalt innehåll.
- 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.
- globalblock
- Blockera eller avblockera en användare globalt.
- globalpreferenceoverrides
- Ändra lokala åsidosättanden för globala inställningar till nuvarande användare.
- globalpreferences
- Ändra globala inställningar för nuvarande användare.
- globaluserrights
- Lägg till/ta bort en användare till/från globala grupper.
- help
- Visa hjälp för de angivna modulerna.
- imagerotate
- Denna modul har inaktiverats.
- import
- Importer en sida från en annan wiki eller från en XML-fil.
- jsonconfig
- Tillåter direkt tillgång till JsonConfigs undersystem
- 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.
- massmessage
- Skicka ett meddelande till en lista över sidor.
- 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.
- setglobalaccountstatus
- Dölj eller lås (eller visa eller lås upp) ett globalt användarkonto.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Ändra språket på en sida.
- shortenurl
- Korta ner en lång URL till en kortare.
- sitematrix
- Hämta Wikimedia sidlistor.
- spamblacklist
- Validera en eller mer URL:er mot spamblockeringslistan.
- streamconfigs
- Visar konfiguration för händelseström. Returnerar endast format=json med formatversion=2.
- strikevote
- Tillåter administratörer att slå eller avbryta en omröstning.
- tag
- Lägg till eller ta bort ändringsmärken från individuella sidversioner eller loggposter.
- templatedata
- Hämta data som lagras av TemplateData-tillägget.
- thank
- Skicka ett tack-avisering till en redigerare.
- titleblacklist
- Validera en sidtitel, filnamn eller användare mot TitleBlacklist.
- torblock
- Kontrollera om en IP-adress är blockerad som en Tor-utgångsnod.
- transcodereset
- Användare med "transcode-reset"-rättigheten kan återställa och köra om ett transkodningsjobb.
- 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.
- webapp-manifest
- Returnerar ett webbappsmanifest.
- webauthn
- API-modul för att kommunicera mellan server och klient under registrerings-/autentiseringsprocessen.
- bouncehandler
- Intern. Få ett studsat e-post meddelande och bearbeta detta för att hantera den misslyckade mottagaren.
- categorytree
- Intern. Intern modul för tillägget CategoryTree.
- chartinfo
- Intern. Hämta aktuellt antal unika användningar av diagramsidan. Flera användningar av samma diagram på samma sida betraktas som en enda användning.
- cirrus-check-sanity
- Intern. Reports on the correctness of a range of page ids in the search index
- cirrus-config-dump
- Intern. Dump av CirrusSearch-konfiguration.
- cirrus-profiles-dump
- Intern. Dump av CirrusSearch-profiler för denna wiki.
- cirrus-schema-dump
- Intern. Dump of CirrusSearch schema (settings and mappings) for this wiki.
- codemirror-validate
- Intern. Check for validation errors in the given content
- collection
- Intern. API module for performing various operations on a wiki user's collection.
- 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.
- discussiontoolscompare
- Intern. Få information om kommentarsändringar mellan två sidversioner.
- discussiontoolspageinfo
- Intern. Returnerar metadata som krävs för att initialisera diskussionsverktygen.
- discussiontoolspreview
- Intern. Förhandsgranska ett meddelande på en diskussionssida.
- editcheckreferenceurl
- Intern. Check the status of a URL for use as a reference.
- fancycaptchareload
- Intern. Hämta en ny FancyCaptcha.
- jsondata
- Intern. Hämta lokaliserad JSON-data.
- jsontransform
- Intern. Retrieve JSON data transformed by a Lua function.
- parser-migration
- Intern. Parse a page with two different parser configurations.
- readinglists
- Intern. Skrivoperationer för läslistor.
- sanitize-mapdata
- Intern. Utför datavalidering för tillägget Kartographer
- scribunto-console
- Intern. Intern modul för att betjäna XHR-förfrågningar från Scribunto-konsolen.
- securepollauth
- Intern. Allows a remote wiki to authenticate users before granting access to vote in the election.
- stashedit
- Intern. Prepare an edit in shared cache.
- timedtext
- Intern. Tillhandahåller tajmad textinnehåll för användande av <track> elements
- 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).
- wikimediaeventsblockededit
- Intern. Log information about blocked edit attempts
- wikimediaeventshcaptchaeditattempt
- Intern. Log edit diff when hCaptcha challenge is shown but edit is incomplete
- Ett av följande värden: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, bouncehandler, categorytree, chartinfo, cirrus-check-sanity, cirrus-config-dump, cirrus-profiles-dump, cirrus-schema-dump, codemirror-validate, collection, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, fancycaptchareload, jsondata, jsontransform, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit, wikimediaeventshcaptchaeditattempt
- 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-maxageHTTP-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-agetill 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
Originheadern 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 matcharOriginheadern returneras ett 403-svar. Om den här parametern matcharOriginheadern och ursprunget är tillåtet, kommer rubrikernaAccess-Control-Allow-OriginochAccess-Control-Allow-Credentialsatt ställas in.För icke-autentiserade förfrågningar, ange värdet * . Detta kommer att göra att
Access-Control-Allow-Originheadern ställs in, menAccess-Control-Allow-Credentialskommer att varafalseoch 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)
- centralauthtoken
När du använder API:et med en AJAX-begäran (CORS) över flera domäner kan du använda detta för att autentisera som den aktuella SUL-användaren. Använd action=centralauthtoken på denna wiki för att hämta tecken innan du gör CORS-begäran. Varje tecken får endast användas en gång och går ut efter 10 sekunder. Detta bör ingå i alla förfrågningar före flygning och bör därför ingå i URI begäran (inte POST-body).
On this wiki the expected value is a JSON Web Token, which may be validated by proxy servers in front of MediaWiki. If the token has expired or is otherwise invalid, you may receive a HTTP error from a proxy in a different format than a normal API error.
- 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 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/.