Dies ist eine automatisch generierte MediaWiki-API-Dokumentationsseite.
Dokumentation und Beispiele:
https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Hauptmodul
Status:
Die MediaWiki-API ist eine ausgereifte und stabile Schnittstelle, die aktiv unterstutzt und verbessert wird. Wahrend wir versuchen, dies zu vermeiden, konnen wir gelegentlich Breaking Changes erforderlich machen. Abonniere die
MediaWiki-API-Ankundigungs-Mailingliste
fur Mitteilungen zu Aktualisierungen.
Fehlerhafte Anfragen:
Wenn fehlerhafte Anfragen an die API gesendet werden, wird ein HTTP-Header mit dem Schlussel ?MediaWiki-API-Error“ gesendet. Der Wert des Headers und der Fehlercode werden auf den gleichen Wert gesetzt. Fur weitere Informationen siehe
API: Fehler und Warnungen
.
Testen:
Zum einfachen Testen von API-Anfragen, siehe
Special:ApiSandbox
.
Spezifesch Parameteren:
- action
Auszufuhrende Aktion.
- abusefiltercheckmatch
- Prufen, ob ein Missbrauchsfilter mit einem Satz von Variablen, einer Bearbeitung oder einem protokollierten Missbrauchsfilter-Ereignis ubereinstimmt.
- abusefilterchecksyntax
- Uberpruft die Syntax eines Missbrauchfilters.
- abusefilterevalexpression
- Bewertet einen Ausdruck des Missbrauchfilters.
- abusefilterunblockautopromote
- Verhindert, dass ein Benutzer aufgrund einer Missbrauchsfilter-Folge Autopromotions erhalt.
- abuselogprivatedetails
- Private Details des AbuseLog-Eintrags ansehen.
- acquiretempusername
- Erfasst einen temporaren Benutzernamen und speichert diesen in der aktuellen Sitzung, wenn die Erstellung von temporaren Konten aktiviert und der aktuelle Benutzer abgemeldet ist. Wenn ein Name bereits gespeichert wurde, wird derselbe Name zuruckgegeben.
- antispoof
- Einen Benutzernamen in die Normalisierungsprufung der Erweiterung AntiSpoof aufnehmen.
- block
- E Benotzer sparen.
- centralauthtoken
- Holt einen zentralen Authtoken, um eine authentifizierte Anfrage an ein verbundenes Wiki zu erstellen.
- centralnoticecdncacheupdatebanner
- Fragt die Loschung des Vorlageninhalts an, der im CDN-Cache (Frontend-Cache) fur anonyme Benutzer gespeichert ist, fur die gewunschte Vorlage und Sprache.
- centralnoticechoicedata
- Ruft erforderliche Daten zur Auswahl einer Vorlage fur ein angegebenes Projekt und eine Sprache ab
- centralnoticequerycampaign
- Ruft alle Konfigurationseinstellungen fur eine Kampagne ab.
- changeauthenticationdata
- Andert die Authentifizierungsdaten fur den aktuellen Benutzer.
- changecontentmodel
- Inhaltsmodell einer Seite andern
- checktoken
- Uberpruft die Gultigkeit eines uber
action=query&meta=tokens
erhaltenen Tokens.
- cirrus-config-dump
- Auszug der CirrusSearch-Konfiguration.
- cirrus-mapping-dump
- Speicherauszug der CirrusSearch-Zuordnungen fur dieses Wiki.
- cirrus-profiles-dump
- Auszug der CirrusSearch-Profile fur dieses Wiki.
- cirrus-settings-dump
- Auszug der CirrusSearch-Einstellungen fur dieses Wiki.
- clearhasmsg
- Loschen des
hasmsg
-Flags (?hat Nachrichten“-Flag) fur den aktuellen Benutzer.
- clientlogin
- Melde dich bei dem Wiki mit dem interaktiven Ablauf an.
- compare
- Ruft den Unterschied zwischen zwei Seiten ab.
- createaccount
- En neie Benotzerkont uleeen.
- createlocalaccount
- Erstellung eines lokalen Benutzerkontos erzwingen. Das globale Konto muss existieren.
- cxdelete
- Loscht einen Ubersetzungsentwurf, der mit der Softwareerweiterung ?Content Translation“ erstellt wurde.
- cxsuggestionlist
- Verwaltet die Vorschlagslisten. Erganzt Vorschlage in der Liste und entfernt sie.
- cxtoken
- Ruft JWT-Token zur Authentifizierung mit dem cxserver ab.
- delete
- Eng Sait laschen.
- deleteglobalaccount
- E globale Benotzer laschen.
- discussiontoolsedit
- Veroffentlichen einer Nachricht auf einer Diskussionsseite.
- discussiontoolsfindcomment
- Einen Kommentar anhand seiner ID oder seines Namens suchen.
- discussiontoolsgetsubscriptions
- Ermittelt den Abonnementstatus der angegebenen Themen.
- discussiontoolssubscribe
- Abonnieren (oder abbestellen), um Benachrichtigungen uber ein Thema zu erhalten.
- discussiontoolsthank
- Senden einer offentliche Dankesbenachrichtigung fur einen Kommentar.
- echocreateevent
- Manuelles Auslosen einer Benachrichtigung an einen Benutzer
- echomarkread
- Markiert Benachrichtigungen fur den aktuellen Benutzer als gelesen.
- echomarkseen
- Markiert Benachrichtigungen fur den aktuellen Benutzer als gesehen.
- echomute
- Stummschalten oder Aufheben der Stummschaltung von Benachrichtigungen bestimmter Benutzer oder Seiten.
- edit
- Saiten uleeen an anneren.
- editmassmessagelist
- Bearbeitet eine Massennachrichten-Versandliste.
- emailuser
- Engem Benotzer eng E-Mail schecken.
- expandtemplates
- Alle Vorlagen innerhalb des Wikitextes expandieren.
- featuredfeed
- Gibt einen Feed mit vorgestelltem Inhalt zuruck.
- feedcontributions
- Gibt einen Benutzerbeitrage-Feed zuruck.
- feedrecentchanges
- Gibt einen Letzte-Anderungen-Feed zuruck.
- feedwatchlist
- Gibt einen Beobachtungslisten-Feed zuruck.
- filerevert
- Eine Datei auf eine alte Version zurucksetzen.
- globalblock
- E Benotzer global sparen oder d'Spar global ophiewen.
- globalpreferenceoverrides
- Andert lokale Umgehungen fur globale Einstellungen fur den aktuellen Benutzer.
- globalpreferences
- Dei global Astellunge vum aktuelle Benotzer anneren.
- globaluserrights
- Fugt einen Benutzer zu globalen Gruppen hinzu oder entfernt ihn aus diesen.
- growthmanagementorlist
- Verwalten der Informationen in der strukturierten Lotsenliste (normalerweise gespeichert in
MediaWiki:GrowthMentors.json
). Dieses Modul kann sowohl von aktuellen als auch zukunftigen Lotsen (um sich selbst hinzuzufugen oder ihre Daten zu andern) und Administratoren (fur alle Benutzer) verwendet werden.
- growthmentordashboardupdatedata
- Planen einer außerplanmaßigen Aktualisierung des Mentee-Ubersichtsmoduls auf der Lotsen-Verwaltungsseite. Du kannst aus Leistungsgrunden nur eine Aktualisierung alle zwei Stunden planen.
- growthsetmenteestatus
- Mentee-Status festlegen (ermoglicht Mentees, das Lotsen-Modul zu aktivieren/deaktivieren oder sich vollstandig abzumelden, wodurch die Mentee/Lotsen-Beziehung geloscht wird)
- growthsetmentor
- Lege die Lotsin/den Lotsen des Benutzers fest. Anderungen werden offentlich protokolliert.
- growthstarmentee
- Setzen oder Aufheben der Sternchen-Markierung eines Mentees durch den aktuellen Benutzer (privat gespeichert und nicht protokolliert)
- help
- Hilfe fur die angegebenen Module anzeigen.
- homepagequestionstore
- Ruft formatierte Fragen ab, die uber die Startseiten-Module gepostet wurden.
- imagerotate
- Dese Modul gouf ausgeschalt.
- 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 loschen.
- managetags
- Ermoglicht Verwaltungsaufgaben zu Anderungsmarkierungen.
- massmessage
- Sendet eine Nachricht an eine Liste von Seiten.
- mergehistory
- Historique vun de Saite fusioneieren.
- move
- Eng Sait reckelen.
- opensearch
- Das Wiki mithilfe des OpenSearch-Protokolls durchsuchen.
- options
- Astellunge vum aktuelle Benotzer anneren.
- paraminfo
- Ruft Informationen uber API-Module ab.
- parse
- Parst den Inhalt und gibt die Parserausgabe zuruck.
- patrol
- Kontrolliert eine Seite oder Version.
- protect
- Andert den Schutzstatus einer Seite.
- purge
- Setzt den Cache der angegebenen Seiten zuruck.
- query
- Bezieht Daten von und uber MediaWiki.
- removeauthenticationdata
- Remove authentication data for the current user.
- resetpassword
- Send a password reset email to a user.
- revisiondelete
- Versioune laschen a restaureieren.
- rollback
- Dei lescht Annerung vun der Sait zrecksetzen.
- rsd
- Ein RSD-Schema (Really Simple Discovery) exportieren.
- setglobalaccountstatus
- Ein globales Benutzerkonto ausblenden oder sperren (bzw. einblenden oder entsperren).
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- D'Sprooch vun enger Sait anneren
- shortenurl
- Kurzt eine lange URL auf eine kurzere.
- sitematrix
- Ruft eine Liste der Wikimedia-Wikis ab.
- spamblacklist
- Uberpruft eine oder mehrere URLs gegen die Spam-Negativliste.
- streamconfigs
- Zeigt die Konfiguration des Ereignisstroms an. Gibt nur format=json mit formatversion=2 zuruck.
- strikevote
- Erlaubt es Administratoren, eine Stimme zu streichen oder ihre Streichung zuruckzunehmen.
- sxdelete
- Delete the draft section translation and its parallel corpora from database.
- 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 Dankeschon-Benachrichtigung an einen Bearbeiter.
- titleblacklist
- Uberpruft einen Seiten-, Datei- oder Benutzernamen gegen die Titel-Negativliste.
- torblock
- Prufen, ob eine IP-Adresse als Tor-Ausgangsknoten gesperrt ist.
- transcodereset
- Benutzer mit dem Recht ?transcode-reset“ konnen Umschlusselungsauftrage zurucksetzen und neu starten.
- unblock
- D'Spar vun engem Benotzer ophiewen.
- undelete
- Undelete 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
- Andert die Gruppenzugehorigkeit 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 zuruck.
- webauthn
- API-Modul zur Kommunikation zwischen Server und Client wahrend des Registrierungs-Authentifizierungsprozesses.
- bouncehandler
- Intern
Ruft eine Rucklaufer-E-Mail ab und verarbeitet sie zur Bearbeitung des fehlgeschlagenen Empfangers.
- categorytree
- Intern
Internes Modul fur die Erweiterung ?CategoryTree“.
- cirrus-check-sanity
- Intern
Berichte uber die Korrektheit eines Bereichs von Seiten-IDs im Suchindex
- collection
- Intern
API-Modul zur Durchfuhrung verschiedener Operationen mit der Sammlung eines Wiki-Benutzers.
- cspreport
- Intern
Wird von Browsern verwendet, um Verstoß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.
- cxcheckunreviewed
- Intern
Check if any fast, unreviewed translation has been published recently for the current user.
- cxpublish
- Intern
Speichert eine Seite, die mithilfe der Erweiterung ?Content Translation“ erstellt wurde.
- cxpublishsection
- Intern
Save a section created using the Content Translation extension's section translation feature.
- cxsave
- Intern
This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.
- cxsplit
- Intern
Create and save a section translation to database, for every translated section of the given article translation
- discussiontoolscompare
- Intern
Informationen uber Kommentaranderungen zwischen zwei Seitenversionen abrufen.
- discussiontoolspageinfo
- Intern
Gibt Metadaten zuruck, die zur Initialisierung der Diskussionswerkzeuge erforderlich sind.
- discussiontoolspreview
- Intern
Vorschau einer Nachricht auf einer Diskussionsseite.
- echopushsubscriptions
- Intern
Verwaltung der Push-Abonnements fur den aktuellen Benutzer.
- editcheckreferenceurl
- Intern
Check the status of a URL for use as a reference.
- fancycaptchareload
- Intern
Ruft ein neues FancyCaptcha ab.
- growthinvalidateimagerecommendation
- Intern
Eine Bildempfehlung ungultig machen.
- growthinvalidatepersonalizedpraisesuggestion
- Intern
Ungultigmachung eines Vorschlags fur einen lobenswerten Mentee im Modul personalisiertes Lob auf dem Lotsen-Dashboard
- helppanelquestionposter
- Intern
Bearbeitet Fragen, die uber das Help-Panel des aktuellen Benutzers eingereicht wurden.
- jsondata
- Intern
Ruft lokalisierte JSON-Daten ab.
- oathvalidate
- Intern
Uberpruft einen Token zur Zwei-Faktor-Authentifizierung (OATH).
- parser-migration
- Intern
Analyseiert (parst) eng Sait mat zwou verschiddenen Tidy-Astellungen.
- readinglists
- Intern
Schreiboperationen fur die Leseliste.
- sanitize-mapdata
- Intern
Fuhrt eine Datenvalidierung fur die Erweiterung ?Kartographer“ aus
- scribunto-console
- Intern
Internes Modul zur Verarbeitung von XHR-Anfragen der Scribunto-Konsole.
- securepollauth
- Intern
Ermoglicht es einem Remote-Wiki, Benutzer zu authentifizieren, bevor sie Zugang zur Wahl erhalten.
- stashedit
- Intern
Prepare an edit in shared cache.
- sxsave
- Intern
Save the draft section translation and store the parallel corpora
- timedtext
- Intern
Bietet ?Timed Text“-Inhalte fur die Nutzung durch $lt;track>-Elemente
- ulslocalization
- Intern
Ruft die Lokalisierung von ULS in der angegebenen Sprache ab.
- ulssetlang
- Intern
Update user's preferred interface language.
- visualeditor
- Intern
Gibt das HTML5 fur eine Seite vom Parsoid-Dienst zuruck.
- visualeditoredit
- Intern
Speichert eine HTML5-Seite zu MediaWiki (konvertiert zu Wikitext mithilfe des Parsoid-Dienstes).
- wikimediaeventsblockededit
- Intern
Protokollierung von Informationen uber 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
,
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
,
revisiondelete
,
rollback
,
rsd
,
setglobalaccountstatus
,
setnotificationtimestamp
,
setpagelanguage
,
shortenurl
,
sitematrix
,
spamblacklist
,
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.
- json
- Daten im JSON-Format ausgeben.
- jsonfm
- Daten im JSON-Format ausgeben (schongedruckt in HTML).
- none
- Nichts ausgeben.
- php
- Daten im serialisierten PHP-Format ausgeben.
- phpfm
- Daten im serialisierten PHP-Format ausgeben (schongedruckt in HTML).
- rawfm
- Daten, einschließlich Fehlerbehebungselementen, im JSON-Format ausgeben (schongedruckt in HTML).
- xml
- Daten im XML-Format ausgeben.
- xmlfm
- Daten im XML-Format ausgeben (schongedruckt 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 Replikationsruckstande zu verhindern, lasst dieser Parameter den Client warten, bis der Replikationsruckstand kleiner als der angegebene Wert (in Sekunden) ist. Bei einem großerem Ruckstand wird der Fehlercode
maxlag
zuruckgegeben mit einer Nachricht wie
Waiting for $host: $lag seconds lagged
.
Siehe
Handbuch: Maxlag parameter
fur 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 temporarer 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
Iwwerpreifen ob den aktuelle Benotzer de Benotzer mat deem Numm ass.
- Typ: Benutzer, von einem der Benotzernumm a(n) Temporare Benotzer
- requestid
Der angegebene Wert wird mit in die Antwort aufgenommen und kann zur Unterscheidung von Anfragen verwendet werden.
- servedby
Namen des bearbeitenden Hosts mit zuruckgeben.
- Type: boolean (
details
)
- curtimestamp
Den aktuellen Zaitstempel an d'Resultat integreieren.
- Type: boolean (
details
)
- responselanginfo
Bezieht die fur
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 Domane festgelegt werden. Dies muss in jeder Vorfluganfrage mit eingeschlossen werden und deshalb ein Teil der Anfragen-URI sein (nicht des POST-Korpers).
Fur authentifizierte Anfragen muss dies exakt einem der Ursprunge 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
ubereinstimmt, wird eine 403-Antwort zuruckgegeben. Falls dieser Parameter mit dem Header
Origin
ubereinstimmt und der Ursprung erlaubt ist, werden die Header
Access-Control-Allow-Origin
und
Access-Control-Allow-Credentials
festgelegt.
Gib fur 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 beschrankt.
- uselang
Zu verwendende Sprache fur Nachrichtenubersetzungen.
action=query&meta=siteinfo&siprop=languages
gibt eine Liste der Sprachcodes zuruck. 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 unterstutzt.
- errorformat
Zu verwendendes Format zur Ausgabe von Warnungen und Fehlertexten
- plaintext
- Wikitext mit entfernten HTML-Tags und ersetzten Entitaten.
- wikitext
- Ungeparster Wikitext.
- html
- HTML
- raw
- Nachrichtenschlussel 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 fur Warnungen und Fehlermeldungen.
action=query&meta=siteinfo&siprop=languages
mit
siprop=languages
gibt eine Liste von Sprachcodes zuruck. 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 domanenubergreifenden 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 verfallt nach 10 Sekunden. Dies sollte in jeder Pre-Flight-Anfrage enthalten sein und daher in der Anfrage-URI (nicht im POST-Body) enthalten sein.
Autorisatiounen:
- writeapi
- API benotze fir d'Wiki z'anneren
- Gewahrt an: all, user a(n) bot
- apihighlimits
- Hohere Beschrankungen in API-Anfragen verwenden (langsame Anfragen: 500; schnelle Anfragen: 5000). Die Beschrankungen fur langsame Anfragen werden auch auf Mehrwertparameter angewandt.
- Gewahrt an: bot a(n) 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 konnen relativ (z. B.
5 months
oder
2 weeks
) oder absolut (z. B.
2014-09-18T12:34:56Z
) sein. Verwende fur 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
-
15
T
14
:
56
:
00
Z
. 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, Vorschlage und Fragen an mediawiki-api@lists.wikimedia.org
oder reiche einen Fehlerbericht auf
https://phabricator.wikimedia.org/
ein.