Aide de l’API MediaWiki

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 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 utilisateur.

cxconfiguration

Récupérer le JSON de la configuration de la traduction de contenu pour la paire de langues donnée.

cxdelete

Supprimer un brouillon de traduction créé en utilisant l’extension de traduction de contenu.

cxsuggestionlist

Gérer les listes de suggestions. Ajouter des suggestions aux listes et les enlever.

cxtoken

Obtenir des jetons JWT pour l’authentifications avec cxserver.

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.

globalpreferenceoverrides

Réinitialiser les redéfinitions locales avec les préférences globales pour l’utilisateur actuel.

globalpreferences

Modifier les préférences globales de l’utilisateur actuel.

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.

languagesearch

Rechercher des noms de langage dans n’importe quel script.

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.

templatedata

Récupérer les données stockées par l’extension TemplateData.

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.

tokens

Obsolète. Obtenir des jetons pour des actions de modification des données.

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.

cxpublish

Interne. Enregistrer une page créée en utilisant l’extension Traduction de Contenu.

cxsave

Interne. Ce module permet d’enregistrer les brouillons de traduction par section pour économiser la bande passante et élaborer un corpus parallèle.

stashedit

Interne. Préparer des modifications dans le cache partagé.

ulslocalization

Interne. Obtenir la traduction de ULS dans la langue donnée.

ulssetlang

Interne. Mettre à jour la langue d’interface préférée de l’utilisateur.

visualeditor

Interne. Renvoie une page HTML5 du service Parsoid.

visualeditoredit

Interne. Enregistrer une page HTML5 dans Médiawiki (convertie en wikitexte via le service Parsoid).

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).

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.

Fixer l’entête HTTP de contrôle de cache s-maxage à ce nombre de secondes. Les erreurs ne sont jamais mises en cache.

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.

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.

Vérifier que l’utilisateur actuel est l’utilisateur nommé.

Toute valeur fournie ici sera incluse dans la réponse. Peut être utilisé pour distinguer des demandes.

Inclure le nom d’hôte qui a renvoyé la requête dans les résultats.

Inclure l’horodatage actuel dans le résultat.

Inclure les langues utilisées pour uselang et errorlang dans le résultat.

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ête Origin, une réponse 403 sera renvoyée. Si ce paramètre correspond à l’entête Origin et l’origine indiquée est en liste blanche, l’API renseignera en réponse les entêtes Access-Control-Allow-Origin et Access-Control-Allow-Credentials.

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 filtrées.

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.

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.

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).

S’il est fourni, les textes d’erreur utiliseront des messages adaptés à la langue dans l’espace de noms MediaWiki.