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
Main module
- Source: MediaWiki
- License: GPL-2.0-or-later
Stanje:MediaWiki API je zrel in stabilen vmesnik, ki se aktivno vzdržuje in izboljšuje. Čeprav se temu poskušamo izogniti, bomo morda morali občasno izvesti pomembne spremembe. Za obveščanje o posodobitvah se naročite na dopisni seznam mediawiki-api-announce.
Napačne zahteve: Ko so API-ju poslane napačne zahteve, bo poslana glava HTTP s ključem »MediaWiki-API-Error«, nato pa bosta vrednost glave in koda napake, poslani nazaj, nastavljeni na isto vrednost. Za več informacij glejte API:Napake in opozorila.
Preizkušanje: Za preprosto preizkušanje zahtevkov API glejte Special:ApiSandbox.
- action
Katero dejanje izvesti.
- abusefiltercheckmatch
- Preveri, ali se AbuseFilter ujema z naborom spremenljivk, urejanjem ali zabeleženim dogodkom AbuseFilter.
- abusefilterchecksyntax
- Preveri skladnjo filtra AbuseFilter.
- abusefilterevalexpression
- Oceni izraz filtra AbuseFilter.
- abusefilterunblockautopromote
- Odblokira uporabnika, da ne bi zaradi filtra AbuseFilter prejemal samodejnih napredovanj.
- abuselogprivatedetails
- Prikaže zasebne podatke zapisa filtra dnevnika zlorab.
- acquiretempusername
- Pridobite začasno uporabniško ime in ga shranite v trenutno sejo, če je omogočeno ustvarjanje začasnega računa in je trenutni uporabnik odjavljen. Če je bilo ime že shranjeno, vrne isto ime.
- antispoof
- Preverite uporabniško ime glede na normalizacijsko preverjanje AntiSpoof.
- block
- Block a user.
- centralauthtoken
- Pridobi centralni avtentifikacijski žeton za avtentificirano zahtevo za priloženi viki.
- centralnoticecdncacheupdatebanner
- Zahtevek za počiščenje vsebine oglasne pasice, shranjene v predpomnilniku CDN (front-end) za anonimne uporabnike, za zahtevano oglasno pasico in jezik.
- centralnoticechoicedata
- Pridobi podatke, potrebne za izbiro pasice za določen projekt in jezik
- centralnoticequerycampaign
- Pridobi vse konfiguracijske nastavitve za kampanjo.
- 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
- Izpis konfiguracije CirrusSearch.
- cirrus-mapping-dump
- Izpis preslikave CirrusSearch za ta viki.
- cirrus-profiles-dump
- Izpis profilov CirrusSearch za ta viki.
- cirrus-settings-dump
- Izpis nastavitev CirrusSearch za ta viki.
- 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
- Create a new user account.
- createlocalaccount
- Prisilno ustvari lokalni račun. Obstajati mora centralni račun.
- cxdelete
- Izbrišite osnutek prevoda, ki je bil ustvarjen z Wikiprevajalnikom.
- cxsuggestionlist
- Upravljaj seznam predlogov. Predloge lahko dodajaš ali odstranjuješ s seznama.
- cxtoken
- Pridobi žetone JWT za avtentikacijo s cxserver.
- delete
- Izbriše stran.
- deleteglobalaccount
- Izbriši globalnega uporabnika.
- discussiontoolsedit
- Objava sporočila na razpravni strani.
- discussiontoolsfindcomment
- Iskanje komentarja po ID-ju ali imenu.
- discussiontoolsgetsubscriptions
- Pridobi stanja naročenosti na predložene teme.
- discussiontoolssubscribe
- Naroči (ali odnaroči) prejemanje obvestil o temi.
- discussiontoolsthank
- Send a public thank-you notification for a comment.
- echocreateevent
- Ročna sprožitev obvestila uporabnika
- echomarkread
- Označi obvestila kot prebrana za trenutnega uporabnika.
- echomarkseen
- Označi obvestila kot ogledana za trenutnega uporabnika.
- echomute
- Izklop ali vklop obvestil določenih uporabnikov ali strani
- edit
- Ustvarjanje in urejanje strani.
- editmassmessagelist
- Urejanje seznama za pošiljanje množičnega sporočila.
- emailuser
- Email a user.
- expandtemplates
- Razširi vse predloge v vikibesedilu.
- featuredfeed
- Vrne vir izbrane vsebine.
- feedcontributions
- Returns a user's contributions feed.
- feedrecentchanges
- Vrne vir zadnjih sprememb
- feedwatchlist
- Vrne vir spiska nadzorov.
- filerevert
- Revert a file to an old version.
- globalblock
- Globalno blokirajte ali odblokirajte uporabnika.
- globalpreferenceoverrides
- Spremeni lokalne prepise za globalne nastavitve trenutnega uporabnika.
- globalpreferences
- Spremeni globalne nastavitve trenutnega uporabnika.
- globaluserrights
- Dodaj/odstrani uporabnika k/iz globalne skupine.
- growthmanagementorlist
- Upravljajte informacij na strukturiranem seznamu mentorjev (običajno shranjenem v MediaWiki:GrowthMentors.json). Ta modul lahko uporabljajo tako sedanji kot bodoči mentorji (da se dodajo ali spremenijo svoje podatke) in administratorji (za vse uporabnike).
- growthmentordashboardupdatedata
- Določite čas za izredno posodobitev modula za pregled mentorirancev na nadzorni plošči mentorja. Zaradi zmogljivosti lahko določite samo eno posodobitev na dve uri.
- growthsetmenteestatus
- Nastavitev stanja mentoriranca (omogoča mentorirancu, da omogoči/onemogoči modul mentorstva ali da se popolnoma odjavi, kar izbriše odnos mentoriranec/mentor)
- growthsetmentor
- Določi uporabnikovega mentorja. Sprememba se bo javno zabeležila.
- growthstarmentee
- Označi ali odznači mentoriranca_ko kot z zvezdico za trenutnega uporabnika_co (shranjeno zasebno in se ne zapiše v dnevnik)
- help
- Display help for the specified modules.
- homepagequestionstore
- Prodibi oblikovana vprašanja, objavljena prek modulov domače strani
- imagerotate
- This module has been disabled.
- import
- Import a page from another wiki, or from an XML file.
- jsonconfig
- Omogoča neposreden dostop do podsistema JsonConfig.
- languagesearch
- Poišče imena jezikov v kateri koli pisavi.
- linkaccount
- Link an account from a third-party provider to the current user.
- login
- Log in and get authentication cookies.
- logout
- Log out and clear session data.
- managetags
- Perform management tasks relating to change tags.
- massmessage
- Pošlje sporočilo na seznam strani.
- mergehistory
- Merge page histories.
- move
- Prestavi stran.
- opensearch
- Search the wiki using the OpenSearch protocol.
- options
- Change preferences of the current user.
- paraminfo
- Obtain information about API modules.
- parse
- Parses content and returns parser output.
- patrol
- Patrol a page or revision.
- protect
- Change the protection level of a page.
- purge
- Počisti predpomnilnik za dane naslove.
- query
- Pridobi podatke MediaWikija in o MediaWikiju.
- removeauthenticationdata
- Remove authentication data for the current user.
- resetpassword
- Send a password reset email to a user.
- revisiondelete
- Izbriše in odizbriše redakcije.
- rollback
- Undo the last edit to the page.
- rsd
- Export an RSD (Really Simple Discovery) schema.
- setglobalaccountstatus
- Skrij ali zakleni (ali razkrij ali odkleni) globalni uporabniški račun
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Change the language of a page.
- shortenurl
- Skrajša dolg URL v krajšega.
- sitematrix
- Pridobite seznam spletnih mest Wikipedije.
- spamblacklist
- Preveri enega ali več URL-jev na seznamu blokiranja smetja.
- streamconfigs
- Izpostavi konfiguracijo toka dogodkov. Vrne samo format=json s formatversion=2.
- strikevote
- Administratorjem omogoča, da izločijo ali sprejmejo glas.
- sxdelete
- Izbriši osnutek prevoda razdelka in njegove vzporedne korpuse iz podatkovne zbirke.
- tag
- Add or remove change tags from individual revisions or log entries.
- templatedata
- Pridobi podatke, ki jih shranjuje razširitev TemplateData.
- thank
- Pošlje obvestilo o zahvali urejevalcu.
- titleblacklist
- Validiranje naslova strani, imena datoteke ali uporabniškega imena glede na TitleBlacklist.
- torblock
- Preveri, ali je IP-naslov blokiran kot izhodno vozlišče Tor.
- transcodereset
- Uporabniki s pravico »transcode-reset« lahko ponastavijo in znova zaženejo opravilo prekodiranja.
- unblock
- Unblock a user.
- undelete
- Odizbris redakcij izbrisane strani.
- unlinkaccount
- Remove a linked third-party account from the current user.
- upload
- Upload a file, or get the status of pending uploads.
- userrights
- Change a user's group membership.
- validatepassword
- Validate a password against the wiki's password policies.
- watch
- Dodatek ali odstranitev strani s spiska nadzora
- webapp-manifest
- Vrne manifest »webapp«.
- webauthn
- Modul API-ja za komunikacijo med strežnikom in odjemalcem v postopku registracije/avtentikacije.
- wikilove
- Podarite drugemu uporabniku WikiLjubezen.
- bouncehandler
- Internal. Prejme zavrnjeno e-poštno sporočilo in ga obdela za obravnavo neuspešnega prejemnika.
- categorytree
- Internal. Notranji modul za razširitev CategoryTree.
- cirrus-check-sanity
- Internal. Reports on the correctness of a range of page ids in the search index
- collection
- Internal. Modul API-ja za izvajanje različnih operacij v zbirki uporabnika vikija.
- 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. Shranite stran, ki je bila ustvarjena z Wikiprevajalnikom.
- cxpublishsection
- Internal. Shrani razdelek, ustvarjeno z možnostjo prevajanja po razdelkih prevajalnika Content Translation.
- cxsave
- Internal. Ta modul omogoča shranjevanje osnutkov prevodov po razdelkih, da se prihrani pasovna širina in ustvari vzporedni korpus.
- cxsplit
- Internal. Ustvaritev in shranitev prevoda razdelka v zbirko podatkov za vsak prevedeni del danega prevoda članka
- discussiontoolscompare
- Internal. Pridobi informacije o spremembah komentarjev med dvema redakcijama strani.
- discussiontoolspageinfo
- Internal. Vrne metapodatke, potrebne za inicializacijo orodij za razprave.
- discussiontoolspreview
- Internal. Predogled sporočila na razpravni strani.
- echopushsubscriptions
- Internal. Upravljanje potisnih naročil za trenutnega uporabnika.
- editcheckreferenceurl
- Internal. Check the status of a URL for use as a reference.
- fancycaptchareload
- Internal. Pridobi nov FancyCaptcha.
- growthinvalidateimagerecommendation
- Internal. Razveljavi priporočilo slike.
- growthinvalidatepersonalizedpraisesuggestion
- Internal. Razveljavi predlog za hvalevrednega mentoriranca v modulu Personalizirana pohvala na mentorski nadzorni plošči
- helppanelquestionposter
- Internal. Obdeluje vprašanja, objavljena na panelu pomoči aktualnega uporabnika.
- jsondata
- Internal. Pridobi lokalizirane podatke JSON.
- oathvalidate
- Internal. Preveri žeton dvofaktorske avtentikacije (OATH).
- parser-migration
- Internal. Razčleni stran z dvegma različnima konfiguracijama razčlenjevalnika.
- readinglists
- Internal. Operacije zapisovanja bralnih seznamov.
- sanitize-mapdata
- Internal. Izvaja validacijo podatkov za razširitev Kartographer
- scribunto-console
- Internal. Notranji modul za strežbo zahtevkov XHR iz konzole Scribunto.
- securepollauth
- Internal. Omogoča oddaljenemu vikiju avtentikacijo uporabnikov pred odobritvijo dostopa do glasovanja na volitvah.
- stashedit
- Internal. Prepare an edit in shared cache.
- sxsave
- Internal. Shrani osnutek prevoda razdelka in shrani vzporedni korpus.
- timedtext
- Internal. Zagotovi časovno razporejeno vsebino za uporabo z elementi <track>
- ulslocalization
- Internal. Pridobi lokalizacijo ULS v predloženem jeziku.
- ulssetlang
- Internal. Posodobite želeni jezik uporabniškega vmesnika.
- visualeditor
- Internal. Vrne HTML5 za stran iz storitve Parsoid.
- visualeditoredit
- Internal. Shrani stran HTML5 v MediaWiki (s storitvijo Parsoid pretvorjeno v vikibesedilo).
- wikimediaeventsblockededit
- Internal. Beleženje podatkov o poskusih blokiranega urejanja
- 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, wikilove, 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
- Privzeto: help
- format
Oblika izhoda.
- json
- Izhodni podatki v formatu JSON.
- 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
- Izhodni podatki v formatu XML.
- xmlfm
- Output data in XML format (pretty-print in HTML).
- One of the following values: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- Privzeto: jsonfm
- maxlag
Največja zakasnitev se lahko uporabi, če je MediaWiki nameščen v gruči z replicirano podatkovno zbirko. Če želite prihraniti dejanja, ki bi povzročila večjo zakasnitev replikacije spletnega mesta, lahko s tem parametrom odjemalec počaka, da je zakasnitev replikacije manjša od določene vrednosti. V primeru prevelike zakasnitve se vrne koda napake maxlag s sporočilom, kot je Waiting for $host: $lag seconds lagged.
Za več informacij glejte Manual: Maxlag parameter.- Vtipkajte: celo število
- smaxage
Nastavite kontrolno glavo
s-maxage
predpomnenja HTTP na to število sekund. Napake se nikoli ne predpomnijo.- Vtipkajte: celo število
- The Vrednost ne sme biti manjša od 0.
- Privzeto: 0
- maxage
Nastavite kontrolno glavo
max-age
predpomnenja HTTP na to število sekund. Napake se nikoli ne predpomnijo.- Vtipkajte: celo število
- The Vrednost ne sme biti manjša od 0.
- Privzeto: 0
- assert
Preveri, da je uporabnik prijavljen (vključno z morebitno začasno prijavo), če je nastavljeno na user, da ni prijavljen, če je nastavljeno na anon, in da ima uporabniško pravico bota, če je nastavljeno na bot.
- One of the following values: anon, bot, user
- assertuser
Preveri, ali je trenutni uporabnik poimenovani uporabnik.
- Vrsta: uporabnik, ki ustreza kateremu koli od uporabniško ime in Začasen uporabnik
- requestid
V odgovor bo vključena vsaka tu navedena vrednost. Lahko se uporablja za razločevanje zahtevkov.
- servedby
V rezultate vključi ime gostitelja, ki je posredoval zahtevek.
- Type: boolean (details)
- curtimestamp
V rezultat vključi trenutni časovni žig.
- Type: boolean (details)
- responselanginfo
V rezultat vključi jezike, ki se uporabljajo za uselang in errorlang.
- Type: boolean (details)
- origin
Če do API-ja dostopate z meddomensko zahtevo AJAX (CORS), to nastavite na domeno izvora. To mora biti vključeno v vsak predpoletni zahtevek, zato mora biti del URI-ja zahtevka (in ne telesa POST).
Pri avtenticiranih zahtevkih se mora to natančno ujemati z enim od izvorov v glavi Origin, zato je to treba nastaviti na nekaj takega kot https://en.wikipedia.org ali https://meta.wikimedia.org. Če se ta parameter ne ujema z glavo
Origin
, bo vrnjen odgovor 403. Če se ta parameter ujema z glavoOrigin
in je izvor dovoljen, bosta nastavljeni glaviAccess-Control-Allow-Origin
inAccess-Control-Allow-Credentials
.Za neavtenticirane zahtevke določite vrednost *. To bo povzročilo, da bo nastavljena glava
Access-Control-Allow-Origin
, vendar boAccess-Control-Allow-Credentials
false
in bodo vsi podatki, specifični za uporabnika, omejeni.- uselang
Jezik, ki se uporablja za prevajanje sporočil. action=query&meta=siteinfo s siprop=languages vrne seznam jezikovnih kod ali določi user za uporabo jezikovne preference trenutnega uporabnika ali določi content za uporabo jezika vsebine tega vikija.
- Privzeto: user
- variant
Različica jezika. Deluje le, če osnovni jezik podpira pretvorbo variant.
- errorformat
Oblika, ki se uporablja za izpis besedila o opozorilih in napakah
- plaintext
- Wikitext with HTML tags removed and entities replaced.
- wikitext
- Nerazčlenjeno vikibesedilo.
- 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
- Privzeto: bc
- errorlang
Jezik, ki se uporablja za opozorila in napake. Določite eno od jezikovnih kod, ki jih vrne action=query&meta=siteinfo s siprop=languages ali pa določite content za uporabo jezika vsebine tega vikija ali uselang za uporabo iste vrednosti kot parameter uselang (preferenčni jezik uporabnika).
- Privzeto: uselang
- errorsuselocal
Če je podano, bodo besedila o napakah uporabljala lokalno prilagojena sporočila iz imenskega prostora MediaWiki.
- Type: boolean (details)
- centralauthtoken
Če do API-ja dostopate z meddomensko zahtevo AJAX (CORS), to uporabite za avtentikacijo kot trenutni uporabnik SUL. Za pridobitev žetona uporabite action=centralauthtoken v tem vikiju, preden izvedete zahtevek CORS. Vsak žeton se lahko uporabi samo enkrat in preteče po 10 sekundah. To je treba vključiti v vsak predpoletni zahtevek, zato mora biti vključeno v URI zahtevka (in ne v telo POST).
- Pomoč za glavni modul.
- api.php?action=help [open in sandbox]
- Vsa pomoč na eni strani.
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
Vrste podatkov
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
Vrednosti časa preteka so lahko relativne (npr. 5 months ali 2 weeks ) ali absolutne (npr. 2014-09-18T12:34:56Z). Če ne želite določiti časa preteka, uporabite infinite , indefinite, infinity ali 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/.