MedijaViki API pagalba

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Pagrindinis modulis

Status: The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to the mediawiki-api-announce mailing list for notice of updates.

Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings.

Parametrai:
action

Kurį veiksmą atlikti.

abusefiltercheckmatch
Check to see if an AbuseFilter matches a set of variables, an edit, or a logged AbuseFilter event.
abusefilterchecksyntax
Patikrinkite AbuseFilter filtro sintaksę.
abusefilterevalexpression
Įvertina AbuseFilter išraišką.
abusefilterunblockautopromote
Unblocks a user from receiving autopromotions due to an abusefilter consequence.
abuselogprivatedetails
Žiūrėti privačią AbuseLog įrašo informaciją.
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.
antispoof
Patikrinti, ar naudotojo vardas atitinka AntiSpoof normalizavimo patikras.
block
Blokuoti vartotoją.
centralauthtoken
Fetch a centralauthtoken for making an authenticated request to an attached wiki.
centralnoticecdncacheupdatebanner
Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language
centralnoticechoicedata
Gauti duomenis, reikalingus banerio pasirinkimui pateiktam projektui ir kalbai
centralnoticequerycampaign
Gauti visus kampanijos konfigūracijos nustatymus.
changeauthenticationdata
Change authentication data for the current user.
changecontentmodel
Change the content model of a page
checktoken
Check the validity of a token from action=query&meta=tokens.
cirrus-config-dump
Dump of CirrusSearch configuration.
cirrus-mapping-dump
Dump of CirrusSearch mapping for this wiki.
cirrus-profiles-dump
Dump of CirrusSearch profiles for this wiki.
cirrus-settings-dump
Dump of CirrusSearch settings for this wiki.
clearhasmsg
Clears the hasmsg flag for the current user.
clientlogin
Log in to the wiki using the interactive flow.
communityconfigurationedit
Change the content of a configuration provider in Community configuration
compare
Get the difference between two pages.
createaccount
Kurti naują vartotojo paskyrą.
createlocalaccount
Priverstinai sukurti vietinę paskyrą
cxdelete
Delete a draft translation created using the Content Translation extension.
cxsuggestionlist
Manage the suggestion lists. Add suggestions to lists and remove them.
cxtoken
Get JWT tokens to authenticate with cxserver.
delete
Ištrinti puslapį.
deleteglobalaccount
Trinti visuotinį naudotoją.
discussiontoolsedit
Paskelbti žinutę diskusijų puslapyje.
discussiontoolsfindcomment
Find a comment by its ID or name.
discussiontoolsgetsubscriptions
Gauti pateiktų temų prenumeratos būseną.
discussiontoolssubscribe
Prenumeruoti (ar atsisakyti prenumeratos), kad būtų gaunami pranešimai apie temą.
discussiontoolsthank
Send a public thank-you notification for a comment.
echocreateevent
Manually trigger a notification to a user
echomarkread
Žymėti dabartinio naudotojo pranešimus kaip perskaitytus.
echomarkseen
Žymėti pranešimus kaip matytus dabartiniam naudotojui.
echomute
Išjungti ar įjungti pranešimus iš tam tikrų naudotojų ar puslapių.
edit
Kurti ir redaguoti puslapius.
editmassmessagelist
Redaguoti masinės žinutės adresatų sąrašą.
emailuser
Siųsti el. laišką naudotojui.
expandtemplates
Expands all templates within wikitext.
featuredfeed
Gražina išskirto turinio srautą.
feedcontributions
Gražina vartotojo įnašų srautą.
feedrecentchanges
Gražina naujausių pakeitimų srautą.
feedwatchlist
Gražina stebimųjų sąrašo srautą.
filerevert
Grąžinti failą į seną versiją.
globalblock
Visuotinis naudotojo blokavimas ar atblokavimas.
globalpreferenceoverrides
Change local overrides for global preferences for the current user.
globalpreferences
Keisti dabartinio naudotojo visuotinius nustatymus.
globaluserrights
Pridėti / pašalinti naudotoją prie / iš pasaulinių grupių.
growthmanagementorlist
Tvarkykite struktūruoto mentorių sąrašo informaciją (įprastai talpinama MediaWiki:GrowthMentors.json). Šis modulis gali būti naudojamas tiek dabartinių, tiek ateities mentorių (kad pridėtu save ar pakeistų informaciją) ir administratorių (visiems naudotojams).
growthmentordashboardupdatedata
Mentoriaus prietaisų skydelyje suplanuokite nepaprastą mentee apžvalgos modulio atnaujinimą. Dėl našumo priežasčių galite suplanuoti tik vieną atnaujinimą per dvi valandas.
growthsetmenteestatus
Nustatyti mentee būseną (leidžia mentees įjungti/išjungti mentorystės modulį ar visiškai atsisakyti, kas ištrina mentee/mentoriaus santykį)
growthsetmentor
Nustatyti naudotojo mentorių. Pokytis bus registruotas viešai.
growthstarmentee
Pažymėti ar atžymėti mentee kaip pažymėtą žvaigždute dabartinio naudotojo (talpinama privačiai ir neregistruojama žurnale)
help
Rodyti pagalbą pasirinktiems moduliams.
homepagequestionstore
Gaukite suformatuotus klausimus, paskelbtus per pagrindinio puslapio modulius
imagerotate
Šis modulis buvo išjungtas.
import
Import a page from another wiki, or from an XML file.
jsonconfig
Leidžia tiesiogiai pasiekti JsonConfig posistemę.
languagesearch
Search for language names in any script.
linkaccount
Link an account from a third-party provider to the current user.
login
Log in and get authentication cookies.
logout
Atsijungti ir išvalyti sesijos duomenis.
managetags
Perform management tasks relating to change tags.
massmessage
Siųsti žinutę puslapių sąrašui.
mergehistory
Sujungti puslapio istorijas.
move
Perkelti puslapį.
opensearch
Ieškoti viki naudojant OpenSearch protokolą.
options
Keisti dabartinio naudotojo nustatymus.
paraminfo
Gauti informaciją apie API modulius.
parse
Parses content and returns parser output.
patrol
Patrol a page or revision.
protect
Pakeisti puslapio apsaugos lygį.
purge
Purge the cache for the given titles.
query
Gauti duomenis iš ir apie MediaWiki.
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
Send a password reset email to a user.
revisiondelete
Delete and undelete revisions.
rollback
Undo the last edit to the page.
rsd
Export an RSD (Really Simple Discovery) schema.
setglobalaccountstatus
Nustatyti visuotinio naudotojo būseną.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Keisti puslapio kalbą.
shortenurl
Shorten a long URL into a shorter one.
sitematrix
Get Wikimedia sites list.
spamblacklist
Validate one or more URLs against the spam block list.
streamconfigs
Exposes event stream config. Returns only format=json with formatversion=2.
strikevote
Leidžia administratoriams pašalinti arba vėl įtraukti balsą.
sxdelete
Delete the draft section translation and its parallel corpora from database.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
Gauti duomenis, saugomus TemplateData plėtinio.
thank
Siųsti padėkos pranešimą redaktoriui.
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
torblock
Check if an IP address is blocked as a Tor exit node.
transcodereset
Users with the 'transcode-reset' right can reset and re-run a transcode job.
unblock
Atblokuoti naudotoją.
undelete
Undelete revisions of a deleted page.
unlinkaccount
Remove a linked third-party account from the current user.
upload
Upload a file, or get the status of pending uploads.
userrights
Keisti vartotoju grupės narystę.
validatepassword
Validate a password against the wiki's password policies.
watch
Pridėti ar pašalinti puslapius iš dabartinio vartotojo stebimųjų sąrašo.
webapp-manifest
Returns a webapp manifest.
webauthn
API Module to communicate between server and client during registration/authentication process.
bouncehandler
Internal. Receive a bounce email and process it to handle the failing recipient.
categorytree
Internal. Vidinis modulis, skirtas CategoryTree plėtiniui.
cirrus-check-sanity
Internal. Reports on the correctness of a range of page ids in the search index
collection
Internal. API module for performing various operations on a wiki user's collection.
cspreport
Internal. 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
Internal. Check if any fast, unreviewed translation has been published recently for the current user.
cxpublish
Internal. Išsaugoti puslapį, sukurtą naudojant turinio vertimo plėtinį.
cxpublishsection
Internal. Save a section created using the Content Translation extension's section translation feature.
cxsave
Internal. This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.
cxsplit
Internal. Create and save a section translation to database, for every translated section of the given article translation
discussiontoolscompare
Internal. Get information about comment changes between two page revisions.
discussiontoolspageinfo
Internal. Grąžina metaduomenis, reikalingus diskusijų įrankiams inicijuoti.
discussiontoolspreview
Internal. Peržiūrėti pranešimą diskusijų puslapyje.
echopushsubscriptions
Internal. Manage push subscriptions for the current user.
editcheckreferenceurl
Internal. Check the status of a URL for use as a reference.
fancycaptchareload
Internal. Gauti naują FancyCaptcha.
growthinvalidateimagerecommendation
Internal. Invalidate an image recommendation.
growthinvalidatepersonalizedpraisesuggestion
Internal. Invalidates a suggestion of a praiseworthy mentee in the Personalized praise module on the Mentor dashboard
helppanelquestionposter
Internal. Tvarkyti dabartinio naudotojo klausimus, paskelbtus per pagalbos skydelį.
jsondata
Internal. Gauti lokalizuotus JSON duomenis.
oathvalidate
Internal. Patvirtinti dviejų faktorių autentifikavimo (OATH) prieigos raktą.
parser-migration
Internal. Parse a page with two different parser configurations.
readinglists
Internal. Skaitymo sąrašo rašymo operacijos.
sanitize-mapdata
Internal. Performs data validation for Kartographer extension
scribunto-console
Internal. Internal module for servicing XHR requests from the Scribunto console.
securepollauth
Internal. Leidžia nuotoliniam viki autentifikuoti naudotojus prieš suteikiant prieigą balsuoti rinkimuose.
stashedit
Internal. Prepare an edit in shared cache.
sxsave
Internal. Save the draft section translation and store the parallel corpora
timedtext
Internal. Provides timed text content for usage by <track> elements
ulslocalization
Internal. Get the localization of ULS in the given language.
ulssetlang
Internal. Update user's preferred interface language.
visualeditor
Internal. Returns HTML5 for a page from the Parsoid service.
visualeditoredit
Internal. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
wikimediaeventsblockededit
Internal. Log information about blocked edit attempts
One of the following values: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, cxdelete, cxsuggestionlist, cxtoken, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, growthmanagementorlist, growthmentordashboardupdatedata, growthsetmenteestatus, growthsetmentor, growthstarmentee, help, homepagequestionstore, 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, sxdelete, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, bouncehandler, categorytree, cirrus-check-sanity, collection, cspreport, cxcheckunreviewed, cxpublish, cxpublishsection, cxsave, cxsplit, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, echopushsubscriptions, editcheckreferenceurl, fancycaptchareload, growthinvalidateimagerecommendation, growthinvalidatepersonalizedpraisesuggestion, helppanelquestionposter, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, sxsave, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit
Default: help
format

Išvesties formatas.

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).
One of the following values: 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

Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached.

Type: integer
The value must be no less than 0.
Default: 0
maxage

Set the max-age HTTP cache control header to this many seconds. Errors are never cached.

Type: integer
The value must be no less than 0.
Default: 0
assert

Verify that the user is logged in (including possibly as a temporary user) if set to user, not logged in if set to anon, or has the bot user right if bot.

One of the following values: anon, bot, user
assertuser

Verify the current user is the named user.

Type: user, by any of naudotojo vardas ir Laikinas naudotojas
requestid

Any value given here will be included in the response. May be used to distinguish requests.

servedby

Include the hostname that served the request in the results.

Type: boolean (details)
curtimestamp

Prie rezultato pridėti dabartinę laiko žymę.

Type: boolean (details)
responselanginfo

Include the languages used for uselang and errorlang in the result.

Type: boolean (details)
origin

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

For authenticated requests, this must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is allowed, the Access-Control-Allow-Origin and Access-Control-Allow-Credentials headers will be set.

For non-authenticated requests, specify the value *. This will cause the Access-Control-Allow-Origin header to be set, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted.

uselang

Language to use for message translations. action=query&meta=siteinfo&siprop=languages returns a list of language codes. You can specify user to use the current user's language preference or content to use this wiki's content language.

Default: user
variant

Variant of the language. Only works if the base language supports variant conversion.

errorformat

Įspėjimo ir klaidų teksto išvesties formatas

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.
One of the following values: bc, html, none, plaintext, raw, wikitext
Default: bc
errorlang

Language to use for warnings and errors. action=query&meta=siteinfo&siprop=languages returns a list of language codes. Specify content to use this wiki's content language or uselang to use the same value as the uselang parameter.

Default: uselang
errorsuselocal

If given, error texts will use locally-customized messages from the MediaWiki namespace.

Type: boolean (details)
centralauthtoken

When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).

Pavyzdžiai:
Pagalba pagrindiniam moduliui.
api.php?action=help [open in sandbox]
Visa pagalba viename puslapyje.
api.php?action=help&recursivesubmodules=1 [open in sandbox]
Leidimas:
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Suteikta: bot ir sysop

Duomenų tipai

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.

Kreditai

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 [email protected] or file a bug report at https://phabricator.wikimedia.org/.