API:Main page/de


 * This is an overview of the "action" API. See the menu bar on the right for more detailed sub-topics and other APIs.

The MediaWiki action API is a web service that provides convenient access to wiki features, data, and meta-data over HTTP, via a URL usually at. Clients request particular "actions" by specifying an  parameter, mainly   to get information. It was known as  the  MediaWiki API, but there are now other web APIs available that connect to MediaWiki such as RESTBase and the Wikidata query service.

Einführung
Wenn Sie stattdessen auf der Suche nach einer "internen API" oder "PHP API" sind, sehen Sie sich die Erweiterungsschnittstelle an, die PHP-Entwicklern erlaubt, neue Funktionen zu einer MediaWiki-Installation hinzuzufügen.

The MediaWiki action API can be used to monitor a MediaWiki installation, or create a bot to automatically maintain one. Es bietet direkten und einfachen High-Level-Zugriff auf die Daten in der MediaWiki-Datenbank. Client-Programme (z.B. Bots) können diese API nutzen, um sich einzuloggen, Daten abzurufen und Änderungen automatisch abzuschicken, indem HTTP-Anfragen an den Web-Service gemacht werden. Unterstützte Clients inklusive Bots, dünn webbasierte JavaScript-Clients wie z.B. Navigation Popups und LiveRC, Endbenutzer-Anwendungen wie z.B. Vandal Fighter und andere Webseiten ([//tools.wmflabs.org Tool Labs]'s Dienstprogramme).

Auf neue MediaWiki-Installationen wird der Web-Service standardmäßig aktiviert, aber der Administrator kann sie deaktivieren.

MediaWiki hat zwei weitere nach außen gewandte Schnittstellen:


 * Die Special:Export Seite, die Bulk-Export von Wiki-Inhalten als XML bietet. Lesen Sie den Hilfeartikel übers Exportieren auf meta.wikimedia.org für weitere Informationen.
 * Die Standard-Web-basierte Schnittstelle (die Sie wahrscheinlich gerade benutzen). Lesen Sie  für Informationen zur Verwendung der web-basierten Schnittstelle.

Ein einfaches Beispiel
Diese URL teilt der Internetservice API der englischen Wikipedia mit, dir den Inhalt der Hauptseite zu senden:

https://en.wikipedia.org/w/api.php?action=query&titles=Main%20Page&prop=revisions&rvprop=content&format=json

Verwenden Sie eine beliebige Programmiersprache um eine HTTP-GET-Anfrage für die URL zu senden (oder besuchen Sie einfach diesen Link in Ihren Browser), und Sie werden ein JSON-Dokument erhalten, welches das aktuelle Wiki-Markup für die Seite mit dem Titel „Main Page“ enthält. Änderung des Formats zu   liefert für die Fehlersuche gut geeignete "pretty-print" Version in HTML.

Zerlegen wir diese URL in ihre Bestandteile, um die Funktionsweise zu demonstrieren.

Der Endpunkt
Dies ist der Endpunkt Er ist so etwas, wie die Hauptseite der MediaWiki web service API. This URL is the base URL for English Wikipedia's API, just as  is the base URL for its web site.

Wenn Du ein Programm schreibst, dass auf die API der englischsprachigen Wikipedia zurückgreift, wird jede URL, die Du verwendest, mit dieser Basis-URL beginnen. Wenn Du eine andere MediaWiki Installation verwendest, musst Du zunächst ihren Endpunkt herausfinden und stattdessen diese URL verwenden. Alle Wikimedia Wikis haben Endpunkte, die diesem Muster folgen:

Seit, steht RSD für das Auffinden des Endpunktes zur Verfügung: Suche  im HTML Quellcode einer beliebigen Seite und extrahiere die   URL; der Link enthält weitere Informationen. Für dieses Wiki lautet sie zum Beispiel:

Andernfalls gibt es keinen sicheren Weg den Endpunkt eines Wikis zu lokalisieren. Falls Du Glück hast, ist der volle Pfad zu index.php nicht unter eigenartigen rewrite rules versteckt, sodass Du lediglich dem edit (oder history) Link folgen und index.php (etc.) mit api.php ersetzen musst, oder es ist möglich den Standard script path (wie ) zu verwenden.

Nun weiter zu den einzelnen Parametern der Abfrage.

Das Format
This tells the API that we want data to be returned in JSON format. Vielleicht möchtest Du auch  ausprobieren, um eine HTML Version zu erhalten, die gut für die Fehlersuche ist. Die API unterstützt weitere output formats, wie XML und native PHP, allerdings gibt es Pläne weniger populäre Formate zu entfernen (T95715), sodass Du sie eventuell nicht verwenden möchtest.

Die Aktion
The MediaWiki web service API implements dozens of actions and extensions implement many more; the dynamically generated API help documents all available actions on a wiki. In diesem Fall, benutzen wir die Aktion "query" um Informationen zu erhalten. Die Aktion "query" ist eine der wichtigsten Aktionen der API, und sie hat extensive documentation of its own|umfangreiche Dokumentation. Was folgt ist lediglich die Erklärung eines einzigen Beispiels.

Aktionsspezifische Parameter
Der Rest der Beispiel-URL enthält Parameter, die von der "query" Aktion verwendet werden. Hier teilen wir der web service API mit, dass wir an Informationen über eine Wiki Seite mit dem Namen "Main Page" interessiert sind. (Die %20 rührt von Prozentcodierung der Leerzeichen her.) If you need to query multiple pages, put them all in one request to optimize network and server resources:. Siehe query documentation für weitere Details.

You can request many kinds of information, or properties, about a page. This parameter tells the web service API that we want information about a particular revision of the page. Da wir keine Angabe über eine spezielle Revision machen, wird uns die API Informationen über die letzte Revision liefen; die Hauptseite der Wikipedia in ihrem aktuellen Stand.

Dieser Parameter teilt der web service API mit, dass wir den Inhalt der letzten Revision der Seite möchten. Wenn wir stattdessen  übergeben würden, bekämen wir den neuesten Seiteninhalt "und" den Namen des Benutzers, der die neueste Version schuf.

Noch einmal, dies ist lediglich ein Beispiel. Queries are explained in more detail here, and the API reference lists all the possible actions, all the possible values for, and so on.



Erste Schritte
Bevor Du beginnst, die MediaWiki web service API zu verwenden, stelle sicher, dass Du die folgenden Dokumente gelesen hast.


 * The FAQ.
 * The page about input and output formats
 * The page about errors and warnings
 * Any policies that apply to the wiki you want to access, such as Wikimedia Foundation wikis' terms of use, trademark policy. These terms apply to you when you access or edit using the API, just as they do when you use your web browser.

Beyond that point, what you need to read depends on what you want to do. The right-hand menu links to detailed, task-specific documentation, and some more general guidelines are given below.

Identifying your client
When you make HTTP requests to the MediaWiki web service API, be sure to specify a  header that properly identifies your client. Don't use the default  provided by your client library, but make up a custom header that identifies your script or service and provides some type of means of contacting you (e.g., an e-mail address).

An example User-Agent string might look like: MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4

On Wikimedia wikis, if you don't supply a  header, or you supply an empty or generic one, your request will fail with an HTTP 403 error (cf. User-Agent policy). Other MediaWiki installations may have similar policies.

If you are calling the API from browser-based JavaScript, you won't be able to influence the  header: the browser will use its own. To work around this, use the  header:

In PHP, you can identify your user-agent with code such as this:

Or if you use cURL:

Logging in
Your client will probably need to log in to MediaWiki, possibly via its own user account. See the login manual page for details.

API etiquette
Please also read: API:Etiquette

If your requests obtain data that can be cached for a while, you should take steps to cache it, so you don't request the same data over and over again. More information about rate-limiting, concurrency, and general API etiquette can be found at API:Etiquette. Some clients may be able to cache data themselves, but for others (particularly JavaScript clients), this is not possible.

Per the HTTP specification, POST requests cannot be cached. Therefore, whenever you're reading data from the web service API, you should use GET requests, not POST.

Also note that a request cannot be served from cache unless the URL is exactly the same. If you make a request for, and cache the result, then a request for   will not go through the cache — even though MediaWiki returns the same data!

You should take care to normalize the URLs you send to the MediaWiki web service, so that slightly different user input won't cause you to waste time on unnecessary HTTP requests. You can normalize a list of page titles by removing duplicates and sorting the titles alphabetically. Similar techniques will work for other kinds of data.

Useful links
The menu bar on the right side of this page links to more detailed, task-specific documentation. Here are some links having to do with the API as a whole:
 * The API sandbox available on all Wikimedia wikis makes it easy to try out different actions interactively.
 * [//en.wikipedia.org/w/api.php The API reference] contains automatically-generated descriptions of all actions and parameters.
 * Hook into Wikipedia information using PHP and the MediaWiki API (IBM developerWorks article, 17 May 2011)
 * Hook into Wikipedia using Java and the MediaWiki API (6 April 2012)
 * The API tutorial leads you through hands-on exercises and includes a training video.
 * Mailing list for notifications and questions: API mailing list
 * Low-traffic mailing list for announcements only (all posts to this list are posted to mediawiki-api as well): mediawiki-api-announce
 * View and report API bugs in the MediaWiki-API Phabricator project (When reporting new bugs, don't forget to add MediaWiki-API to Projects)
 * — The current MediaWiki database schema
 * — The current MediaWiki database schema

Archived links

 * 2006 API discussion