API-Spielwiese – ÖVSV-Wiki

Diese Seite können Sie für Versuche mit der '''MediaWiki-API''' verwenden. Die Dokumentation zur API enthält weitere Hinweise zu ihrer Nutzung. Beispiel: Den Inhalt auf einer Seite abrufen. Für weitere Beispiele eine der verfügbaren Aktionen auswählen.

main

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.

Beispiele

Auszuführende Aktion. Ausklappen

ask: API-Modul zum Abfragen eines Wikis mit der Abfragesprache von Semantic MediaWiki.
askargs: API-Modul zum Abfragen eines Wikis mit der Abfragesprache von Semantic MediaWiki als Liste von Bedingungen, Ausgabeanweisungen und Parametern.
block: Sperrt einen Benutzer.
bs-adminuser-store: Listet alle in der Datenbank vorhandenen Benutzer mitsamt vertraulicher Daten auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
bs-avatars-tasks: Hochladen, Erstellen und Festlegen von Benutzerbildern
bs-bookshelf-bookstore: Listet alle Kapitel für ein gegebenes Buch auf. Ermöglicht Sortieren, Filtern und Seitennummerierung. Implementiert „ExtJS Store“-Parameter.
bs-bookshelf-manage: Bietet Aufgaben für die Buchmanipulation.
bs-bookshelf-mass-add-page-store: Stellt Seiten bereit, die zusammen zu einem Buch hinzugefügt werden können.
bs-bookshelf-page-collection-store: Stellt eine Sammlung von Seiten bereit, die zusammen zu einem Buch hinzugefügt werden können.
bs-bookshelf-store: Listet alle Bücher auf. Ermöglicht Sortieren, Filtern und Seitennummerierung. Implementiert „ExtJS Store“-Parameter.
bs-category-store: Listet alle Kategorien auf. Erlaubt die Sortierung, Filterung und Seitennummerierung. Implementiert die Parameter „ExtJS Store“.
bs-category-treestore: Listet die Unterkategorien einer bestimmten Kategorie auf
bs-categorylinks-store: Listet alle Kategorien einer Seite inklusive eines Links zur Kategorienseite und einer Markierung für explizite und implizite Kategorien auf.
bs-checklist-available-options-store: Listet alle verfügbaren Optionen für Prüflistenvorlagen auf. Erlaubt die Sortierung, Filterung und Nummerierung. Implementiert ExtJS-Store-Parameter.
bs-checklist-tasks: Bietet Operationen für die Prüflistenerweiterung
bs-checklist-template-store: Listet alle Vorlagen auf, die gültige Prüflistenquellen sind. Erlaubt die Sortierung, Filterung und Nummerierung. Implementiert ExtJS-Store-Parameter.
bs-configmanager-store: Verwaltet Speicher
bs-configmanager-tasks: Verwaltet Aufgaben
bs-contextmenu-tasks: Stellt die Kontextmenüeinträge im Kontext zur Verfügung
bs-dashboards-store: Listet alle verfügbaren Portlets auf
bs-dashboards-tasks: Speichert die Dashboard-Konfiguration
bs-dashboards-widgets-tasks: Gibt den Inhalt für einige Dashboard-Widgets zurück
bs-expiry-store: Stellt einen Suchspeicher für Veraltungen bereit, die abgefragt werden können
bs-expiry-tasks: Stellt Aufgaben wie das Bearbeiten oder Löschen von Veraltungen bereit
bs-extendedsearch-autocomplete: Gibt die Ergebnisse der Autovervollständigung für eine gegebene Anfrage zurück
bs-extendedsearch-query: Suche im Index
bs-extendedsearch-resultrelevance: Gibt die Relevanz der Suchergebnisse zurück
bs-extendedsearch-stats: Liefert statistische Daten über die registrierten Backends und deren konfigurierte Quellen.
bs-extendedsearch-triggerupdate: Aktualisierung des Suchindex auslösen
bs-extendedsearch-type-store: Gibt die registrierten Suchtypen zurück
bs-file-tasks
bs-filebackend-store: Listet alle gespeicherten Dateien auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
bs-filehistory-store
bs-flaggedpages-store: Stellt Daten für Seiten bereit, die unter Kontrolle des Freigabemechanismus stehen
bs-group-store: Listet alle Benutzergruppen, mit Ausnahme der mit Konfigurationsparameter $wgImplicitGroups festgelegten, auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
bs-groupmanager: Bietet die Aufgaben für die Erweiterung „GroupManager“.
bs-insertfile-license-store: Listet die Lizenzen für die Erweiterung „InsertFile“ auf.
bs-insertmagic-data-store: Listet alle Elemente für das InsertMagic-Dialogfeld auf
bs-inserttemplate-store: Listet alle Vorlagen auf. Erlaubt die Sortierung, Filterung und Seitennummerierung. Implementiert die Parameter „ExtJS Store“.
bs-interwiki-store: Listet alle Interwikilinks auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
bs-interwikilinks-tasks: Stellt die Aufgaben für die Erweiterung „InterWikiLinks“ bereit.
bs-js-var-config: Stellt einen API Endpunkt zur Verfügung, über den man clientseitige Konfigurationsvariablen abfragen kann
bs-linker: Gibt Links zu Seiten zurück, die von Linker erzeugt wurden
bs-mypageassignment-store: Gibt Seiten zurück, die dem aktuellen Benutzer zugewiesen sind.
bs-namespace-store: Listet alle Namensräume und deren zusätzliche Konfiguration auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert ExtJS Store Parameter.
bs-namespace-tasks: Erlaubt die Veränderung der Namensraumkonfiguration.
bs-namespacecss-store: Listet Namensräume und ihre mögliche CSS-Quellseite auf. Implementiert „ExtJS Store“-Parameter.
bs-nsfilerepo-connector: API-Endpunkt für die Erweiterung BlueSpiceNSFileRepoConnector
bs-nsfrc-tasks: API-Endpunkt für die Erweiterung BlueSpiceNSFileRepoConnector
bs-pageaccess-store: Regelt den Zugriff auf Seitenebene
bs-pageassignable-store: Gibt die Liste der Zugewiesenen zurück
bs-pageassignment-store: Gibt Zuweisungen für die angegebene Seite zurück
bs-pageassignment-tasks: Ruft die Liste der Zuweisungen für eine angegebene Seite ab oder bearbeitet sie
bs-pageauthors-store: Listet alle Autoren einer gegebenen Seite im Kontext auf
bs-pagetemplates-store: Listet alle Vorlagen auf. Erlaubt die Sortierung, Filterung und Seitennummerierung. Implementiert die Parameter „ExtJS Store“.
bs-pagetemplates-tasks: Erlaubt die Veränderung von Seitenvorlagen
bs-permissionmanager-tasks: Stellt die Aufgaben für die Erweiterung „PermissionManager“ bereit.
bs-ping-tasks: Ping-Aufgabe, die den kontinuierlichen Austausch von Daten ermöglicht.
bs-privacy: Endpunkt für alle API-Aktionen zum Thema Datenschutz
bs-privacy-get-all-consents: Endpunkt für das Erhalten von Einwilligungsinformationen für alle Benutzer
bs-privacy-get-requests: Endpunkt für das Abrufen aller ausstehenden Anfragen
bs-qr-code: QR Code als base64 data URI für eine Seite
bs-rating-tasks: Führt allgemeine Aufgaben für die Erweiterung Rating durch
bs-ratingarticle-store: Liefert Bewertungen für Artikel
bs-ratingarticlelike-store: Liefert Empfehlungen für Artikel
bs-readconfirmation-tasks: API-Endpunkt für die Erweiterung Lesebestätigung
bs-readers-data-store: Ruft Leserinformationen einer angegebenen Seite ab.
bs-readers-page-readers-store: Ruft alle Leser aller Seiten ab
bs-readers-revision-readers-store: Ruft alle Leser aller Versionen eines Artikels ab
bs-readers-tasks: Ermöglicht häufig vorkommende Arbeitsvorgänge für Leser
bs-readers-users-store: Ruft alle Leserinformationen einer angegebenen Seite ab.
bs-recentchanges-store: Listet alle Letzten Änderungen auf. Erlaubt die Sortierung, Filterung und seitenweise Anzeige. Implementiert „Store“-Parameter.
bs-reminder-store: Stellt einen Suchspeicher für Erinnerungen bereit, die abgefragt werden können
bs-reminder-tasks: Stellt Aufgaben wie das Bearbeiten oder Löschen von Erinnerungen bereit
bs-role-permission-store: Stellt eine Rollenbeschreibung für den PermissionManager zur Verfügung
bs-rss-standards-pages-store: Gibt eine Liste mit verfügbaren Seiten für RSSFeeder zurück
bs-rssfeeder-tasks: Stellt allgemeine Aufgaben für den RSSFeeder bereit
bs-smartlist-tasks: API-Funktionen zum Bereitstellen von Portletdaten für Seiten- und Benutzerstatistiken
bs-smw-connector-ask-store: ExtJS-kompatibler Datenspeicher für die Ausführung semantischer Abfragen
bs-smw-connector-smw-property-store
bs-smw-connector-tree-ask-store
bs-social-tasks: Stellt Aufgaben wie das Bearbeiten oder Löschen von Entitäten bereit
bs-socialentity-store: Stellt einen Suchspeicher für Entitäten bereit, die abgefragt werden können
bs-socialresolve-tasks: Stellt Aufgaben für die Bearbeitung des Erledigt-Status von Entitäten bereit
bs-socialstash-tasks: Stellt Aufgaben für die Bearbeitung von verlinkten Seiten von Entitäten bereit
bs-socialtags-tasks: Stellt Aufgaben für die Bearbeitung verlinkter Seiten von Entities bereit
bs-socialtitlequery-store: Stellt Daten für Titel bereit, die von einer Entität verlinkt werden können
bs-socialtopics-tasks: Stellt Funktionen wie die automatische Einrichtung einer Diskussionsseite bereit
bs-socialwatch-tasks: Stellt Aufgaben für die Bearbeitung des Beobachten-Status von Entitäten bereit
bs-task: Stellt den API-Endpunkt zur Ausführung registrierter Aufgaben bereit
bs-templatelinks-store: Listet alle Vorlagen einer Seite inklusive eines Links zur Vorlage.
bs-titlequery-store: Listet Seitentitel und wahlweise Namensraumpräfixe entsprechend einem Abfragebegriff auf. Implementiert „ExtJS-Store“-Parameter.
bs-upload-license-store: Listet alle verfügbaren Lizenzen für einen Dateiupload auf
bs-usagetracker-store: Enthält statistische Daten zur Verwendung von Erweiterungen
bs-user-store: Listet alle in der Datenbank vorhandenen Benutzer auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
bs-userinfometa: Listet die Metadaten eines bestimmten Benutzers auf
bs-usermanager-group-store: Stellt die UserManager-Aufgaben-API für BlueSpice bereit.
bs-usermanager-tasks: Bietet Operationen für die Prüflistenerweiterung
bs-watchlist-store: Listet alle Beobachtungslisteneinträge auf. Erlaubt die Sortierung, Filterung und Nummerierung. Implementiert Speicherparameter.
bs-wikiexplorer-store: Stellt alle Daten für die Erweiterung WikiExplorer bereit
bs-wikipage-store: Listet alle Wikiseiten auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
bs-wikipage-tasks: Ermöglicht häufig vorkommende Arbeitsvorgänge für Wikiseiten
bs-wikisubpage-treestore: Listet die Unterseiten einer bestimmten Wikiseite auf
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.
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.
compare: Ruft den Unterschied zwischen zwei Seiten ab.
compoundquery
createaccount: Erstellt ein neues Benutzerkonto.
delete: Löscht eine Seite.
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.
emailuser: E-Mail an einen Benutzer senden.
embedvideo
expandtemplates: Alle Vorlagen innerhalb des Wikitextes expandieren.
ext.srf.slideshow.show
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.
flagconfig: Get basic information about review flag configuration for this site.
flexiskin-activation: Das Aktivierungsmodul
flexiskin-delete: Das Löschmodul
flexiskin-preview: Das Vorschau-Modul
flexiskin-save: Das Speichermodul
forms-form-submit: Bietet Bearbeitung über Formulare
forms-get-definitions: Ermöglicht die Abfrage der vorhandenen Formulardefinitionen
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.
opensearch: Das Wiki mithilfe des OpenSearch-Protokolls durchsuchen.
options: Die Voreinstellungen des gegenwärtigen Benutzers ändern.
pagecheckout-clear: Aktiven Seiten-Checkout aufheben
paraminfo: Ruft Informationen über API-Module ab.
parse: Parst den Inhalt und gibt die Parserausgabe zurück.
patrol: Kontrolliert eine Seite oder Version.
pfautocomplete: Von der Softwareerweiterung „Page Forms“ genutzte Autovervollständigung.
pfautoedit: Erstellt oder bearbeitet eine Seite mit einem Formular, das mit Hilfe der Softwareerweiterung „Page Forms“ definiert wird.
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.
review: Review a revision by approving or de-approving it.
reviewactivity: Advertise or de-advertise yourself as reviewing an unreviewed page or unreviewed changes.
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.
smwbrowse: API-Modul zur Unterstützung von Aktivitäten beim Browsen für unterschiedliche Objekttypen in Semantic MediaWiki.
smwinfo: API-Modul zum Abrufen statistischer Daten und weiterer Metainformationen bezüglich der Nutzung von Semantic MediaWiki.
smwtask: API-Modul zum Ausführen Semantic MediaWiki betreffender Aufgaben, das nur von der Software selbst und nicht von Außen genutzt wird.
stabilize: Ändert die Einstellungen für die Seitenstabilität.
tag: Add or remove change tags from individual revisions or log entries.
templatedata: Ruft Daten ab, die durch die Erweiterung „TemplateData“ gespeichert werden.
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.
webauthn: API-Modul zur Kommunikation zwischen Server und Client während des Registrierungs-Authentifizierungsprozesses
browsebyproperty: Veraltet. API-Modul zum Abrufen von Informationen zu einem Attribut oder einer Liste von Attributen.
browsebysubject: Veraltet. API-Modul zum Abrufen von Informationen zu einem Objekt (Seite oder Unterobjekt).
tokens: Veraltet. Get tokens for data-modifying actions.
categorytree: Intern. Internes Modul für die Erweiterung „CategoryTree“.
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.
oathvalidate: Intern. Überprüft einen Token zur Zwei-Faktor-Authentifizierung (OATH).
scribunto-console: Intern. Internes Modul zur Verarbeitung von XHR-Anfragen der Scribunto-Konsole.
stashedit: Intern. Prepare an edit in shared cache.
visualeditor: Intern. Gibt das HTML5 für eine Seite vom Parsoid-Dienst zurück.
visualeditoredit: Intern. Speichert eine HTML5-Seite zu MediaWiki (konvertiert zu Wikitext mithilfe des Parsoid-Dienstes).

Format der Ausgabe. Ausklappen

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).

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.

Den s-maxage-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gepuffert.

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

Sicherstellen, dass der Benutzer eingeloggt ist, wenn user gesetzt, nicht angemeldet, wenn auf anon gesetzt, oder das Bot-Benutzerrecht hat, wenn auf bot gesetzt.

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

Der angegebene Wert wird mit in die Antwort aufgenommen und kann zur Unterscheidung von Anfragen verwendet werden.

Namen des bearbeitenden Hosts mit zurückgeben.

Aktuellen Zeitstempel mit zurückgeben.

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

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.

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.

Zu verwendendes Format zur Ausgabe von Warnungen und Fehlertexten. Ausklappen

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.

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.

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

Abgerufen von „https://wiki.oevsv.at/wiki/Spezial:ApiSandbox“