API:FAQ/nl

Overzicht

Deze pagina bevat antwoorden op enkele veel gestelde vragen over de MediaWiki Action API. This page is intended for technical contributors and software developers who wish to understand and use the MediaWiki Action API.

Lees ook de API:Hoofdpagina . Daar worden enkele andere vragen beantwoordt en wordt er ook naar andere nuttige pagina's verwezen.

Over API's

Wat is een API?

API is een afkorting van Application Programming Interface. Via een API kunnen verschillende applicaties met elkaar communiceren. Soms stelt een API een applicatie in staat om een actie aan te vragen die moet worden uitgevoerd door de applicatie die de API implementeert. Voor de mediawiki staat het voor webgebaseerde API's, die HTTP requests-response mechanismes gebruiken en JSON/XML gestructureerde gegevens aanmaken.

Wat is een REST API?

REST is een afkorting van REpresentational State Transfer. A set van principes of voorwaarden die een RESTful systeem definiëren. Een RESTful API — ook wel REST API genoemd— volgt deze principes en de service is daardoor snel, betrouwbaar en schaalbaar.

Wat kan een API doen?

Voorbeelden van gebruik API.

Waar kan ik meer informatie vinden over API's?

Hier zijn een paar bronnen:

• API's begrijpen
• Een introductie over API's
• Wat is REST — Een uitleg voor beginners, Deel 1: Introductie

Algemeen

Wat is de MediaWiki Action API?

De MediaWiki Action API is een RESTful webservice die gebruikers toestaat bepaalde wiki-acties uit te voeren zoals het aanmaken van pagina's, authenticatie, parsing, zoeken, enz.

Waar kan de MediaWiki Action API voor worden gebruikt?

De MediaWiki Action API kan worden gebruikt voor:

• toegang tot wiki-functies.
• interactie met de wiki.
• ophalen van meta-informatie over wiki's en openbare gebruikers.

De zijbalk aan de rechterkant geeft toegang tot veel functies die door de API worden ondersteund. Ook enkele Wikimedia projecten gebruiken de MediaWiki Action API.

Hoe gebruik ik de MediaWiki Action API?

HTTP requests worden gebruikt voor het aanroepen (call) van de Action API. Gedetailleerde instructies

Om de Action API uit te proberen:

• Gebruik de Zandbak.
• Schakel uw webbrowser omgeving voor ontwikkelaars in en bekijk de netwerk requests naar api.php als u iets op de wiki doet.

Wat is een module, een submodule en een parameter?

De MediaWiki Action API heeft meerdere modules die we gebruiken om verschillende taken uit te voeren. Technisch gezien is een module een subclass van ApiBase. Een module heeft parameters nodig. Deze parameters kunnen (maar dat hoeft niet) submodules zijn.

Bekijk het volgende request:

api.php?action=query&list=search&srsearch=abc&format=json [probeer het in de ApiSandbox]

hier:

• action is een parameter van de hoofdmodule.
• action=query is een andere module. Het wordt de query module genoemd.
• list is een parameter van de query module.
• list=search is ook een module. Het kan een submodule van action=query genoemd worden.
• srsearch is een parameter van de zoekmodule. Het bevat de zoektekst 'abc'.
• format is een parameter van de hoofdmodule.
• json is het uitvoerformaat.

Bekijk ook de Introductie en richtlijnen. Het beschrijft de submodules van de action=query module.

Hoe weet ik welke (sub)module ik moet aanroepen?

De MediaWiki Action API is groot en wordt met extensies zelfs nog groter. Een aantal manieren om uw API request uit te werken:

• Kijk in de zijbalk naar de functie die u wilt gaan implementeren en volg de link naar informatie over welke modules aangeroepen moeten worden.
• De documentatie van de API pagina's bevat een lijst van alle modules en submodules met korte beschrijvingen. U kunt beginnen met de hoofdmodule en de links naar verschillende submodules volgen. (Voeg recursivesubmodules=1 toe om de uitgebreidere versie te bekijken)

Zijn er voorbeelden met code hoe ik de API-modules kan gebruiken?

De API documentatie bevat een gedeelte met 'Voorbeelden' om aan te geven hoe de verschillende (sub)modules kunnen worden gebruikt. De automatisch gegenereerde documenten hebben ook voorbeelden achter de module beschrijvingen.

Bekijk de Mediawiki-API-demos voor stukjes code in Python en in JavaScript.

Hoe bepaal ik het uitvoerformaat?

Het uitvoerformaat is standaard JSON. De andere uitvoerformaten werden eerst ontraden en zijn later verwijderd.

In oude versies kan het uitvoerformaat nog worden opgegeven met &format=someformat in de query string.

Bekijk gegevensformaten.

Heb ik een 'access token' nodig?

U heeft een 'access token' nodig als u wilt inloggen, gegevens wilt wijzigen, pagina's wilt bewerken of verplaatsen, ...

Bekijk API:Tokens of de zijbalk categorie 'Authenticatie'.

Hoe kan ik cross-site requests doen met de API?

U moet JSONP of CORS gebruiken om cross-site requests te doen in de MediaWiki.

Details Cross-site requests

Is er een limiet aan de query resultaten?

Ja, het hangt af van de query parameter. Het aantal resultaten voor list en property queries kan voor normale gebruikers maximaal 500 zijn. De API-pagina's bevatten informatie over deze limieten in de sectie 'Aanvullende notities' of de sectie 'Limieten'. Let op, sommige modules hanteren bij bepaalde condities strengere limieten.

Als u twijfelt wat u als limiet moet zetten of zoveel mogelijk resultaten wil, zet dan de limiet op max.

Is er een limiet aan het aantal API-calls?

Nee, er is geen limiet, maar we bevelen aan om een redelijk aantal te doen om het blokkeren te voorkomen. Als u er erg veel wilt doen, neem vooraf contact op met de beheerders.

Zie: Etiquette.

Hoe krijg ik updates van de MediaWiki Action API?

U kunt u aanmelden voor deze specifieke mailinglijst met aankondigingen en nieuws over de API.

Wat zijn wiki-dumps?

Wikimedia’s data dumps zijn dumps van wiki verzamelingen, inhoud, metadata, zoekindexen, enz. Informatie over het gebruiken van dumps en openbare dumps.

Waar kan ik meer ondersteuning krijgen?

Als u niet geholpen bent met de MediaWiki API documentatie of de gegenereerde documentatie pagina's, dan kunt u ondersteuning vinden op de volgende manieren.

• Maak een Wikimedia account aan (als u die nog niet heeft) en begin een nieuw onderwerp op de API discussie pagina.
• Stel uw vraag op:
  • IRC op het #mediawiki ^verbinden kanaal.
  • MediaWiki-API mailinglijst.

Ontwikkelaars van extensions en eigenaren van een wiki

Hoe maak ik in een extensie een API-module aan?

API:Extensions zal u leiden door het proces van het aanmaken van een API-module in een extensie.

Wat is de interne structuur van de API?

In de implementatie strategie wordt de implementatie van de API in de MediaWiki Core uitgelegd.

Hoe kan ik gebruik van de API beperken?

Om het gebruik van de API te beperken, u kunt of het schrijven met de API beperken of u kunt een of meerdere modules uitschakelen.

Voorbeelden van het beperken van het gebruik van de API.

Fouten en probleemoplossing

Hoe zie ik een fout?

Als er een fout optreedt dan wordt dat door de API in de HTTP header MediaWiki-API-Error gezet en wordt er een error structure teruggegeven.

Wat betekent deze fout?

Zoek de fout op in de lijst standaardfoutberichten om een uitleg te vinden.

Hoe meld ik een fout?

U kunt een fout rapporteren en ook een verzoek doen voor een aanpassing of uitbreiding van een functie op Phabricator.

Opmerking:

• Voeg de MediaWiki-API projecttag toe aan uw taak.
• Als uw fout/verzoek gaat over iets met een extensie, voeg dan ook het project van die extensie toe. (bijv. MediaWiki-extensions-AbuseFilter, MediaWiki-extensions-FlaggedRevs, enz.)
• Controleer voordat u een taak aanmaakt of iemand anders al een soortgelijke taak heeft opgevoerd.
• Probeer voor het opvoeren van een taak eerst de termen op Phabricator te begrijpen.

Meer informatie over het melden van een fout.

Krijg ik een fout door de versie van de API die ik gebruik?

Indien een website een andere versie van de MediaWiki gebruikt, dan zal het ook wel een andere versie van de API gebruiken. Enkele module parameters kunnen in de ene versie nog wel ondersteund zijn en in de andere niet. Dat kan leiden tot 'exceptions'. Op de API-pagina's staat informatie over zaken die ontraden zijn in een versie en die in een volgende versie dus best vervallen kunnen zijn.

Bekijk de release notities voor informaties over verschillen in de API-versies.