Aide de l’API MediaWiki
Ceci est une page dâaide de lâAPI de MediaWiki générée automatiquement.
Documentation et exemples : https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Module principal
- Sourceâ¯: MediaWiki
- Licenceâ¯: GPL-2.0-or-later
Ãtatâ¯: lâAPI de MediaWiki est une interface stable et mature qui est supportée et améliorée de façon active. Bien que nous essayions de lâéviter, nous avons parfois besoin de faire des modifications non rétrocompatiblesâ¯; inscrivez-vous à la liste de diffusion mediawiki-api-announce pour être informé des mises à jour.
Requêtes erronéesâ¯: si des requêtes erronées sont envoyées à lâAPI, un entête HTTP sera renvoyé avec la clé «â¯MediaWiki-API-Errorâ¯Â». La valeur de cet entête et le code dâerreur renvoyé prendront la même valeur. Pour plus dâinformations, voyez API:Erreurs et avertissements.
Testâ¯: pour faciliter le test des requêtes à lâAPI, utilisez le bac à sable de lâAPI.
- action
Quelle action effectuer.
- block
- Bloquer un utilisateur.
- changeauthenticationdata
- Modifier les données dâauthentification pour lâutilisateur actuel.
- changecontentmodel
- Modifier le modèle de contenu d'une page
- checktoken
- Vérifier la validité dâun jeton de action=query&meta=tokens.
- clearhasmsg
- Efface le drapeau
hasmsgpour lâutilisateur actuel. - clientlogin
- Se connecter au wiki en utilisant la procédure interactive.
- compare
- Obtenir la différence entre deux pages.
- createaccount
- Créer un nouveau compte utilisateur.
- delete
- Supprimer une page.
- edit
- Créer et modifier les pages.
- emailuser
- Envoyer un courriel à un utilisateur.
- expandtemplates
- Réalise lâexpansion des modèles en wikitexte.
- feedcontributions
- Renvoie le fil des contributions dâun utilisateur.
- feedrecentchanges
- Renvoie un fil de modifications récentes.
- feedwatchlist
- Renvoie un flux de liste de suivi.
- filerevert
- Rétablir un fichier dans une ancienne version.
- help
- Afficher lâaide pour les modules spécifiés.
- imagerotate
- Faire pivoter une ou plusieurs images.
- import
- Importer une page depuis un autre wiki, ou depuis un fichier XML.
- linkaccount
- Lier un compte dâun fournisseur tiers à lâutilisateur actuel.
- login
- Se connecter et récupérer les témoins (cookies) dâauthentification.
- logout
- Se déconnecter et effacer les données de session.
- managetags
- Effectuer des tâches de gestion relatives aux balises de modification.
- mergehistory
- Fusionner les historiques des pages.
- move
- Déplacer une page.
- opensearch
- Rechercher dans le wiki en utilisant le protocole OpenSearch.
- options
- Modifier les préférences de l'utilisateur courant.
- paraminfo
- Obtenir des informations sur les modules de lâAPI.
- parse
- Analyse le contenu et renvoie le résultat de lâanalyseur.
- patrol
- Patrouiller une page ou une révision.
- protect
- Modifier le niveau de protection dâune page.
- purge
- Vider le cache des titres fournis.
- query
- Extraire des données de MediaWiki et à propos de celui-ci.
- removeauthenticationdata
- Supprimer les données dâauthentification pour lâutilisateur actuel.
- resetpassword
- Envoyer un courriel de réinitialisation du mot de passe à un utilisateur.
- revisiondelete
- Supprimer et rétablir des révisions.
- rollback
- Annuler les dernières modifications de la page.
- rsd
- Exporter un schéma RSD (Découverte Très Simple).
- setnotificationtimestamp
- Mettre à jour lâhorodatage de notification pour les pages suivies.
- setpagelanguage
- Modifier la langue dâune page.
- tag
- Ajouter ou enlever des balises de modification aux révisions ou aux entrées de journal individuelles.
- unblock
- Débloquer un utilisateur.
- undelete
- Restaurer les versions dâune page supprimée.
- unlinkaccount
- Supprimer un compte tiers lié de lâutilisateur actuel.
- upload
- Téléverser un fichier, ou obtenir lâétat des téléversements en cours.
- userrights
- Modifier lâappartenance dâun utilisateur à un groupe.
- validatepassword
- Valider un mot de passe conformément aux règles concernant les mots de passe du wiki.
- watch
- Ajouter ou supprimer des pages de la liste de suivi de lâutilisateur actuel.
- webapp-manifest
- Retourne un manifest webapp.
- mobileview
- Obsolète. Renvoie les données nécessaires pour les affichages mobile.
- cspreport
- Interne. Utilisé par les navigateurs pour signaler les violations de la politique de confidentialité du contenu. Ce module ne devrait jamais être utilisé, sauf quand il est utilisé automatiquement par un navigateur web compatible avec CSP.
- stashedit
- Interne. Préparer des modifications dans le cache partagé.
- Une des valeurs suivantesâ¯: block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, mobileview, cspreport, stashedit
- Par défaut : help
- format
Le format de sortie.
- json
- Sortir les données au format JSON.
- jsonfm
- Extraire les données au format JSON (HTML mis en forme améliorée pour lâimpression).
- none
- Ne rien extraire.
- php
- Extraire les données au format sérialisé de PHP.
- phpfm
- Extraire les données au format sérialisé de PHP (mise en forme HTML améliorée pour l'impression).
- rawfm
- Extraire les données, y compris les éléments de débogage, au format JSON (mise en forme HTML améliorée pour l'impression).
- xml
- Extraire les données au format XML.
- xmlfm
- Extraire les données au format XML (affiché proprement en HTML).
- Une des valeurs suivantesâ¯: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- Par défaut : jsonfm
- maxlag
La latence maximale peut être utilisée quand MediaWiki est installé sur une grappe de réplication de base de données. Pour éviter des actions provoquant un supplément de latence de réplication de site, ce paramètre peut faire attendre le client jusquâà ce que la latence de réplication soit inférieure à une valeur spécifiée. En cas de latence excessive, le code dâerreur maxlag est renvoyé avec un message tel que Attente de $host : $lag secondes de délai.
Voyez Manuel : paramètre Maxlag pour plus dâinformations.- Type: entier
- smaxage
Fixer lâentête HTTP de contrôle de cache
s-maxageà ce nombre de secondes. Les erreurs ne sont jamais mises en cache.- Type: entier
- Par défaut : 0
- maxage
Fixer lâentête HTTP de contrôle de cache
max-ageau nombre indiqué de secondes. Les erreurs ne sont jamais mises en cache.- Type: entier
- Par défaut : 0
- assert
Vérifier que lâutilisateur est connecté lorsque la valeur est user, et quâil nâest pas connecté si elle est anon, ou quâil a le droit dâun utilisateur robot lorsque la valeur est bot.
- Une des valeurs suivantesâ¯: anon, bot, user
- assertuser
Vérifier que lâutilisateur actuel est lâutilisateur nommé.
- Typeâ¯: utilisateur, par nom dâutilisateur
- requestid
Toute valeur fournie ici sera incluse dans la réponse. Peut être utilisé pour distinguer des demandes.
- servedby
Inclure le nom dâhôte qui a renvoyé la requête dans les résultats.
- Type : booléen (détails)
- curtimestamp
Inclure lâhorodatage actuel dans le résultat.
- Type : booléen (détails)
- responselanginfo
Inclure les langues utilisées pour uselang et errorlang dans le résultat.
- Type : booléen (détails)
- origin
En accédant à lâAPI en utilisant une requête AJAX inter-domaines (CORS), indiquez le domaine dâorigine dans ce paramètre. Celui-ci doit être inclus dans toute requête de pré-envol et doit donc faire partie de lâURI de la requête (pas du corps du POST).
Pour les requêtes authentifiées, il doit correspondre exactement à une des origines dans lâentête
Origin, il doit donc être fixé avec quelque chose comme https://en.wikipedia.org ou https://meta.wikimedia.org. Si ce paramètre ne correspond pas à lâentêteOrigin, une réponse 403 sera renvoyée. Si ce paramètre correspond à lâentêteOriginet lâorigine indiquée est autorisée, lâAPI renseignera en réponse les entêtesAccess-Control-Allow-OriginetAccess-Control-Allow-Credentials.Pour les requêtes non authentifiées, indiquez la valeur *. LâAPI renseignera lâentête
Access-Control-Allow-Origindans sa réponse, maisAccess-Control-Allow-Credentialsvaudrafalseet toutes les données spécifiques à lâutilisateur seront filtrées.- uselang
Langue à utiliser pour les traductions de message : utilisez la requête de lâAPI action=query&meta=siteinfo avec siprop=languages pour renvoyer une liste de codes de langue, sinon indiquez user pour utiliser la langue préférée de lâutilisateur actuel, ou bien content pour utiliser la langue du contenu de ce wiki.
- Par défaut : user
- errorformat
Format à utiliser pour la sortie du texte dâavertissement et dâerreur.
- plaintext
- wikitexte sans aucun balisage HTML et avec les entités remplacées.
- wikitext
- wikitexte avec son balisage en syntaxe wiki non analysée.
- html
- wikitexte analysé et mis en forme en HTML uniquement.
- raw
- clé de message et paramètres.
- none
- aucune sortie de texte, uniquement les codes erreur.
- bc
- ancien format utilisé avant MediaWiki 1.29. errorlang et errorsuselocal sont ignorés.
- plaintext
- Wikitexte avec des balises HTML supprimé et entités remplacées.
- wikitext
- Wikitexte non analysé.
- html
- HTML
- raw
- Clé et paramètres du message.
- none
- Sortie sans texte, seulement les codes d'erreur.
- bc
- Format utilisé avant MediaWiki 1.29. errorlang et errorsuselocal sont ignorés.
- Une des valeurs suivantesâ¯: bc, html, none, plaintext, raw, wikitext
- Par défaut : bc
- errorlang
Langue à utiliser pour les avertissements et les erreurs. Spécifier un des codes langues utilisables renvoyés par action=query&meta=siteinfo avec siprop=languages, sinon content pour utiliser la langue du contenu de ce wiki, ou encore uselang pour utiliser la même valeur que le paramètre uselang (la langue préférée pour lâinterface utilisateur).
- Par défaut : uselang
- errorsuselocal
Sâil est fourni, les textes dâerreur utiliseront des messages adaptés à la langue dans lâespace de noms MediaWiki.
- Type : booléen (détails)
- Aide pour le module principal
- api.php?action=help [ouvrir dans le bac à sable]
- Toute lâaide sur une page.
- api.php?action=help&recursivesubmodules=1 [ouvrir dans le bac à sable]
Type de données
Les entrées dans MediaWiki doivent être en UTF-8 normalisé NFC. MediaWiki peut tenter de convertir les autres entrées, mais cela peut faire échouer certaines opérations (comme des modifications de pages avec les contrôles MD5).
Les paramètres qui prennent plusieurs valeurs sont normalement soumis avec les valeurs séparées par des barres verticales, par ex. param=valeur1|valeur2 ou param=valeur1%7Cvaleur2. Si une valeur doit contenir une barre verticale, utiliser U+001F (Séparateur Unix) comme séparateur et préfixer la valeur par U+001F, par ex. param=%1Fvaleur1%1Fvaleur2.
Certains types de paramètre dans les requêtes de lâAPI ont besoin de plus dâexplications :
- boolean
Les paramètres booléens fonctionnent comme des cases à cocher HTML : si le paramètre est spécifié, quelle que soit sa valeur, il est considéré comme vrai. Pour une valeur fausse, omettre complètement le paramètre.
- expiry
Valeurs dâexpiration relatives (par ex. 5 months ou 2 weeks) ou absolues (par ex. 2014-09-18T12:34:56Z). Pour ne pas avoir dâexpiration, utiliser infinite, indefinite, infinity ou never.
- timestamp
Les horodatages peuvent être spécifiés sous plusieurs formes, voir les formats dâentrée de la bibliothèque Timestamp documentés sur mediawiki.org pour plus de détails. La date et lâheure ISO 8601 sont recommandés : 2001-01-15T14:56:00Z. De plus, la chaîne now peut être utilisée pour spécifier lâhorodatage courant.
Paramètres de modèle
Les paramètres de modèle supportent les cas où un module dâAPI a besoin dâune valeur pour chaque valeur dâun autre paramètre quelconque. Par exemple, sâil y avait un module dâAPI pour demander un fruit, il pourrait avoir un paramètre fruits pour spécifier quels fruits sont demandés et un paramètre de modèle {fruit}-quantité pour spécifier la quantité demandée de chaque fruit. Un client de lâAPI qui voudrait une pomme, cinq bananes et vingt fraises pourrait alors faire une requête comme fruits=pommes|bananes|fraises&pommes-quantité=1&bananes-quantité=5&fraises-quantité=20.
Remerciements
Développeurs de lâAPIâ¯:
- Yuri Astrakhan (créateur, développeur en chef de sept. 2006 à sept. 2007)
- Roan Kattouw (développeur en chef de sept. 2007 à 2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (développeur en chef depuis 2013)
Veuillez envoyer vos commentaires, suggestions et questions à mediawiki-api@lists.wikimedia.org ou remplir un rapport de bogue sur https://phabricator.wikimedia.org/.