MediaWiki-API-Hilfe

Dies ist eine automatisch generierte MediaWiki-API-Dokumentationsseite.

Dokumentation und Beispiele: https://www.mediawiki.org/wiki/API/de

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.

Parameter:

action

Auszuführende Aktion.

block: Sperrt einen Benutzer.
categorytree: Internes Modul für die Erweiterung „CategoryTree“.
changeauthenticationdata: Ändert die Authentifizierungsdaten für den aktuellen Benutzer.
checktoken: Überprüft die Gültigkeit eines über action=query&meta=tokens erhaltenen Tokens.
clearhasmsg: Löschen des hasmsg-Flags („hat Nachrichten“-Flag) für den aktuellen Benutzer.
clientlogin: Log in to the wiki using the interactive flow.
compare: Ruft den Unterschied zwischen zwei Seiten ab.
createaccount: Erstellt ein neues Benutzerkonto.
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: Löscht eine Seite.
edit: Erstellen und Bearbeiten von Seiten.
emailuser: E-Mail an einen Benutzer senden.
expandtemplates: Alle Vorlagen innerhalb des Wikitextes expandieren.
feedcontributions: Gibt einen Benutzerbeiträge-Feed zurück.
feedrecentchanges: Gibt einen Letzte-Änderungen-Feed zurück.
feedwatchlist: Gibt einen Beobachtungslisten-Feed zurück.
filerevert: Eine Datei auf eine alte Version zurücksetzen.
help: Hilfe für die angegebenen Module anzeigen.
imagerotate: Ein oder mehrere Bilder drehen.
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: Abmelden und alle Sitzungsdaten löschen.
managetags: Ermöglicht Verwaltungsaufgaben zu Änderungsmarkierungen.
mergehistory: Führt Versionsgeschichten von Seiten zusammen.
move: Eine Seite verschieben.
oathvalidate: Validate a two-factor authentication (OATH) token.
opensearch: Das Wiki mithilfe des OpenSearch-Protokolls durchsuchen.
options: Die Voreinstellungen des gegenwärtigen Benutzers ändern.
paraminfo: Ruft Informationen über API-Module ab.
parse: Parst den Inhalt und gibt die Parserausgabe zurück.
patrol: Kontrolliert eine Seite oder Version.
protect: Ändert den Schutzstatus einer Seite.
purge: Setzt den Cache der angegebenen Seiten zurück.
query: Bezieht Daten von und über MediaWiki.
removeauthenticationdata: Remove authentication data for the current user.
resetpassword: Send a password reset email to a user.
revisiondelete: Löscht und stellt Versionen wieder her.
rollback: Undo the last edit to the page.
rsd: Ein RSD-Schema (Really Simple Discovery) exportieren.
setnotificationtimestamp: Update the notification timestamp for watched pages.
setpagelanguage: Ändert die Sprache einer Seite.
spamblacklist: Überprüft eine oder mehrere URLs gegen die Spam-Blacklist.
stashedit: Prepare an edit in shared cache.
tag: Add or remove change tags from individual revisions or log entries.
titleblacklist: Überprüft einen Seiten-, Datei- oder Benutzernamen gegen die Titel-Blacklist.
unblock: Einen Benutzer freigeben.
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: Ändert die Gruppenzugehörigkeit eines Benutzers.
validatepassword: Validiert ein Passwort gegen die Passwortrichtlinien des Wikis.
watch: Add or remove pages from the current user's watchlist.
tokens: Veraltet. Get tokens for data-modifying actions.

Einer der folgenden Werte: block, categorytree, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, oathvalidate, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, spamblacklist, stashedit, tag, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens

Standard: help

format

Format der Ausgabe.

json: Daten im JSON-Format ausgeben.
jsonfm: Daten im JSON-Format ausgeben (schöngedruckt in HTML).
none: Nichts ausgeben.
php: Daten im serialisierten PHP-Format ausgeben.
phpfm: Daten im serialisierten PHP-Format ausgeben (schöngedruckt in HTML).
rawfm: Daten, einschließlich Fehlerbehebungselementen, im JSON-Format ausgeben (schöngedruckt in HTML).
xml: Daten im XML-Format ausgeben.
xmlfm: 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: $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

Standard: 0

maxage

Den max-age-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gecacht.

Typ: Ganzzahl

Standard: 0

assert

Sicherstellen, dass der Benutzer eingeloggt ist, wenn auf user gesetzt, oder Bot ist, wenn auf bot gesetzt.

Einer der folgenden Werte: user, bot

assertuser

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

Typ: Benutzername

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.

Typ: boolesch (Einzelheiten)

curtimestamp

Aktuellen Zeitstempel mit zurückgeben.

Typ: boolesch (Einzelheiten)

responselanginfo

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

Typ: boolesch (Einzelheiten)

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 weißgelistet 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 mit 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

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: Vor MediaWiki 1.29 verwendetes Format. errorlang und errorsuselocal werden ignoriert.

Einer der folgenden Werte: plaintext, wikitext, html, raw, none, bc

Standard: bc

errorlang

Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter.

Standard: uselang

errorsuselocal

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

Typ: boolesch (Einzelheiten)

Beispiele:

Hilfe für das Hauptmodul: api.php?action=help [in Spielwiese öffnen]
Alle Hilfen in einer Seite: api.php?action=help&recursivesubmodules=1 [in Spielwiese öffnen]

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.

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.

Danksagungen

API-Entwickler:

Roan Kattouw (Hauptentwickler von September 2007 bis 2009)
Victor Vasiliev
Bryan Tong Minh
Sam Reed
Yuri Astrakhan (Autor, Hauptentwickler von September 2006 bis September 2007)
Brad Jorsch (Hauptentwickler seit 2013)

Bitte sende deine Kommentare, Vorschläge und Fragen an mediawiki-api@lists.wikimedia.org oder reiche einen Fehlerbericht auf https://phabricator.wikimedia.org/ ein.

Abgerufen von „https://wiki.tuxbox-neutrino.org/wiki/Spezial:API-Hilfe“