MediaWiki API súgó

Ez egy automatikusan generált MediaWiki-API-dokumentációs lap.

Dokumentáció és példák: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

General information

Állapot: A MediaWiki API egy érett és stabil interfész, ami aktív támogatásban és fejlesztésben részesül. Bár próbáljuk elkerülni, de néha szükség van visszafelé nem kompatibilis változtatásokra; iratkozz fel a mediawiki-api-announce levelezőlistára a frissítések követéséhez.

Hibás kérések: Ha az API hibás kérést kap, egy HTTP-fejlécet küld vissza „MediaWiki-API-Error” kulccsal, és a fejléc értéke és a visszaküldött hibakód ugyanarra az értékre lesz állítva. További információért lásd: API: Hibák és figyelmeztetések.

Request methods

Action API requests may use GET and POST methods. Prefer using the GET method, which allows requests to be routed to faster replica servers and responses to be cached, unless the length of the URL with parameters would exceed its length limit (commonly 8000 bytes), or a module only accepts POST requests.

Parameters for POST requests may be sent in the query part of the request URL (like in GET requests) and in the POST request body, and mixing both ways in one request is allowed. Certain parameters such as passwords must be sent in the request body. If the same parameter is sent as part of the URL and also in the request body, it must have the same value in both places.

Adattípusok

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

A logikai paraméterek a HTML jelölőnégyzeteihez hasonlóan működnek: ha a paraméter meg van adva, az igazat jelent, függetlenül a paraméter értékétől. Hamis értékhez hagyd el a paramétert teljesen.

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. The string now may be used to specify the current time.

Limits

Most API modules can accept up to 50 inputs in multivalue parameters, and can return up to 500 results per query (50 results for slow queries).

For users with the apihighlimits right (botok és adminisztrátorok), the limits are increased to 500 inputs and 5 000 results (500 results for slow queries).

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.

Fő modul

Specify the action to perform, the format of the response, and options that apply to all API modules.

Jellemző paraméterek:
action

A végrehajtandó művelet. Ezt a paramétert a kérés URL-jének részeként kell elküldeni (nem a POST törzsében), hogy megkönnyítse a hibakeresést, az elemzést, valamint a kérések útválasztását vagy szűrését.

abusefiltercheckmatch
Annak ellenőrzése, hogy egy vandálszűrő megfelel-e egy változókészletnek, egy szerkesztésnek vagy egy naplózott vandálszűrő-eseménynek.
abusefilterchecksyntax
Egy vandálszűrő szintaxisának ellenőrzése.
abusefilterevalexpression
Kiértékel egy Vandálszűrő kifejezést.
abusefilterunblockautopromote
Feloldja a felhasználó automatikus előléptetésének vandálszűrő-következmény miatti blokkolását.
abuselogprivatedetails
Egy vandálnapló-bejegyzés bizalmas részleteinek megtekintése.
acquiretempusername
Ideiglenes felhasználónév lekérése és eltárolása az aktuális munkamenetben, ha az ideiglenes fiókok létrehozása engedélyezve van, és a jelenlegi felhasználó nincs bejelentkezve. Ha már van eltárolt név, ugyanazt a nevet adja vissza.
block
Egy felhasználó blokkolása.
changeauthenticationdata
A jelenlegi felhasználó hitelesítési adatainak módosítása.
changecontentmodel
A lap tartalommodelljének megváltoztatása
checktoken
Egy action=query&meta=tokens kéréssel szerzett token érvényességének vizsgálata.
clearhasmsg
A hasmsg jelzés törlése az aktuális felhasználónak.
clientlogin
Log in to the wiki using the interactive flow.
compare
Két lap közötti különbség kiszámítása.
createaccount
Új felhasználói fiók létrehozása.
delete
Lap törlése.
echocreateevent
Értesítés kézi kiváltása egy felhasználó számára
echomarkread
A jelenlegi felhasználó értesítéseinek olvasottnak jelölése.
echomarkseen
Értesítések látottnak jelölése az aktuális felhasználó számára.
echomute
Értesítések némítása vagy engedélyezése bizonyos felhasználóktól vagy bizonyos lapokhoz kapcsolódóan.
edit
Lapok létrehozása és szerkesztése.
emailuser
E-mail küldése
expandtemplates
Minden sablon kibontása a wikiszövegben.
feedcontributions
Egy felhasználó közreműködéseinek lekérése hírcsatornaként.
feedrecentchanges
A friss változtatások lekérése hírcsatornaként.
feedwatchlist
A figyelőlista lekérése hírcsatornaként.
filerevert
Egy fájl visszaállítása egy régebbi verzióra.
help
Súgó megjelenítése a megadott modulokhoz.
imagerotate
Egy vagy több kép elforgatása.
import
Egy lap importálása egy másik wikiből vagy XML-fájlból.
languagesearch
Nyelvnevek keresése bármilyen írásrendszerrel.
linkaccount
Egy harmadik fél szolgáltató fiókjának kapcsolása a jelenlegi felhasználóhoz.
login
Bejelentkezés és hitelesítő sütik lekérése.
logout
Kijelentkezés és munkamenetadatok törlése.
managetags
A változtatáscímkék kezelése.
mergehistory
Laptörténetek egyesítése
move
Egy lap átnevezése.
opensearch
Keresés a wikin az OpenSearch protokoll segítségével.
options
A jelenlegi felhasználó beállításainak módosítása.
paraminfo
Információk lekérése API-modulokról.
parse
Tartalom feldolgozása.
patrol
Egy lap vagy lapváltozat ellenőrzöttnek jelölése (patrol).
protect
Egy lap védelmi szintjének változtatása.
purge
A gyorsítótár ürítése a megadott lapoknál.
query
Adatok lekérése a MediaWikiből és a MediaWikiről.
removeauthenticationdata
A jelenlegi felhasználó hitelesítési adatainak eltávolítása.
resetpassword
Jelszó-visszaállító e-mail küldése a felhasználónak.
revisiondelete
Változatok törlése és helyreállítása.
rollback
A lap legutóbbi változtatásának visszavonása.
rsd
Egy RSD-séma (Really Simple Discovery) exportálása.
setnotificationtimestamp
A figyelt lapok értesítési időbélyegének frissítése.
setpagelanguage
Egy lap nyelvének módosítása.
spamblacklist
Validate one or more URLs against the spam block list.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
A TemplateData kiterjesztés által tárolt adatok lekérdezése.
thank
Köszönet küldése egy szerkesztőnek.
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
unblock
Unblock a user.
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
Change a user's group membership.
validatepassword
Validate a password against the wiki's password policies.
watch
Add or remove pages from the current user's watchlist.
categorytree
Belső. A CategoryTree kiterjesztés belső modulja.
cspreport
Belső. 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.
editcheckreferenceurl
Belső. Check the status of a URL for use as a reference.
scribunto-console
Belső. Belső modul a Scribunto konzolról érkező XHR-kérések kiszolgálására.
stashedit
Belső. Egy szerkesztés előkészítése a megosztott gyorsítótárban.
visualeditor
Belső. A Parsoid szolgáltatástól kapott oldalból HTML5 oldalt készít.
visualeditoredit
Belső. HTML5 oldal elmentése a wikiben (a Parsoid szolgáltatással wikiszöveggé konvertálva).
A következő értékek egyike: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, echocreateevent, echomarkread, echomarkseen, echomute, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, 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, spamblacklist, tag, templatedata, thank, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, categorytree, cspreport, editcheckreferenceurl, scribunto-console, stashedit, visualeditor, visualeditoredit
Alapértelmezett: help
format

A kimenet formátuma.

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).
A következő értékek egyike: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Alapértelmezett: jsonfm
maxlag

A maximális késleltetés akkor használható, ha a MediaWiki replikált adatbázisfürtön van telepítve. Annak elkerülése érdekében, hogy a műveletek tovább növeljék a webhely replikációs késleltetését, ezzel a paraméterrel a kliens megvárhatja, amíg a replikációs késleltetés a megadott érték alá csökken. Túlzott késleltetés esetén a maxlag hibakód érkezik vissza egy ehhez hasonló üzenettel: Waiting for $host: $lag seconds lagged.
További információkért lásd a Kézikönyv: Maxlag paraméter lapot.

Típus: egész szám
smaxage

Az s-maxage gyorsítótár-vezérlő HTTP-fejléc beállítása ennyi másodpercre. A hibák soha nincsenek gyorsítótárazva.

Típus: egész szám
Az érték nem lehet kisebb mint 0.
Alapértelmezett: 0
maxage

Az maxage gyorsítótár-vezérlő HTTP-fejléc beállítása ennyi másodpercre. A hibák soha nincsenek gyorsítótárazva.

Típus: egész szám
Az érték nem lehet kisebb mint 0.
Alapértelmezett: 0
assert

Annak ellenőrzése, hogy a felhasználó be van-e jelentkezve (akár egy ideiglenes felhasználóval) user érték esetén, illetve ki van-e jelentkezve anon esetén, vagy botjog ellenőrzése bot érték esetén.

A következő értékek egyike: anon, bot, user
assertuser

Annak ellenőrzése, hogy a jelenlegi felhasználó a megadott-e.

Típus: felhasználó, a következők egyikével megadva: felhasználónév és Ideiglenes felhasználó
requestid

Az itt megadott bármilyen érték szerepelni fog a válaszban. Több kérés megkülönböztetésére használható.

servedby

Tartalmazza a válasz kérést kiszolgáló gép nevét.

Típus: logikai (részletek)
curtimestamp

Tartalmazza a válasz az aktuális időbélyeget.

Típus: logikai (részletek)
responselanginfo

A válasz tartalmazza uselang és errorlang paraméterekben használt nyelveket.

Típus: logikai (részletek)
origin

Ha az API-t tartományok közötti AJAX-kéréssel (CORS) éred el, állítsd ezt a kiindulási tartományra. Ennek minden előzetes (preflight) kérésben szerepelnie kell, ezért a kérés URL-jének részeként kell megadni (nem a POST törzsében).

Hitelesített kéréseknél ennek pontosan meg kell egyeznie az Origin fejlécben szereplő egyik eredettel, ezért például https://en.wikipedia.org vagy https://meta.wikimedia.org értékre kell állítani. Ha ez a paraméter nem egyezik az Origin fejléccel, a válasz 403-as állapotkódú lesz. Ha a paraméter megegyezik az Origin fejléccel, és az eredet engedélyezett, az Access-Control-Allow-Origin és az Access-Control-Allow-Credentials fejlécek be lesznek állítva.

Nem hitelesített kéréseknél a * értéket add meg. Ekkor az Access-Control-Allow-Origin fejléc be lesz állítva, az Access-Control-Allow-Credentials értéke azonban false lesz, és minden felhasználóspecifikus adat elérése korlátozott lesz.

crossorigin

Ha az API-t tartományok közötti AJAX-kéréssel (CORS) éred el, és olyan munkamenet-szolgáltatót használsz, amely védett a webhelyek közötti kérés-hamisítási (CSRF) támadásokkal szemben (például OAuth), akkor ezt használd az origin=* helyett, hogy a kérés hitelesített legyen (azaz ne kijelentkezettként történjen). Ennek minden előzetes (preflight) kérésben szerepelnie kell, ezért a kérés URL-jének részeként kell megadni (nem a POST törzsében).

Fontos, hogy a legtöbb munkamenet-szolgáltató – köztük a szabványos, sütialapú munkamenetek – nem támogatja a hitelesített CORS-kéréseket, ezért ezzel a paraméterrel nem használható.

Típus: logikai (részletek)
uselang

Az üzenetfordításokhoz használandó nyelv (az action=query&meta=siteinfo&siprop=languages visszaadja a lehetséges nyelvkódok listáját), vagy user az aktuális felhasználó, illetve content a wiki nyelvbeállításához.

Alapértelmezett: user
variant

A nyelv változata. Csak akkor működik, ha az alapnyelv támogatja a változatok közötti átalakítást.

errorformat

A figyelmeztetések és hibaüzenetek formátuma

plaintext
Wikiszöveg eltávolított HTML-címkékkel és a HTML-entitások (pl. &) kicserélésével.
wikitext
Feldolgozatlan wikiszöveg.
html
HTML
raw
Az üzenet azonosítója és paraméterei.
none
Szöveges kimenet mellőzése, csak hibakódok.
bc
A MediaWiki 1.29 előtti formátum. A errorlang és erroruselocal paraméterek figyelmen kívül lesznek hagyva.
A következő értékek egyike: bc, html, none, plaintext, raw, wikitext
Alapértelmezett: bc
errorlang

A figyelmeztetésekhez és hibaüzenetekhez használandó nyelv (az action=query&meta=siteinfo&siprop=languages visszaadja a lehetséges nyelvkódok listáját), vagy content a wiki nyelvbeállításához, illetve uselang a uselang paraméter értékéhez.

Alapértelmezett: uselang
errorsuselocal

Ha meg van adva, a hibaüzenetek a helyileg testreszabott üzeneteket fogják használni a MediaWiki névtérből.

Típus: logikai (részletek)

Készítők

API-fejlesztők:

  • Jurij Asztrahan (készítő, vezető fejlesztő 2006 szeptemberétől 2007 szeptemberéig)
  • Roan Kattouw (vezető fejlesztő 2007 szeptemberétől 2009-ig)
  • Viktor Vasziljev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (vezető fejlesztő 2013-tól 2020-ig)

A megjegyzéseidet, javaslataidat és kérdéseidet a mediawiki-api@lists.wikimedia.org címre küldheted, vagy készíthetsz egy hibajelentést a https://phabricator.wikimedia.org/ oldalon.