API:Hoofdpagina

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page API:Main page and the translation is 97% complete.

Outdated translations are marked like this.
Other languages:
العربية • ‎azərbaycanca • ‎български • ‎বাংলা • ‎čeština • ‎dansk • ‎Deutsch • ‎English • ‎Esperanto • ‎español • ‎فارسی • ‎français • ‎हिन्दी • ‎Հայերեն • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎Taqbaylit • ‎ಕನ್ನಡ • ‎한국어 • ‎lietuvių • ‎文言 • ‎मैथिली • ‎मराठी • ‎Nederlands • ‎occitan • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎سنڌي • ‎ไทย • ‎Türkçe • ‎українська • ‎Tiếng Việt • ‎粵語 • ‎中文
Deze pagina maakt deel uit van de MediaWiki actie API documentatie.

MediaWiki actie API

v · d · e
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 api.phpManual:api.php Clients vragen specifieke "acties" door het specifiëren van een action parameter, hoofdzakelijk action=query 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

Indien je in plaats zoek voor een "interne API" of "PHP API", bekijk dan extension interface, deze laat PHP ontwikkelaars toe om nieuwe functionaliteit toe te voegen aan een MediaWiki installatie.
Meldingen van verouderd worden verstuurd naar de mediawiki-api-announce mailing lijst met lage frequentie. Abonneren is aangeraden.

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 (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:

Een eenvoudig voorbeeld

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

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

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 jsonfm zal een "netjes geformateerd" HTML resultaat teruggeven, goed voor debuggen.

Hier is de jsonfm URL als een eenvoudiger leesbare, klikbare link.

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

Het eindpunt

https://en.wikipedia.org/w/api.php

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 https://en.wikipedia.org/wiki/ 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:

https://www.mediawiki.org/w/api.php     # MediaWiki API
https://en.wikipedia.org/w/api.php      # Engelse Wikipedia API
https://nl.wikipedia.org/w/api.php      # Nederlandse Wikipedia API
https://commons.wikimedia.org/w/api.php # Wikimedia Commons API


MediaWiki versie: 1.17

Sinds r75621 hebben we RSD discovery voor het eindpunt: kijk voor de link rel="EditURI" in de HTML bron van eender welke pagina en vind de api.php</api> URL; the eigenlijke link bevat meer informatie.

Bijvoorbeeld, voor deze wiki is het:

<link rel="EditURI" type="application/rsd+xml" href="//www.mediawiki.org/w/api.php?action=rsd" />

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 w/api.php).

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

Het formaat

format=json Dit vertelt de API dat we de data willen terugkrijgen in JSON formaat. Je wil misschien ook format=jsonfm 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 (phab:T95715), dus deze wil je misschien niet gebruiken.

De actie

action=query

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

titles=Main%20Page

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: titles=PageA|PageB|PageC. Bekijk de query documentatie voor details.

prop=revisions

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.

rvprop=content

Finaal, deze parameter vertelt de webservice API dat we de inhoud willen van de laatste revisie van de pagina. In we in plaats rvprop=content|user 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 rvprop, en zo verder.

Een introductie voor de API door Roan Kattouw op de San Francisco Hackathon January 2012


Om te beginnen

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

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 User-Agent header die je client goed identificeert. Gebruik niet de standaard User-Agent 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 User-Agent header opgeeft, of je geeft een lege of generieke, zal je verzoek falen met een 403 fout (zie m: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 User-Agent header te beïnvloeden: de browser zal zijn eigen gebruiken. Om dit te omzeilen, gebruik de Api-User-Agent header:

// Using XMLHttpRequest
xhr.setRequestHeader( 'Api-User-Agent', 'Example/1.0' );

// Using jQuery
$.ajax( {
    url: remoteUrlWithOrigin,
    data: queryData,
    dataType: 'json',
    type: 'POST',
    headers: { 'Api-User-Agent': 'Example/1.0' },
    success: function(data) {
       // do something with data
    }
} );

// Using mw.Api, specify it when creating the mw.Api object
var api = new mw.Api( {
    ajax: {
        headers: { 'Api-User-Agent': 'Example/1.0' }
    }
} );
api.get( {...} ).done(function(data) {
    // do something with data
});

// Using fetch
fetch( remoteUrlWithOrigin, {
    method: 'POST',
    headers: new Headers( {
        'Api-User-Agent': 'Example/1.0'
    } )
    // Other init settings such as 'credentials'
} ).then( function ( response ) {
    if ( response.ok ) {
        return response.json();
    }
    throw new Error( 'Network response was not ok: ' + response.statusText );
} ).then( function ( data ) {
    // do something with data
});

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

ini_set('user_agent', 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4');

Of indien je cURL gebruikt:

curl_setopt($curl, CURLOPT_USERAGENT, 'MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4');

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 api.php?....titles=Foo|Bar|Hello, het resultaat cachet, dan zal een verzoek voor api.php?....titles=Hello|Bar|Hello|Foo 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:

Gearchiveerde links