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/API

Fő modul

Státusz: Minden ezen a lapon látható funkciónak működnie kell, de az API jelenleg is aktív fejlesztés alatt áll, és bármikor változhat. 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.

Paraméterek:
action

Milyen műveletet hajtson végre.

block
Szerkesztő blokkolása
changeauthenticationdata
Change authentication data for the current user.
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.
cspreport
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.
delete
Lap törlése.
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.
linkaccount
Egy harmadik fél szolgáltató fiókjának kapcsolása a jelenlegi felhasználóhoz.
login
Ez a modul le lett tiltva.
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.
stashedit
Egy szerkesztés előkészítése a megosztott gyorsítótárban.
tag
Add or remove change tags from individual revisions or log entries.
unblock
Unblock a user.
undelete
Restore 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.
tokens
Elavult. Get tokens for data-modifying actions.
A következő értékek egyike: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, stashedit, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens
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

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.

Típus: egész
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
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
Alapértelmezett: 0
assert

Annak ellenőrzése, hogy a felhasználó be van-e jelentkezve user érték esetén, vagy botjog ellenőrzése bot érték esetén.

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

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

Típus: felhasználónév
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

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 whitelisted, 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

Az üzenetfordításokhoz használandó nyelv. A action=query&meta=siteinfo a siprop=languages paraméterrel 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
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: plaintext, wikitext, html, raw, none, bc
Alapértelmezett: bc
errorlang

A figyelmeztetésekhez és hibaüzenetekhez használandó nyelv. A action=query&meta=siteinfo a siprop=languages paraméterrel 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)
Példák:
Súgó megjelenítése a fő modulhoz.
api.php?action=help [open in sandbox]
Minden súgó egy lapon.
api.php?action=help&recursivesubmodules=1 [open in sandbox]
Permissions:
writeapi
a szerkesztő-API használata
Granted to: sysop, bureaucrat és inno
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, sysop és inno

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.

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.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now
alternative multiple-value separator
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.

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–present)

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