Hölp för de <i lang="en" xml:lang="en" dir="ltr" title="Application Programming Interface">API</i> vum MehdijaWikki.

Dies ist eine automatisch generierte MediaWiki-API-Dokumentationsseite.

Dokumentation und Beispiele: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Houp_Moduhl

Status: Alle op heh dä Sigg aanjzeischte Ußwahle sullte donn, ävver et API weed jrahd noch äntwekeld un et kann sesch alle Nahslangs jädd ändere. Holl Der de Mäileng_Leß med Aanköndejonge, öm automattesch övver Neujeschkeite enfommehrt ze wähde.

Kapodde Aanfrohre: Wam_mer kapodde Aanfroheaan et API API schek, kritt mer ene HTTP-Kopp ußjejovve met däm Täx „MediaWiki-API-Error“ dren, dä mer als ene Schlößel bedraachte kann. Mih dohzoh fengk met op dä Sigg API: Fähler un Warnonge.

Parramehtere:
action

Wat för en Aufjahb.

acquiretempusername
Erfasst einen temporären Benutzernamen und speichert diesen in der aktuellen Sitzung, wenn die Erstellung von temporären Konten aktiviert und der aktuelle Benutzer abgemeldet ist. Wenn ein Name bereits gespeichert wurde, wird derselbe Name zurückgegeben.
block
Ene Metmaacher schpärre.
changeauthenticationdata
Ändert die Authentifizierungsdaten für den aktuellen Benutzer.
changecontentmodel
Inhaltsmodell einer Seite ändern
checktoken
Donn de Jölteschkeid vun enem Makkehrongsschlößel vun „action=query&meta=tokens“ pröhve.
clearhasmsg
Nemmp de Makkehrong „hasmsg“ fott vum aktoälle Metmaacher.
clientlogin
Melde dich bei dem Wiki mit dem interaktiven Ablauf an.
compare
Donn de Ongerscheide zwesche zwai Sigge beschtemme.
createaccount
Ene neue Zohjang för ene Metmaacher aanlähje.
delete
Schmieß en Sigg fott.
edit
Sigge aanlähje un verändere.
emailuser
Donn en e-mail aan dä Metmaacher schecke.
expandtemplates
Deiht alle Schablohne en Wikkitäx ömsäze.
feedcontributions
Jidd ene Kannahl met de Beijdrähsch vun enem Metmaacher uß.
feedrecentchanges
Donn ene Kannahl för de neuste Änderonge ußjävve.
feedwatchlist
Donn ene Kannahl met dä Oppaßleß zerökjävve.
filerevert
Säz en Dattei obb en ahle Väsohn zerök.
help
zeisch Hölp för de aanjejovve Moduhle.
imagerotate
Ein udder mih Bellder driehje.
import
Importiert eine Seite aus einem anderen Wiki oder von einer XML-Datei.
linkaccount
Verbindet ein Benutzerkonto von einem Drittanbieter mit dem aktuellen Benutzer.
login
Anmelden und Authentifizierungs-Cookies beziehen.
logout
Donn ußlogge un maach de Dahte övver de Sezong fott.
managetags
Verwalldongsaufjahbe em Zersammehang met Makkehronge vun Änderonge donn.
mergehistory
Väsjohne fun Sigge zosamme lähje.
move
Donn en Sigg ömbenänne
opensearch
Em Wikki söhke mem OpenSearch
options
Die Voreinstellungen des gegenwärtigen Benutzers ändern.
paraminfo
Holl Aanjahbe övver dä API ier Moduhle.
parse
Parst den Inhalt und gibt die Parserausgabe zurück.
patrol
Donn en Sigg udder Väsjohn nohkike.
protect
Änder der Siggeschoz för en Sigg.
purge
Setzt den Cache der angegebenen Seiten zurück.
query
Bezieht Daten von und über MediaWiki.
removeauthenticationdata
Entfernt die Authentifizierungsdaten für den aktuellen Benutzer.
resetpassword
Sendet eine E-Mail zum Zurücksetzen des Passworts an einen Benutzer.
revisiondelete
Versione fottschmieße un widder zeröck holle.
rollback
Setzt die letzte Bearbeitung der Seite zurück.
rsd
Ein RSD-Schema (Really Simple Discovery) exportieren.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Ändert die Sprache einer Seite.
tag
Donn Makkehronge vun einzel Väsjohne udder Enndraähsch em Logbohch fott nämme udder se verjävve.
unblock
Don en Schpärr för ene Metmaacher ophävve.
undelete
Stelle Versionen einer gelöschten Seite wieder her.
unlinkaccount
Entfernt ein verknüpftes Konto eines Drittanbieters vom aktuellen Benutzer.
upload
Donn en Dattei huh lahde, udder holl der Zohschtand vun de onfähdesch huhjelahde Datteije .
userrights
Ändert die Gruppenzugehörigkeit eines Benutzers.
validatepassword
Validiert ein Passwort gegen die Passwortrichtlinien des Wikis.
watch
Donn di Sigg en däm aktoälle Metmaacher singe Oppaßless eren udder schmihß se erus.
cspreport
Intern. Wird von Browsern verwendet, um Verstöße gegen die Content Security Policy zu melden. Dieses Modul sollte niemals verwendet werden, außer wenn es automatisch von einem CSP-konformen Webbrowser verwendet wird.
stashedit
Intern. Eine Bearbeitung im freigegebenen Cache vorbereiten.
Eijne Wäät vun dänne heh: acquiretempusername, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, 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, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, stashedit
Standard: help
format

Et Fommaht för ußzejävve.

json
Donn de Dahte em XML-Fommahd ußjävve.
jsonfm
Dahte em JSON-Fommaht ußjävve un för schöhn en et HTML wandele.
none
Donn nix ußjävve.
php
Dahte em hengernader jeschrevve PHP-Fommaht ußjävve.
phpfm
Dahte em hengernannder jeschrevve PHP-Fommaht ußjävve un för schöhn en et HTML wandele.
rawfm
Dahte, met de Aandeijle för et Fählersöhke, em JSON-Fommaht ußjävve un för schöhn en et HTML wandele.
xml
Donn de Dahte em XML-Fommahd ußjävve.
xmlfm
Donn de Dahte em XML-Fommahd schöhn jemaht met HTML ußjävve.
Eijne Wäät vun dänne heh: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Standard: jsonfm
maxlag

Der hühste zohjelohße Verzoch kann jenumme wähde, wann MehdijaWikki obb enem Knubbel Rääschner medd ene replezehrte (dadd es, lebänndesch koppehrte) Dahtebangk enschtallehrt weed. Öm kein Opdräschd aan de Dahtebangk ze scheke, di dat noch schlemmer maache dähte, kam_mer övver heh dä Parramehter et Projramm affwahde lohße, bes dat dä Verzoch vum Replezehre onger däm aanjejovve Wäät lit. Wann dä Verzoch övvermähßesch jruhs es, kritt mer dä Fähler maxlag jemälldt med ene Nohreesch esu wi Mer wahde op dä ẞööver $Maschihn un di es $Verzoch Sekonde hengerher.
Op dä Hanndbohchsigg zom Maxlag-Parramehter kam_mer noch mih zerdoh lässe.

Typ: Ganzzahl
smaxage

Säz max-age en dä Kopp_Reihj HTTP cache control obb esu vill Sekonde. Fähler wähde nimmohls faßjehallde.

Typ: Ganzzahl
Der Wert darf nicht kleiner sein als 0.
Standard: 0
maxage

Säz max-age en dä Kopp_Reihj HTTP cache control obb esu vill Sekonde. Fähler wähde nimmohls faßjehallde.

Typ: Ganzzahl
Der Wert darf nicht kleiner sein als 0.
Standard: 0
assert

Ställ sescher, dat dä Metmaacher enjelogg es (doh för jiff user en), udder ene Bot es (doh för jiff bot en).

Eijne Wäät vun dänne heh: anon, bot, user
assertuser

Überprüft, ob der aktuelle Benutzer der benannte Benutzer ist.

Typ: Benutzer, von einem der Benutzername, un Vorläufiger Benutzer
requestid

Jehde Aanjahb vun heh weed widder med ußjejovve. Esuh kam_mer einzel Affrohre ussenein hallde.

servedby

Donn däm ẞööver, dä et jedonn hät, singe Nahme med ußjävve.

Type: boolean (details)
curtimestamp

Donn de aktoälle Zigg un et Dattum med ußjävve.

Type: boolean (details)
responselanginfo

Bezieht die für uselang und errorlang verwendeten Sprachen im Ergebnis mit ein.

Type: boolean (details)
origin

Beim Zugriff auf die API mit einer Kreuz-Domain-AJAX-Anfrage (CORS) muss dies als entstehende Domäne festgelegt werden. Dies muss in jeder Vorfluganfrage mit eingeschlossen werden und deshalb ein Teil der Anfragen-URI sein (nicht des POST-Körpers).

Für authentifizierte Anfragen muss dies exakt einem der Ursprünge im Header Origin entsprechen, so dass es auf etwas wie https://de.wikipedia.org oder https://meta.wikimedia.org festgelegt werden muss. Falls dieser Parameter nicht mit dem Header Origin übereinstimmt, wird eine 403-Antwort zurückgegeben. Falls dieser Parameter mit dem Header Origin übereinstimmt und der Ursprung erlaubt ist, werden die Header Access-Control-Allow-Origin und Access-Control-Allow-Credentials festgelegt.

Gib für nicht authentifizierte Anfragen den Wert * an. Dies verursacht, dass der Header Access-Control-Allow-Origin festgelegt wird, aber Access-Control-Allow-Credentials wird false sein und alle benutzerspezifischen Daten werden beschränkt.

crossorigin

Wenn du mit einer domänenübergreifenden AJAX-Anfrage (CORS) auf die API zugreifst und einen Sitzungsanbieter verwendest, der gegen Cross-Site-Request-Forgery (CSRF)-Angriffe sicher ist (z. B. OAuth), verwende dies anstelle von origin=*, damit die Anfrage authentifiziert (d. h. nicht abgemeldet) ist. Dies muss in jeder Preflight-Anfrage enthalten sein und muss daher Teil der Anfrage-URI sein (nicht des POST-Bodys).

Beachte, dass die meisten Sitzungsanbieter, einschließlich Standard-Cookie-basierte Sitzungen, kein authentifiziertes CORS unterstützen und nicht mit diesem Parameter verwendet werden können.

Type: boolean (details)
uselang

De Schprohch för et Övversäzze vun Täxte un Nohreeschte. action=query&meta=siteinfo holle, met siprop=languages jidd en Leß met de Köözelle för Schprohche uß, udder jiff user aan, öm dem aktoälle Metmaacher sing eetzde Schprohch ze krijje, udder nemm content öm heh dämm Wikki singe Ennhald sing Schprohch ze krijje.

Standard: user
variant

Variante der Sprache. Funktioniert nur, wenn die Basissprache die Variantenkonvertierung unterstützt.

errorformat

Zu verwendendes Format zur Ausgabe von Warnungen und Fehlertexten

plaintext
Wikitext mit entfernten HTML-Tags und ersetzten Entitäten.
wikitext
Ungeparster Wikitext.
html
HTML
raw
Nachrichtenschlüssel und Parameter.
none
Keine Textausgabe, nur die Fehlercodes.
bc
Format, das vor MediaWiki 1.29 verwendet wurde. errorlang und erroruselocal werden ignoriert.
Eijne Wäät vun dänne heh: bc, html, none, plaintext, raw, wikitext
Standard: bc
errorlang

Zu verwendende Sprache für Warnungen und Fehlermeldungen. action=query&meta=siteinfo&siprop=languages mit siprop=languages gibt eine Liste von Sprachcodes zurück. Spezifiziere content, um die Inhaltssprache des Wikis zu verwenden, oder uselang, um denselben Wert wie der uselang-Parameter zu verwenden.

Standard: uselang
errorsuselocal

Falls angegeben, verwenden Fehlertexte lokalisierte Nachrichten aus dem MediaWiki-Namensraum.

Type: boolean (details)
Rääsch:
apihighlimits
Donn de Beschängkonge vun Opdrähscht aan de API kleiner maache (langsamme Opdrähscht: 500; flöcke Opdrähscht: 5000). De Beschränkonge för lahme Opdrähscht jällde och för Parramehtere met vill Wähte.
Jejovve aan: bot, un sysop

Zoote Dahte

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

Ablaufwerte können relativ (z. B. 5 months oder 2 weeks) oder absolut (z. B. 2014-09-18T12:34:56Z) sein. Verwende für kein Ablaufdatum infinite, indefinity, infinity oder 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.

Vorlagenparameter

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.

Aanäkännong för Beijdrähsch

API ier Äntweklere:

  • Roan Kattouw (Aanföhrer zigg em Säptämber 2007 bes 2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (Bejenner un Aanföhrer vum Säptämber 2006 bes Säptämber 2007)
  • Brad Jorsch (Aanföhrer vun 2013 bes hük)

Doht Ühr Aanmärkonge, Vörschlähsch un Frohre aan de Meijlengleß mediawiki-api@lists.wikimedia.org scheke, Ühr Vörschlähsch un Fählermälldong doht op https://phabricator.wikimedia.org/ ennjävve.