API:Main page/nl


 * Dit is een overzicht van de "actie" API. Zie de menu-balk rechts voor meer gedetailleerde deelonderwerpen en andere API's.

De MediaWiki actie API is een web service die een vlotte toegang biedt tot wiki eigenschappen, data en meta-data over HTTP, via een URL gebruikelijk in Clients vragen specifieke "acties" door het specifiëren van een  parameter, hoofdzakelijk   voor het opvragen van informatie. Dit was gekend als " de " MediaWiki API, maar er zijn nu verschillende web APIs beschikbaar die connecteren met MediaWiki zoals RESTBase end de Wikidata query service.

Inleiding
De MediaWiki actie API kan gebruikt worden om een MediaWiki installatie op te volgen, of een bot aan te maken om automatisch één te onderhouden. Dit geeft direct en uitgebreid toegang tot de gegevens uit de Media-Wiki gegevensbestanden. Client programma's kunnen aanloggen bij een wiki, data opvragen en automatisch wijzigingen aanbrengen via het maken van HTTP verzoeken aan de webservice. Ondersteunde clients omvatten bots, kleine web-gebaseerde JavaScript clients zoals Navigatie pop-ups en LiveRC, eindgebruiker applicaties zoals Vandal Fighter en andere websites ([//tools.wmflabs.org Toolforge]'s middelen).

Op nieuwe MediaWiki installaties is de webservice standaard ingeschakeld, maar een administrator kan dit uitschakelen.

MediaWiki heeft twee andere naar buiten gerichte interfaces:


 * De Special:Export pagina, die wiki inhoud in bulk naar XML kan exporteren. Lees de voor meer informatie.
 * De gewone webgebaseerde interface (die hoogstwaarschijnlijk op dit moment wordt gebruikt). Zie voor meer informatie over het gebruik van de webgebaseerde interface.

Een eenvoudig voorbeeld
Deze URL vraagt aan de Engelse Wikipedia webservice API om je de inhoud van de hoofdpagina op te sturen:

Gebruik eender welke programmeertaal om HTTP GET oproepen voor die URL te maken (of bezoek gewoon die link in je browser) en je zal een JSON document krijgen dat de huidige wiki markup bevat voor de pagina getiteld "Main Page". Het formaat veranderen naar  zal een "netjes geformateerd" HTML resultaat teruggeven, goed voor debuggen.

Laten we die URL ontleden om te tonen hoe het werkt.

Het eindpunt
Dit is het "eindpunt". Het is zoals de thuispagina van de MediaWiki webservice API. Deze URL is de basis URL voor de Engelstalige Wikipedia API, net zoals  de basis is voor de website.

Indien je een programma schrijft om de Engelstalige Wikipedia te gebruiken, zal elke URL die je opbouwt beginnen met deze basis URL. Indien je een andere MediaWiki installatie gebruikt, zal je zijn eindpunt moeten vinden en dat gebruiken. Alle Wikimedia wiki's hebben eindpunten die dit patroon volgen:

Sinds hebben we RSD discovery voor het eindpunt: kijk voor de   in de HTML bron van eender welke pagina en vind de

In andere gevallen, is er geen veilige manier om het eindpunt te bepalen voor eender welke wiki. Indien je geluk hebt, zal ofwel het volledige pad naar index.php niet verborgen zijn onder vreemde herschrijving regels zodat je enkel de "edit" (of historiek) link moet nemen en index.php (etc.) moet vervangen door api.php, ofwel zal je de standaard script path kunnen nemen (zoals ).

Laten we nu verder kijken naar de parameters in de query string van de URL.

Het formaat
Dit vertelt de API dat we de data willen terugkrijgen in JSON formaat. Je wil misschien ook  proberen om een HTML versie van het resultaat terug te krijgen die goed is om te debuggen. De API ondersteunt andere output formats zoals XML en native PHP, maar er zijn plannen om minder populaire formaten te verwijderen (T95715), dus deze wil je misschien niet gebruiken.

De actie
De MediaWiki webservice API implementeer vele acties en uitbreidingen implementeren er nog veel meer; de dynamisch gegenereerde API help documenteert alle beschikbare acties op een wiki. In dit geval, gebruiken we de "query" actie om wat informatie te verkrijgen. De "query" acties is één van de API's meest belangrijke acties, en heeft een uitgebreide documentatie op zijn eigen. Wat volgt is juist de uitleg voor één enkel voorbeeld.

Actie-specifieke parameters
De rest van de voorbeeld URL bevat parameters die gebruikt worden bij de "query" actie. Hier vertellen we de webservice API dat we informatie willen over de wiki pagina genaamd "Main Page". (De %20 komt van de procent-encodering van een spatie.) Indien je meerdere pagina's wil opvragen, kan je deze samenvoegen in één opvraging om netwerk en server bronnen te optimaliseren:. Bekijk de query documentatie voor details.

Je kan verschillende soorten informatie, of "eigenschappen", opvragen van een pagina. Deze parameter vertelt de webservice API dat we alle informatie willen over een specifieke revisie van de pagina. Omdat we geen revisie informatie preciseren, zal de API informatie geven over de laatste revisie - de hoofdpagina van Wikipedia zoals deze er nu uitziet.

Finaal, deze parameter vertelt de webservice API dat we de inhoud willen van de laatste revisie van de pagina. In we in plaats  doorgeven, zouden we de laatste pagina inhoud krijgen "en" de naam van de gebruiker die de meest recente revisie maakte.

Dit is wederom enkel één voorbeeld. Opvragingen zijn meer in details besproken hier, en de API referentie lijst alle mogelijke acties op, alle mogelijke acties voor, en zo verder.



Om te beginnen
Vooraleer je start met het gebruik van de MediaWiki webservice API, lees dan zeker deze documenten:


 * De FAQ
 * De pagina over invoer en uitvoer formaten
 * De pagina over fouten en waarschuwingen
 * Eender welke beleidsvoorwaarden die van toepassing is op de wiki die je wil aanspreken, zoals de Wikimedia Foundation wikis gebruiksvoorwaarden, trademark policy. Deze beleidsvoorwaarden zijn van toepassing wanneer je opvraagt of wijzigt via de API, net zoals ze doen wanneer je een webbrowser gebruikt.

Verder dan dit, wat je moet lezen hangt af van wat je wil gaan doen. Het rechterhand menu linkt naar gedetailleerde, taak-specifieke documentatie en enkele meer algemene richtlijnen worden gegeven hieronder.

Je client identificeren
Wanneer je een HTTP verzoek maakt bij de MediaWiki webservice API, specifieer dan zeker een  header die je client goed identificeert. Gebruik niet de standaard  die voorzien wordt door je client bibliotheek, maar verzin een eigen header die jouw script of service identificeert en die een manier bevat om jou te contacteren (bijvoorbeeld een e-mail adres).

Een voorbeeld User-Agent string kan er als volgt uitzien: MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4

Voor Wikimedia wiki's, indien je geen  header opgeeft, of je geeft een lege of generieke, zal je verzoek falen met een 403 fout (zie User-Agent policy). Andere MediaWiki installaties kunnen gelijkaardige normen hanteren.

Wanneer je de API oproept vanaf een browser-gebaseerd JavaScript, zal je niet in staat zijn om de  header te beïnvloeden: de browser zal zijn eigen gebruiken. Om dit te omzeilen, gebruik de  header:

In PHP, kan je jouw user-agent definiëren met code zoals dit:

Of indien je cURL gebruikt:

Inloggen
Je client zal waarschijnlijk moeten inloggen bij MediaWiki, mogelijks via zijn eigen gebruikersaccount. Zie de login handleiding pagina voor details.

API etiquette
Gelieve ook te lezen: API:Etiquette

Indien je verzoeken data opvragen die even kunnen gecached worden, dien je stappen te ondernemen om deze te cachen, zodat je niet steeds dezelfde data over en over opvraagt. Meer informatie over snelheidsbeperkingen, gelijktijdigheid en algemene API etiquette kan gevonden worden op API:Etiquette. Sommige clients zijn mogelijks zelf in staat om data te cachen, maar voor andere (specifiek JavaScript clients), is dit niet mogelijk.

Volgens de HTTP specificatie, POST verzoeken kunnen niet gecached worden. Daarvoor, eender wanneer je data uitleest via de webservice API, dien je GET verzoeken te gebruiken, niet POST.

Merk ook op dat een verzoek niet kan opgevraagd worden uit de cache tenzij de URL precies dezelfde is. Indien je een verzoek maakt voor, het resultaat cachet, dan zal een verzoek voor   niet door de cache afgehandeld worden - zelfs als MediaWiki dezelfde data teruggeeft!

Je dient stappen te ondernemen om de URLs die je verzendt naar de MediaWiki webservice te normaliseren, zodat verschillende gebruikersinvoer niet leidt tot tijdverspilling door onnodige HTTP verzoeken. Normaliseren van een lijst van pagina's kan door het verwijderen van duplicaten en de titels alfabetisch sorteren. Dezelfde technieken zullen werken voor andere soorten data.

Nuttige links
De menubalk aan de rechterzijde van deze pagina linkt naar meer gedetailleerde, taakspecifieke documentatie. Hier zijn enkele links die te maken hebben met de API als een geheel:


 * De API sandbox beschikbaar op alle Wikimedia wiki's maakt het gemakkelijk om verschillende acties interactief te proberen.
 * [//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)
 * 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

Gearchiveerde links

 * 2006 API discussion