MediaWiki-API-Hilfe – Wikipedia (original) (raw)
Dies ist eine automatisch generierte MediaWiki-API-Dokumentationsseite.
Dokumentation und Beispiele: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Hauptmodul
- Quelle: MediaWiki
- Lizenz: GPL-2.0-or-later
Status: Die MediaWiki-API ist eine ausgereifte und stabile Schnittstelle, die aktiv unterstützt und verbessert wird. Während wir versuchen, dies zu vermeiden, können wir gelegentlich Breaking Changes erforderlich machen. Abonniere die MediaWiki-API-Ankündigungs-Mailingliste für Mitteilungen zu Aktualisierungen.
Fehlerhafte Anfragen: Wenn fehlerhafte Anfragen an die API gesendet werden, wird ein HTTP-Header mit dem Schlüssel „MediaWiki-API-Error“ gesendet. Der Wert des Headers und der Fehlercode werden auf den gleichen Wert gesetzt. Für weitere Informationen siehe API: Fehler und Warnungen.
Testen: Zum einfachen Testen von API-Anfragen, siehe Special:ApiSandbox.
Spezifische Parameter:
action
Auszuführende Aktion.
Prüfen, ob ein Missbrauchsfilter mit einem Satz von Variablen, einer Bearbeitung oder einem protokollierten Missbrauchsfilter-Ereignis übereinstimmt.
Überprüft die Syntax eines Missbrauchfilters.
Bewertet einen Ausdruck des Missbrauchfilters.
Verhindert, dass ein Benutzer aufgrund einer Missbrauchsfilter-Folge Autopromotions erhält.
Private Details des AbuseLog-Eintrags ansehen.
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.
Einen Benutzernamen in die Normalisierungsprüfung der Erweiterung AntiSpoof aufnehmen.
Sperrt einen Benutzer.
Holt einen zentralen Authtoken, um eine authentifizierte Anfrage an ein verbundenes Wiki zu erstellen.
centralnoticecdncacheupdatebanner
Fragt die Löschung des Vorlageninhalts an, der im CDN-Cache (Frontend-Cache) für anonyme Benutzer gespeichert ist, für die gewünschte Vorlage und Sprache.
Ruft erforderliche Daten zur Auswahl einer Vorlage für ein angegebenes Projekt und eine Sprache ab
Ruft alle Konfigurationseinstellungen für eine Kampagne ab.
Ändert die Authentifizierungsdaten für den aktuellen Benutzer.
Inhaltsmodell einer Seite ändern
Überprüft die Gültigkeit eines über action=query&meta=tokens erhaltenen Tokens.
Auszug der CirrusSearch-Konfiguration.
Speicherauszug der CirrusSearch-Zuordnungen für dieses Wiki.
Auszug der CirrusSearch-Profile für dieses Wiki.
Auszug der CirrusSearch-Einstellungen für dieses Wiki.
Löschen des hasmsg-Flags („hat Nachrichten“-Flag) für den aktuellen Benutzer.
Melde dich bei dem Wiki mit dem interaktiven Ablauf an.
Ruft den Unterschied zwischen zwei Seiten ab.
Erstellt ein neues Benutzerkonto.
Erstellung eines lokalen Benutzerkontos erzwingen. Das globale Konto muss existieren.
Löscht einen Übersetzungsentwurf, der mit der Softwareerweiterung „Content Translation“ erstellt wurde.
Verwaltet die Vorschlagslisten. Ergänzt Vorschläge in der Liste und entfernt sie.
Ruft JWT-Token zur Authentifizierung mit dem cxserver ab.
Löscht eine Seite.
Löscht einen globalen Benutzer.
Veröffentlichen einer Nachricht auf einer Diskussionsseite.
Einen Kommentar anhand seiner ID oder seines Namens suchen.
discussiontoolsgetsubscriptions
Ermittelt den Abonnementstatus der angegebenen Themen.
Abonnieren (oder abbestellen), um Benachrichtigungen über ein Thema zu erhalten.
Senden einer öffentliche Dankesbenachrichtigung für einen Kommentar.
Manuelles Auslösen einer Benachrichtigung an einen Benutzer
Markiert Benachrichtigungen für den aktuellen Benutzer als gelesen.
Markiert Benachrichtigungen für den aktuellen Benutzer als gesehen.
Stummschalten oder Aufheben der Stummschaltung von Benachrichtigungen bestimmter Benutzer oder Seiten.
Erstellen und Bearbeiten von Seiten.
Bearbeitet eine Massennachrichten-Versandliste.
E-Mail an einen Benutzer senden.
Alle Vorlagen innerhalb des Wikitextes expandieren.
Gibt einen Feed mit vorgestelltem Inhalt zurück.
Gibt einen Benutzerbeiträge-Feed zurück.
Gibt einen Letzte-Änderungen-Feed zurück.
Gibt einen Beobachtungslisten-Feed zurück.
Eine Datei auf eine alte Version zurücksetzen.
Erhalte grundlegende Informationen über die Konfiguration der Prüfkennzeichen für diese Seite.
Sperrt global einen Benutzer oder gibt ihn frei.
Ändert lokale Umgehungen für globale Einstellungen für den aktuellen Benutzer.
Ändert die globalen Einstellungen des aktuellen Benutzers.
Fügt einen Benutzer zu globalen Gruppen hinzu oder entfernt ihn aus diesen.
Verwalten der Informationen in der strukturierten Lotsenliste (normalerweise gespeichert in MediaWiki:GrowthMentors.json). Dieses Modul kann sowohl von aktuellen als auch zukünftigen Lotsen (um sich selbst hinzuzufügen oder ihre Daten zu ändern) und Administratoren (für alle Benutzer) verwendet werden.
growthmentordashboardupdatedata
Planen einer außerplanmäßigen Aktualisierung des Mentee-Übersichtsmoduls auf der Lotsen-Verwaltungsseite. Du kannst aus Leistungsgründen nur eine Aktualisierung alle zwei Stunden planen.
Mentee-Status festlegen (ermöglicht Mentees, das Lotsen-Modul zu aktivieren/deaktivieren oder sich vollständig abzumelden, wodurch die Mentee/Lotsen-Beziehung gelöscht wird)
Lege die Lotsin/den Lotsen des Benutzers fest. Änderungen werden öffentlich protokolliert.
Setzen oder Aufheben der Sternchen-Markierung eines Mentees durch den aktuellen Benutzer (privat gespeichert und nicht protokolliert)
Hilfe für die angegebenen Module anzeigen.
Ruft formatierte Fragen ab, die über die Startseiten-Module gepostet wurden.
Dieses Modul wurde deaktiviert.
Importiert eine Seite aus einem anderen Wiki oder von einer XML-Datei.
Erlaubt direkten Zugriff auf das JsonConfig-Untersystem.
Sucht nach Sprachnamen in einem beliebigen Skript.
Verbindet ein Benutzerkonto von einem Drittanbieter mit dem aktuellen Benutzer.
Anmelden und Authentifizierungs-Cookies beziehen.
Abmelden und alle Sitzungsdaten löschen.
Ermöglicht Verwaltungsaufgaben zu Änderungsmarkierungen.
Sendet eine Nachricht an eine Liste von Seiten.
Führt Versionsgeschichten von Seiten zusammen.
Eine Seite verschieben.
Das Wiki mithilfe des OpenSearch-Protokolls durchsuchen.
Die Voreinstellungen des gegenwärtigen Benutzers ändern.
Ruft Informationen über API-Module ab.
Parst den Inhalt und gibt die Parserausgabe zurück.
Kontrolliert eine Seite oder Version.
Ändert den Schutzstatus einer Seite.
Setzt den Cache der angegebenen Seiten zurück.
Bezieht Daten von und über MediaWiki.
Remove authentication data for the current user.
Send a password reset email to a user.
Überprüfe eine Überarbeitung, indem du sie genehmigst oder nicht genehmigst.
Löscht und stellt Versionen wieder her.
Setzt die letzte Bearbeitung der Seite zurück.
Ein RSD-Schema (Really Simple Discovery) exportieren.
Ein globales Benutzerkonto ausblenden oder sperren (bzw. einblenden oder entsperren).
Update the notification timestamp for watched pages.
Ändert die Sprache einer Seite.
Kürzt eine lange URL auf eine kürzere.
Ruft eine Liste der Wikimedia-Wikis ab.
Überprüft eine oder mehrere URLs gegen die Spam-Negativliste.
Ändert die Einstellungen für die Seitenstabilität.
Zeigt die Konfiguration des Ereignisstroms an. Gibt nur format=json mit formatversion=2 zurück.
Erlaubt es Administratoren, eine Stimme zu streichen oder ihre Streichung zurückzunehmen.
Delete the draft section translation and its parallel corpora from database.
Add or remove change tags from individual revisions or log entries.
Ruft Daten ab, die durch die Erweiterung „TemplateData“ gespeichert werden.
Sendet eine Dankeschön-Benachrichtigung an einen Bearbeiter.
Überprüft einen Seiten-, Datei- oder Benutzernamen gegen die Titel-Negativliste.
Prüfen, ob eine IP-Adresse als Tor-Ausgangsknoten gesperrt ist.
Benutzer mit dem Recht „transcode-reset“ können Umschlüsselungsaufträge zurücksetzen und neu starten.
Einen Benutzer freigeben.
Undelete revisions of a deleted page.
Remove a linked third-party account from the current user.
Upload a file, or get the status of pending uploads.
Ändert die Gruppenzugehörigkeit eines Benutzers.
Validiert ein Passwort gegen die Passwortrichtlinien des Wikis.
Add or remove pages from the current user's watchlist.
Gibt ein Webapp-Manifest zurück.
API-Modul zur Kommunikation zwischen Server und Client während des Registrierungs-Authentifizierungsprozesses.
Intern. Ruft eine Rückläufer-E-Mail ab und verarbeitet sie zur Bearbeitung des fehlgeschlagenen Empfängers.
Intern. Internes Modul für die Erweiterung „CategoryTree“.
Intern. Berichte über die Korrektheit eines Bereichs von Seiten-IDs im Suchindex
Intern. API-Modul zur Durchführung verschiedener Operationen mit der Sammlung eines Wiki-Benutzers.
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.
Intern. Check if any fast, unreviewed translation has been published recently for the current user.
Intern. Speichert eine Seite, die mithilfe der Erweiterung „Content Translation“ erstellt wurde.
Intern. Save a section created using the Content Translation extension's section translation feature.
Intern. This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.
Intern. Create and save a section translation to database, for every translated section of the given article translation
Intern. Informationen über Kommentaränderungen zwischen zwei Seitenversionen abrufen.
Intern. Gibt Metadaten zurück, die zur Initialisierung der Diskussionswerkzeuge erforderlich sind.
Intern. Vorschau einer Nachricht auf einer Diskussionsseite.
Intern. Verwaltung der Push-Abonnements für den aktuellen Benutzer.
Intern. Check the status of a URL for use as a reference.
Intern. Ruft ein neues FancyCaptcha ab.
growthinvalidateimagerecommendation
Intern. Eine Bildempfehlung ungültig machen.
growthinvalidatepersonalizedpraisesuggestion
Intern. Ungültigmachung eines Vorschlags für einen lobenswerten Mentee im Modul personalisiertes Lob auf dem Lotsen-Dashboard
Intern. Bearbeitet Fragen, die über das Help-Panel des aktuellen Benutzers eingereicht wurden.
Intern. Ruft lokalisierte JSON-Daten ab.
Intern. Überprüft einen Token zur Zwei-Faktor-Authentifizierung (OATH).
Intern. Parst eine Seite mit zwei unterschiedlichen Parser-Konfigurationen.
Intern. Schreiboperationen für die Leseliste.
Intern. Führt eine Datenvalidierung für die Erweiterung „Kartographer“ aus
Intern. Internes Modul zur Verarbeitung von XHR-Anfragen der Scribunto-Konsole.
Intern. Ermöglicht es einem Remote-Wiki, Benutzer zu authentifizieren, bevor sie Zugang zur Wahl erhalten.
Intern. Prepare an edit in shared cache.
Intern. Save the draft section translation and store the parallel corpora
Intern. Bietet „Timed Text“-Inhalte für die Nutzung durch $lt;track>-Elemente
Intern. Ruft die Lokalisierung von ULS in der angegebenen Sprache ab.
Intern. Update user's preferred interface language.
Intern. Gibt das HTML5 für eine Seite vom Parsoid-Dienst zurück.
Intern. Speichert eine HTML5-Seite zu MediaWiki (konvertiert zu Wikitext mithilfe des Parsoid-Dienstes).
Intern. Protokollierung von Informationen über blockierte Bearbeitungsversuche
Einer der folgenden Werte: 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, 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, flagconfig, 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, review, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, stabilize, 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
Standard: help
format
Format der Ausgabe.
Daten im JSON-Format ausgeben.
Daten im JSON-Format ausgeben (schöngedruckt in HTML).
Nichts ausgeben.
Daten im serialisierten PHP-Format ausgeben.
Daten im serialisierten PHP-Format ausgeben (schöngedruckt in HTML).
Daten, einschließlich Fehlerbehebungselementen, im JSON-Format ausgeben (schöngedruckt in HTML).
Daten im XML-Format ausgeben.
Daten im XML-Format ausgeben (schöngedruckt in HTML).
Einer der folgenden Werte: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Standard: jsonfm
maxlag
maxlag kann verwendet werden, wenn MediaWiki auf einem datenbankreplizierten Cluster installiert ist. Um weitere Replikationsrückstände zu verhindern, lässt dieser Parameter den Client warten, bis der Replikationsrückstand kleiner als der angegebene Wert (in Sekunden) ist. Bei einem größerem Rückstand wird der Fehlercode maxlag zurückgegeben mit einer Nachricht wie Waiting for host:host: host:lag seconds lagged.
Siehe Handbuch: Maxlag parameter für weitere Informationen.
Typ: Ganzzahl
smaxage
Den s-maxage-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gepuffert.
Typ: Ganzzahl
Der Wert darf nicht kleiner sein als 0.
Standard: 0
maxage
Den max-age-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gecacht.
Typ: Ganzzahl
Der Wert darf nicht kleiner sein als 0.
Standard: 0
assert
Sicherstellen, dass der Benutzer eingeloggt ist (eventuell auch als temporärer Benutzer), wenn user gesetzt, nicht angemeldet, wenn auf anon gesetzt, oder das Bot-Benutzerrecht hat, wenn auf bot gesetzt.
Einer der folgenden Werte: anon, bot, user
assertuser
Überprüft, ob der aktuelle Benutzer der benannte Benutzer ist.
Typ: Benutzer, von einem der Benutzername und Vorläufiger Benutzer
requestid
Der angegebene Wert wird mit in die Antwort aufgenommen und kann zur Unterscheidung von Anfragen verwendet werden.
servedby
Namen des bearbeitenden Hosts mit zurückgeben.
Type: boolean (details)
curtimestamp
Aktuellen Zeitstempel mit zurückgeben.
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.
uselang
Zu verwendende Sprache für Nachrichtenübersetzungen. action=query&meta=siteinfo&siprop=languages gibt eine Liste der Sprachcodes zurück. Gib user zum Verwenden der aktuellen Benutzerspracheinstellung oder content an, um die Inhaltssprache des Wikis zu verwenden.
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.
Einer der folgenden Werte: 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)
centralauthtoken
Wenn du mit einer domänenübergreifenden AJAX-Anfrage (CORS) auf die API zugreifst, verwendest du dies, um dich als der aktuelle SUL-Benutzer zu authentifizieren. Verwende action=centralauthtoken in diesem Wiki, um das Token abzurufen, bevor du die CORS-Anfrage stellst. Jedes Token darf nur einmal verwendet werden und verfällt nach 10 Sekunden. Dies sollte in jeder Pre-Flight-Anfrage enthalten sein und daher in der Anfrage-URI (nicht im POST-Body) enthalten sein.
Berechtigungen:
writeapi
Benutzung der API mit Schreibzugriff
Gewährt an: all, user und bot
apihighlimits
Höhere Beschränkungen in API-Anfragen verwenden (langsame Anfragen: 500; schnelle Anfragen: 5000). Die Beschränkungen für langsame Anfragen werden auch auf Mehrwertparameter angewandt.
Gewährt an: bot und sysop
Datentypen
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.
Danksagungen
API-Entwickler:
- Yuri Astrakhan (Autor, Hauptentwickler von September 2006 bis September 2007)
- Roan Kattouw (Hauptentwickler von September 2007 bis September 2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (Hauptentwickler 2013-2020)
Bitte sende deine Kommentare, Vorschläge und Fragen an mediawiki-api@lists.wikimedia.org oder reiche einen Fehlerbericht auf https://phabricator.wikimedia.org/ ein.