API:Hauptseite

Aus MediaWiki
Zur Navigation springen Zur Suche springen
Diese Seite ist eine übersetzte Version der Seite API:Main page und die Übersetzung ist zu 100 % abgeschlossen sowie aktuell.
Sprachen:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Esperanto • ‎Nederlands • ‎Taqbaylit • ‎Tiếng Việt • ‎Türkçe • ‎azərbaycanca • ‎català • ‎dansk • ‎español • ‎français • ‎italiano • ‎latviešu • ‎lietuvių • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎български • ‎русский • ‎українська • ‎עברית • ‎العربية • ‎پښتو • ‎मराठी • ‎हिन्दी • ‎ಕನ್ನಡ • ‎ไทย • ‎中文 • ‎文言 • ‎日本語 • ‎粵語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎한국어

Überblick

Diese Seite bietet einen Überblick der MediaWiki action API. Diese Seite ist für technische Beitragende und Programmentwickler, die die MediaWiki action API verstehen und verwenden wollen.

Schnellstart

Der Endpunkt

Alle Wikimedia-Wikis haben Endpunkte, die diesem Muster folgen: https://www.example.org/w/api.php

Beispiele für Wikimedia-Wiki-Endpunkte
API-Endpunkt Wiki
https://www.mediawiki.org/w/api.php MediaWiki API
https://meta.wikimedia.org/w/api.php Meta-Wiki API
https://en.wikipedia.org/w/api.php English Wikipedia API
https://nl.wikipedia.org/w/api.php Dutch Wikipedia API
https://commons.wikimedia.org/w/api.php Wikimedia Commons API
https://test.wikipedia.org/w/api.php Test Wiki API

Einführung

Die MediaWiki action API ist ein Webdienst, der den Zugriff auf einige Wikifunktionen wie Authentifizierung, Seitenoperationen und Suche ermöglicht. Sie kann Metainformation über das Wiki und den angemeldeten Benutzer zur Verfügung stellen.

Verwendungen für die MediaWiki action API

  • eine MediaWiki-Installation überwachen
  • Einen Bot erstellen, um eine MediaWiki-Installation zu verwalten
  • In einem Wiki anmelden, auf Daten zugreifen und Änderungen übermitteln, indem HTTP-Anfragen an den Webdienst gestellt werden

Erste Schritte mit dem MediaWiki action API

Bevor Du damit anfängst, die MediaWiki action API zu verwerden, solltest Du Dir dir folgenden Seiten ansehen:

API-Dokumentation


Hauptmodul

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.

Parameter:
action

Auszuführende Aktion.

abusefiltercheckmatch
Prüfen, ob ein Missbrauchsfilter mit einem Satz von Variablen, einer Bearbeitung oder einem protokollierten Missbrauchsfilter-Ereignis übereinstimmt.
abusefilterchecksyntax
Überprüft die Syntax eines Missbrauchfilters.
abusefilterevalexpression
Bewertet einen Ausdruck des Missbrauchfilters.
abusefilterunblockautopromote
Verhindert, dass ein Benutzer aufgrund einer Missbrauchsfilter-Folge Autopromotions erhält.
abuselogprivatedetails
Private Details des AbuseLog-Eintrags ansehen.
aggregategroups
Verwaltet zusammengefasste Nachrichtengruppen.
antispoof
Einen Benutzernamen in die Normalisierungsprüfung der Erweiterung AntiSpoof aufnehmen.
block
Sperrt einen Benutzer.
centralauthtoken
Rufe einen CentralAuth - Token ab, um eine authenzifierte Anfrage zu einem angefügten Wiki zu machen.
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.
centralnoticechoicedata
Ruft erforderliche Daten zur Auswahl einer Vorlage für ein angegebenes Projekt und eine Sprache ab
centralnoticequerycampaign
Ruft alle Konfigurationseinstellungen für eine Kampagne ab.
changeauthenticationdata
Ändert die Authentifizierungsdaten für den aktuellen Benutzer.
changecontentmodel
Inhaltsmodell einer Seite ändern
checktoken
Überprüft die Gültigkeit eines über action=query&meta=tokens erhaltenen Tokens.
cirrus-config-dump
Auszug der CirrusSearch-Konfiguration.
cirrus-mapping-dump
Speicherauszug der CirrusSearch-Zuordnungen für dieses Wiki.
cirrus-profiles-dump
Auszug der CirrusSearch-Profile für dieses Wiki.
cirrus-settings-dump
Auszug der CirrusSearch-Einstellungen für dieses Wiki.
clearhasmsg
Löschen des hasmsg-Flags („hat Nachrichten“-Flag) für den aktuellen Benutzer.
clientlogin
Melde dich bei dem Wiki mit dem interaktiven Ablauf an.
codediff
Fetch formatted diff from CodeReview's backing revision control system.
coderevisionupdate
Übermittelt Kommentare, den neuen Status und Markierungen einer Revision.
codeupdate
Aktualisiert die CodeReview-Repositoriumsdaten aus dem Master-Versionskontrollsystem.
compare
Ruft den Unterschied zwischen zwei Seiten ab.
createaccount
Erstellt ein neues Benutzerkonto.
createlocalaccount
Zwangsweise ein lokales Benutzerkonto erstellen
delete
Löscht eine Seite.
deleteglobalaccount
Löscht einen globalen Benutzer.
echomarkread
Markiert Benachrichtigungen für den aktuellen Benutzer als gelesen.
echomarkseen
Markiert Benachrichtigungen für den aktuellen Benutzer als gesehen.
echomute
Stummschalten oder Aufheben der Stummschaltung von Benachrichtigungen bestimmter Benutzer oder Seiten.
edit
Erstellen und Bearbeiten von Seiten.
editmassmessagelist
Bearbeitet eine Massennachrichten-Versandliste.
emailuser
E-Mail an einen Benutzer senden.
expandtemplates
Alle Vorlagen innerhalb des Wikitextes expandieren.
fancycaptchareload
Ruft ein neues FancyCaptcha ab.
featuredfeed
Gibt einen Feed mit vorgestelltem Inhalt zurück.
feedcontributions
Gibt einen Benutzerbeiträge-Feed zurück.
feedrecentchanges
Gibt einen Letzte-Änderungen-Feed zurück.
feedthreads
Gibt einen Feed der Diskussionsstränge zurück.
feedwatchlist
Gibt einen Beobachtungslisten-Feed zurück.
filerevert
Eine Datei auf eine alte Version zurücksetzen.
flow
Erlaubt auszuführende Aktionen auf Strukturierte-Diskussionen-Seiten.
flow-parsoid-utils
Konvertiert Text zwischen Wikitext und HTML.
flowthank
Sendet eine öffentliche Dankeschön-Benachrichtigung für einen Flow-Kommentar.
globalblock
Sperrt global einen Benutzer oder gibt ihn frei.
globalpreferenceoverrides
Ändert lokale Umgehungen für globale Einstellungen für den aktuellen Benutzer.
globalpreferences
Ändert die globalen Einstellungen des aktuellen Benutzers.
globaluserrights
Fügt einen Benutzer zu globalen Gruppen hinzu oder entfernt ihn aus diesen.
graph
Greift auf die Funktionalität des Graph-Tags zu.
groupreview
Nachrichtengruppen-Workflow-Status festlegen.
help
Hilfe für die angegebenen Module anzeigen.
imagerotate
Dieses Modul wurde deaktiviert.
import
Importiert eine Seite aus einem anderen Wiki oder von einer XML-Datei.
jsonconfig
Erlaubt direkten Zugriff auf das JsonConfig-Untersystem.
languagesearch
Sucht nach Sprachnamen in einem beliebigen Skript.
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.
massmessage
Sendet eine Nachricht an eine Liste von Seiten.
mergehistory
Führt Versionsgeschichten von Seiten zusammen.
move
Eine Seite verschieben.
newslettersubscribe
Abonniert einen Newsletter oder beendet ein bestehendes Abonnement.
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.
searchtranslations
Sucht nach Übersetzungen.
setglobalaccountstatus
Legt den Status eines globalen Benutzers fest.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Ändert die Sprache einer Seite.
shortenurl
Kürzt eine lange URL auf eine kürzere.
sitematrix
Ruft eine Liste der Wikimedia-Wikis ab.
spamblacklist
Überprüft eine oder mehrere URLs gegen die Spam-Negativliste.
streamconfigs
Exposes event stream config. Returns only format=json with formatversion=2.
strikevote
Erlaubt es Administratoren, eine Stimme zu streichen oder ihre Streichung zurückzunehmen.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
Ruft Daten ab, die durch die Erweiterung „TemplateData“ gespeichert werden.
thank
Sendet eine Dankeschön-Benachrichtigung an einen Bearbeiter.
threadaction
Allows actions to be taken on threads and posts in threaded discussions.
titleblacklist
Überprüft einen Seiten-, Datei- oder Benutzernamen gegen die Titel-Negativliste.
transcodereset
Benutzer mit dem Recht „transcode-reset“ können Umschlüsselungsaufträge zurücksetzen und neu starten.
translationaids
Ruft alle Übersetzungshilfen ab.
translationreview
Markiert Übersetzungen als überprüft.
translationstats
Fetch translation statistics
ttmserver
Ruft Vorschläge von den Übersetzungsspeichern ab.
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.
webapp-manifest
Gibt ein Webapp-Manifest zurück.
webauthn
API-Modul zur Kommunikation zwischen Server und Client während des Registrierungs-Authentifizierungsprozesses
wikilove
Sendet WikiLove an einen anderen Benutzer.
mobileview
Veraltet. Gibt nötige Daten für mobile Ansichten zurück.
tokens
Veraltet. Get tokens for data-modifying actions.
bouncehandler
Internal. Ruft eine Rückläufer-E-Mail ab und verarbeitet sie zur Bearbeitung des fehlgeschlagenen Empfängers.
categorytree
Internal. Internes Modul für die Erweiterung „CategoryTree“.
cspreport
Internal. 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.
discussiontools
Internal. Gibt Metadaten zurück, die zur Initialisierung der Diskussionswerkzeuge erforderlich sind.
discussiontoolsedit
Internal. Veröffentlichen einer Nachricht auf einer Diskussionsseite.
discussiontoolssubscribe
Internal. Abonnieren (oder abbestellen), um Benachrichtigungen über ein Thema zu erhalten.
jsondata
Internal. Ruft lokalisierte JSON-Daten ab.
managegroupsynchronizationcache
Internal. Manage group synchronization cache.
managemessagegroups
Internal. Hinzufügen einer Nachricht als Umbenennung einer vorhandenen Nachricht oder einer neuen Nachricht in der Gruppe während des Imports
oathvalidate
Internal. Überprüft einen Token zur Zwei-Faktor-Authentifizierung (OATH).
readinglists
Internal. Schreiboperationen für die Leseliste.
record-lint
Internal. Nimmt einen Lint-Fehler in die Datenbank auf
sanitize-mapdata
Internal. Führt eine Datenvalidierung für die Erweiterung „Kartographer“ aus
scribunto-console
Internal. Internes Modul zur Verarbeitung von XHR-Anfragen der Scribunto-Konsole.
stashedit
Internal. Prepare an edit in shared cache.
timedtext
Internal. Bietet „Timed Text“-Inhalte für die Nutzung durch $lt;track>-Elemente
translationcheck
Internal. Validiert Übersetzungen.
ulslocalization
Internal. Ruft die Lokalisierung von ULS in der angegebenen Sprache ab.
ulssetlang
Internal. Update user's preferred interface language.
visualeditor
Internal. Gibt das HTML5 für eine Seite vom Parsoid-Dienst zurück.
visualeditoredit
Internal. Speichert eine HTML5-Seite zu MediaWiki (konvertiert zu Wikitext mithilfe des Parsoid-Dienstes).
Einer der folgenden Werte: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, aggregategroups, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, codediff, coderevisionupdate, codeupdate, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, fancycaptchareload, featuredfeed, feedcontributions, feedrecentchanges, feedthreads, feedwatchlist, filerevert, flow-parsoid-utils, flow, flowthank, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, graph, groupreview, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, newslettersubscribe, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, searchtranslations, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, tag, templatedata, thank, threadaction, titleblacklist, transcodereset, translationaids, translationreview, translationstats, ttmserver, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, wikilove, mobileview, tokens, bouncehandler, categorytree, cspreport, discussiontools, discussiontoolsedit, discussiontoolssubscribe, jsondata, managegroupsynchronizationcache, managemessagegroups, oathvalidate, readinglists, record-lint, sanitize-mapdata, scribunto-console, stashedit, timedtext, translationcheck, ulslocalization, ulssetlang, visualeditor, visualeditoredit
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 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 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.

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 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: bc, html, none, plaintext, raw, wikitext
Standard: bc
errorlang

Zu verwendende Sprache für Warnungen und Fehler. action=query&meta=siteinfo mit siprop=languages gibt eine Liste von Sprachcodes zurück, oder spezifiziere content, um die Inhaltssprache des Wikis zu verwenden, oder spezifiziere 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 sich 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

Andere APIs

Wenn Du nicht findest, was Du in dieser API-Dokumentation findest: es gibt viele andere APIs für Wikimedia-Projekte. Siehe Web APIs Hub für Informationen zu anderen APIs für Wikimedia-Projekt-Daten und deren Anwendung.

Für die REST API in MediaWiki 1.35 und neuer, siehe API:REST API .

Code-Verwaltung