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 prise en charge 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.

Paramètres :

action

Quelle action effectuer.

abusefiltercheckmatch: Vérifier pour voir si un AbuseFilter correspond à un ensemble de variables, à une modification ou à un événement AbuseFilter du journal.
abusefilterchecksyntax: Vérifier la syntaxe d’un filtre anti-abus.
abusefilterevalexpression: Évalue une expression de filtre anti-abus.
abusefilterunblockautopromote: Annule le blocage par un filtre anti-abus des promotions automatiques de statut d’un utilisateur.
abuselogprivatedetails: Afficher les détails privés d’une entrée de AbuseLog.
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 hasmsg pour 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 d’utilisateur.
delete: Supprimer une page.
edit: Créer et modifier des pages.
emailuser: Envoyer un courriel à un utilisateur.
expandtemplates: Réalise l’expansion de tous les modèles en wikicode.
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 actuel.
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 version.
protect: Modifier le niveau de protection d’une page.
purge: Vider le cache des titres fournis.
query: Récupérer 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.
spamblacklist: Valider une ou plusieurs URL selon la liste de blocage du pollupostage.
tag: Ajouter ou retirer des balises de modification aux révisions ou aux entrées de journal individuelles.
templatedata: Récupérer les données stockées par l’extension TemplateData.
titleblacklist: Valider un titre de page, un nom de fichier ou un nom d’utilisateur d’après la liste des titres interdits.
unblock: Débloquer un utilisateur.
undelete: Restaurer des 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.
categorytree: Interne. Module interne pour l’extension CategoryTree.
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.
oathvalidate: Interne. Valider un jeton d’authentification à deux facteurs (OATH).
scribunto-console: Interne. Module interne pour répondre aux requêtes XHR à partir de la console Scribunto.
stashedit: Interne. Préparer des modifications dans le cache partagé.

Une des valeurs suivantes : abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, 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, spamblacklist, tag, templatedata, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, categorytree, cspreport, oathvalidate, scribunto-console, 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 bases 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-age au 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, ou bien qu’il n’est pas connecté si elle est anon, ou encore 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 au moyen d’une requête AJAX inter-domaines (CORS), indiquez le protocole et le nom de 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 de la requête POST).

Pour les requêtes authentifiées, cela 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ête Origin, une réponse 403 sera renvoyée. Si ce paramètre correspond à l’entête Origin et l’origine indiquée est autorisée, l’API renseignera les entêtes Access-Control-Allow-Origin et Access-Control-Allow-Credentials dans sa réponse.

Pour les requêtes non authentifiées, indiquez la valeur *. L’API renseignera l’entête Access-Control-Allow-Origin dans sa réponse, mais Access-Control-Allow-Credentials vaudra false et toutes les données spécifiques à l’utilisateur seront restreintes.

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

variant

Variante de la langue. Ne fonctionne que si la langue de base prend en charge la conversion en variante.

errorformat

Format à utiliser pour la sortie de texte d’avertissement et d’erreur

plaintext: Wikicode avec les balises HTML supprimés et les entités remplacées.
wikitext: Wikicode 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)

Exemples :

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]

Autorisations :

writeapi: Utiliser l'API de modification du wiki; Accordé à : all, user et bot
apihighlimits: Utiliser des valeurs plus hautes dans les requêtes de l’API (requêtes lentes : 500 ; requêtes rapides : 5000). Les limites pour les requêtes lentes s’appliquent aussi aux paramètres multivalués.; Accordé à : bot et sysop

Type de données

Toute entrée de texte dans MediaWiki devrait être encodée en UTF-8 sous forme normalisée canonique précomposée (NFC). MediaWiki peut tenter de convertir d’autres entrées, mais cela peut faire échouer certaines opérations (comme des modifications de pages avec les vérifications 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 le contrôle U+001F (séparateur d’unité) 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 nécessitent 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: Les valeurs d’expiration peuvent être relatives (par ex. 5 months pour 5 mois ou 2 weeks pour 2 semaines) ou absolues (par ex. 2014-09-18T12:34:56Z). Pour ne pas avoir d’expiration, utiliser infinite (infini), indefinite (non défini), infinity (infinité) ou never (jamais).
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 dynamiques (nommés selon un format modèle) prennent en charge 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 statique fruits pour spécifier quels fruits sont demandés et un paramètre dynamique {fruit}-quantité pour spécifier la quantité demandée de chacun des fruits. 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 de 2013 à 2020)

Veuillez envoyer vos commentaires, suggestions et questions à mediawiki-api@lists.wikimedia.org ou remplir un rapport de bogue sur https://phabricator.wikimedia.org/.