API:Tutorial/fr

Dans ce tutoriel, vous découvrirez ce qu'est l' API Action de MediaWiki, comment l'utiliser, le format des requêtes, une requête simple et des exemples de projets qui utilisent l'API Action.

Voir les applications de démonstration sur Toolforge

Aperçu de l'API Action de MediaWiki
L' API Action de MediaWiki est un service web utilisant REST et qui permet aux utilisateurs de réaliser certaines actions sur les wikis telles que la création de page, l'authentification, l'analyse syntaxique, la recherche, etc. est un bon point d'entrée pour comprendre l'API.

Votre programme envoie des requêtes à l'API pour avoir accès aux fonctionnalités du wiki. Par exemple se connecter à un wiki, créer ou modifier une page, rechercher un titre, chercher une texte dans le contenu, ou analyser un contenu. L'API Action est disponible pour les développeurs tiers, les développeurs d'extensions Wikimedia, et les administrateurs de site.

Dans la barre latérale droite de cette page il existe plusieurs fonctions réalisées par l'API et groupées par catégorie. Before sending requests to a wiki server, first read through the overview pages such as data formats, errors and warnings, and the Action API FAQ.

Comment utiliser l'API Action de MediaWiki
You can request for data from client side to the server over HTTP and get the response back in a standard format (typically JSON). Une requête est constituée d'un point d'accès et d'une série de paramètres. There are two types of request that can be made: GET and POST. Dans une requête GET, un paramètre contient la chaîne de caractères de la requête dans l'URL. For a POST request, format the parameters in JSON format.

Format de la requête
All Wikimedia Wikis have endpoints in this format. To operate on the MediaWiki main site or English Wikipedia, use the related endpoint. For example, the English Wikipedia is at  For testing new accounts or test edits to pages, use the test wiki endpoint.

In the query string in the URL, add the  parameter. It tells the API which action to perform. The most popular action is  (the URL would contain ), which allows fetching data from a wiki. Following the  parameter, add another parameter to indicate which one of the three query module types you want to perform:


 * - get properties of pages
 * - get list of pages matching a certain criterion
 * - get meta information about the wiki and user

Finally, include the  parameter, which tells the API in which format to get the results. The recommended format is JSON. The API has supported other output formats in the past, but they are not generally recommended.

Une requête simple
Let’s take an example of a simple query to understand what a typical GET request and response would look like in the context of the Action API.

Let's search for a title in a wiki. We will use the  module documented on.

Requête GET
To search for page titles or content matching, the URL for the HTTP GET request would be: Explication de chaque partie de l'URL :


 * est le point d'accès principal. Dans ce cas il s'agit de la Wikipedia anglophone.
 * means fetch data from wiki.
 * means get list of pages matching a criteria.
 * indicates the page title or content to search for. The  indicates a space character in a URL.
 * indicates JSON output, which is the recommended output format.

Réponse
The response is a JSON format document with a list of pages titles that match Craig Noone:

Exemples de projets qui utilisent l'API Action
Some example of projects in Wikimedia that use Action API:


 * Wikipedia iOS App, in which one of the features is to search for wiki pages near your location.
 * Bots that operate on a wiki. Pywikibot is a bot framework written in Python that interfaces with MediaWiki API which a lot of bot developers use.
 * API use in visualizing data obtained from a wiki. Such as this neat visualization that shows real time edits made on Wikipedia.

Notes supplémentaires

 * Several sites are using MediaWiki. They might all be running a different version of MediaWiki and in turn the API. Some module parameters supported in one version might be deprecated or removed in others. You could learn about that in each module's documentation via API help module.
 * If you want to make a lot of API calls, and perhaps run very busy and active bots, talk to wiki admins ahead of time, so they do not block you. See list of Administrators of Wikimedia projects. Read more about this topic on.
 * All data modifying actions such as logging, editing or moving a page, and watching or patrolling changes would require tokens. You would need to obtain tokens via to proceed further.

Ressources

 * Use Special:APISandbox to experiment with the Action API. You can play around with supported actions, specify a value for parameters, and send requests to the API to see the results on the same page.
 * Wikimedia dumps so you can work with them locally.
 * Read through tutorials: An Introduction to API's and What is REST — A Simple Explanation for Beginners.
 * MediaWiki API help provides auto-generated API documentation of all supported modules.
 * provides an overview of the Action API.
 * Introduction to the MediaWiki API by User:Roan_Kattouw_(WMF) at the San Francisco Hackathon, 2012. This tutorial guide goes along with the video.
 * GitHub: MediaWiki API Demos