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. 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. Sometimes an API allows an application to request an action to be done by the application which implements the API. 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 &mdash; ook wel REST API  genoemd&mdash; volgt deze principes en de service is daardoor sneller, 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  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:

hier:


 * is een parameter van de hoofdmodule.
 * is een andere module. Het wordt de query module genoemd.
 * is een parameter van de query module.
 * is ook een module. Het kan een submodule van  genoemd worden.
 * is een parameter van de zoekmodule. Het bevat de zoektekst 'abc'.
 * is a parameter of the main module.
 * is the output format.

Also, see Introduction and guidelines. It describes the submodules of the  module.

How do I know which module and submodule to call?
The MediaWiki Action API is big, and extensions further enlarge it. Here are a few ways to work out your API request:


 * In the sidebar, look for the feature you wish to implement and follow the link for information about which modules to call.
 * The self-documenting API pages contain a list of all modules and submodules with brief descriptions. You can start at the main module and follow the links to different submodules. (Append  to view the expanded version)

Where can I find sample codes for using the API modules?
The API documentation pages contain an 'Examples' section to demonstrate how different modules and submodules can be used. The auto-generated docs also have examples trailing the module descriptions.

See Mediawiki-API-demos for code snippets in Python and JavaScript.

How can I control the output format?
The default output format is JSON. Other output formats have been deprecated or removed in the latest stable MediaWiki version, and their use is discouraged.

In older versions, to control the output format, you can pass  in the query string.

For information, see API:Data formats.

Do I need an access token?
You will require an access token to perform data modifying actions like logging in, editing, moving pages, etc.

To learn more, refer to API:Tokens or the sidebar category 'Authentication'.

How can I make cross-site requests using the API?
You must use JSONP or CORS to make cross-site requests in MediaWiki.

For details, see API:Cross-site requests.

Is there a limit to query results?
Yes, it depends on the query parameter. For example, the results for  and   queries cannot exceed 500 for regular users. The API pages contain information about these limits in the 'Additional notes' section or the 'Limits' section. Note that some modules impose stricter limits under certain conditions.

If you are unsure about what limit to set and just want as many results as possible, set the limit to.

Is there a limit to API calls?
There is no concrete limit. Yet, we recommend making a reasonable number of calls to prevent getting blocked. If you want to make many requests, contact the administrators beforehand.

Also, see API:Etiquette.

Where can I get updates about the MediaWiki Action API?
You can subscribe to the MediaWiki-API-Announce mailing list for announcements and updates.

What are wiki dumps and how can I work with them?
Wikimedia’s data dumps are dumps of wiki collections, content, metadata, search indices, etc. To work with dumps, see using dumps and public dumps.

Where can I get more help?
If you can't find answers in the MediaWiki API documentation or the auto-generated documentation pages, feel free to reach out in the following ways.


 * Create a Wikimedia account (if you don't have one already) and add a new topic on the API discussion page.
 * Ask your question on:
 * IRC in the channel.
 * MediaWiki-API mailing list.

How can I create an API module in an extension?
API:Extensions will walk you through the complete process of creating an API module in an extension.

What is the internal structure of the API?
API:Implementation Strategy explains the implementation of the API machinery in MediaWiki Core.

How can I restrict the API usage?
To restrict the API usage, you can either restrict the use of write API or disable individual modules.

For instructions and examples, see API:Restricting API usage.

How can I allow/restrict users from modifying the wiki content using the API?
Users are allowed to modify the wiki content by default. To restrict, you have to set  in.

For more information, see API:Changing wiki content.

How do I detect an error?
If you encounter an error, the error response from the API will set the  HTTP header and return an error structure.

What does this error mean?
Find your error in the list of standard error messages to understand what the error means.

How do I file a bug/feature requests?
You can report bugs and file feature requests on Wikimedia's task tracking tool, Phabricator.

Note:


 * Add the MediaWiki-API project tag to your task.
 * If your report/request is offered by an extension, add that extension's project. (e.g. MediaWiki-extensions-AbuseFilter,  MediaWiki-extensions-FlaggedRevs, etc.)
 * Verify for duplicates before creating a new task.
 * Understand the task creation terms on Phabricator before proceeding.

See How to report a bug for more details.

Am I facing errors due to my API version?
If a website runs a different version of MediaWiki, it would also run a different version of the API. Some module parameters supported in one version might be deprecated (or removed) in others. Such parameters will throw an exception if used. The API pages document any such deprecations.

See the release notes for information regarding different API versions.