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/API

Module principal

É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 pouvons avoir parfois besoin de faire des modifications impactantes ; 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’information, voyez API:Errors and warnings.

Paramètres :
action

Quelle action effectuer.

abusefiltercheckmatch
Ce module a été désactivé.
abusefilterchecksyntax
Ce module a été désactivé.
abusefilterevalexpression
Ce module a été désactivé.
abusefilterunblockautopromote
Ce module a été désactivé.
addstudents
Ce module a été désactivé.
antispoof
Ce module a été désactivé.
block
Ce module a été désactivé.
bouncehandler
Ce module a été désactivé.
categorytree
Ce module a été désactivé.
centralauthtoken
Ce module a été désactivé.
centralnoticecdbcacheupdatebanner
Ce module a été désactivé.
centralnoticechoicedata
Ce module a été désactivé.
centralnoticequerycampaign
Ce module a été désactivé.
changeauthenticationdata
Ce module a été désactivé.
checktoken
Ce module a été désactivé.
cirrus-config-dump
Ce module a été désactivé.
cirrus-mapping-dump
Ce module a été désactivé.
cirrus-settings-dump
Ce module a été désactivé.
clearhasmsg
Ce module a été désactivé.
clientlogin
Ce module a été désactivé.
compare
Ce module a été désactivé.
createaccount
Ce module a été désactivé.
cspreport
Ce module a été désactivé.
cxconfiguration
Ce module a été désactivé.
cxdelete
Ce module a été désactivé.
cxpublish
Ce module a été désactivé.
cxsave
Ce module a été désactivé.
cxsuggestionlist
Ce module a été désactivé.
cxtoken
Ce module a été désactivé.
delete
Ce module a été désactivé.
deleteeducation
Ce module a été désactivé.
deleteglobalaccount
Ce module a été désactivé.
echomarkread
Ce module a été désactivé.
echomarkseen
Ce module a été désactivé.
edit
Ce module a été désactivé.
editmassmessagelist
Ce module a été désactivé.
emailuser
Ce module a été désactivé.
enlist
Ce module a été désactivé.
expandtemplates
Ce module a été désactivé.
fancycaptchareload
Ce module a été désactivé.
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
Ce module a été désactivé.
globalblock
Ce module a été désactivé.
globalpreferences
Ce module a été désactivé.
globaluserrights
Ce module a été désactivé.
graph
Ce module a été désactivé.
help
Afficher l’aide pour les modules spécifiés.
imagerotate
Faire pivoter une ou plusieurs images.
import
Ce module a été désactivé.
jsonconfig
Ce module a été désactivé.
jsondata
Ce module a été désactivé.
languagesearch
Ce module a été désactivé.
linkaccount
Ce module a été désactivé.
liststudents
Ce module a été désactivé.
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
Ce module a été désactivé.
massmessage
Ce module a été désactivé.
mergehistory
Ce module a été désactivé.
mobileview
Renvoie les données nécessaires pour les affichages mobile.
move
Ce module a été désactivé.
oathvalidate
Ce module a été désactivé.
opensearch
Ce module a été désactivé.
options
Ce module a été désactivé.
pagetriageaction
Ce module a été désactivé.
pagetriagelist
Ce module a été désactivé.
pagetriagetagging
Ce module a été désactivé.
pagetriagetemplate
Ce module a été désactivé.
paraminfo
Obtenir des informations sur les modules de l’API.
parse
Ce module a été désactivé.
parser-migration
Ce module a été désactivé.
parsoid-batch
Ce module a été désactivé.
patrol
Ce module a été désactivé.
protect
Ce module a été désactivé.
purge
Ce module a été désactivé.
query
Extraire des données de MediaWiki et à propos de celui-ci.
raw
Ce module a été désactivé.
record-lint
Ce module a été désactivé.
refresheducation
Ce module a été désactivé.
removeauthenticationdata
Ce module a été désactivé.
resetpassword
Ce module a été désactivé.
review
Ce module a été désactivé.
reviewactivity
Ce module a été désactivé.
revisiondelete
Ce module a été désactivé.
rollback
Ce module a été désactivé.
rsd
Ce module a été désactivé.
sanitize-mapdata
Ce module a été désactivé.
scribunto-console
Ce module a été désactivé.
setglobalaccountstatus
Ce module a été désactivé.
setnotificationtimestamp
Ce module a été désactivé.
setpagelanguage
Ce module a été désactivé.
sitematrix
Ce module a été désactivé.
spamblacklist
Ce module a été désactivé.
stabilize
Ce module a été désactivé.
stashedit
Ce module a été désactivé.
strikevote
Ce module a été désactivé.
tag
Ce module a été désactivé.
templatedata
Ce module a été désactivé.
thank
Ce module a été désactivé.
titleblacklist
Ce module a été désactivé.
transcodereset
Ce module a été désactivé.
ulslocalization
Ce module a été désactivé.
unblock
Ce module a été désactivé.
undelete
Ce module a été désactivé.
unlinkaccount
Ce module a été désactivé.
upload
Ce module a été désactivé.
userrights
Ce module a été désactivé.
validatepassword
Ce module a été désactivé.
visualeditor
Ce module a été désactivé.
watch
Ajouter ou supprimer des pages de la liste de suivi de l’utilisateur actuel.
webapp-manifest
Retourne un manifest webapp.
wikilove
Ce module a été désactivé.
zeroconfig
Ce module a été désactivé.
tokens
Obsolète. Obtenir des jetons pour des actions de modification des données.
Une des valeurs suivantes : abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, addstudents, antispoof, block, bouncehandler, categorytree, centralauthtoken, centralnoticecdbcacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, cspreport, cxconfiguration, cxdelete, cxpublish, cxsave, cxsuggestionlist, cxtoken, delete, deleteeducation, deleteglobalaccount, echomarkread, echomarkseen, edit, editmassmessagelist, emailuser, enlist, expandtemplates, fancycaptchareload, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferences, globaluserrights, graph, help, imagerotate, import, jsonconfig, jsondata, languagesearch, linkaccount, liststudents, login, logout, managetags, massmessage, mergehistory, mobileview, move, oathvalidate, opensearch, options, pagetriageaction, pagetriagelist, pagetriagetagging, pagetriagetemplate, paraminfo, parse, parser-migration, parsoid-batch, patrol, protect, purge, query, raw, record-lint, refresheducation, removeauthenticationdata, resetpassword, review, reviewactivity, revisiondelete, rollback, rsd, sanitize-mapdata, scribunto-console, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, sitematrix, spamblacklist, stabilize, stashedit, strikevote, tag, templatedata, thank, titleblacklist, transcodereset, ulslocalization, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, visualeditor, watch, webapp-manifest, wikilove, zeroconfig, tokens
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-age à ce nombre 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 qu’il a le droit d’un utilisateur robot lorsque la valeur est bot.

Une des valeurs suivantes : user, bot
assertuser

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

Type : 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), mettre le domaine d’origine dans ce paramètre. Il doit être inclus dans toute requête de pre-flight, 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 header, donc il doit ê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 que l’origine est en liste blanche, des entêtes Access-Control-Allow-Origin et Access-Control-Allow-Credentials seront positionnés.

Pour les requêtes non authentifiées, spécifiez la valeur *. Cela positionnera l’entête Access-Control-Allow-Origin, mais Access-Control-Allow-Credentials vaudra false et toutes les données spécifiques à l’utilisateur seront filtrées.

uselang

Langue à utiliser pour les traductions de message. action=query&meta=siteinfo avec siprop=languages renvoie une liste de codes de langue, ou en spécifiant user pour utiliser la préférence de langue de l’utilisateur actuel, ou en spécifiant content pour utiliser le langage du contenu de ce wiki.

Par défaut : user
errorformat

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

plaintext
Wikitexte avec balises HTML supprimées et les entités remplacées.
wikitext
wikitexte non analysé.
html
HTML.
raw
Clé de message et paramètres.
none
Aucune sortie de texte, uniquement les codes erreur.
bc
Format utilisé avant MediaWiki 1.29. errorlang et errorsuselocal sont ignorés.
Une des valeurs suivantes : plaintext, wikitext, html, raw, none, bc
Par défaut : bc
errorlang

Langue à utiliser pour les avertissements et les erreurs. action=query&meta=siteinfo avec siprop=languages renvoyant une liste de codes de langue, ou spécifier content pour utiliser la langue du contenu de ce wiki, ou spécifier uselang pour utiliser la même valeur que le paramètre uselang.

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)
Droits :
writeapi
Utiliser l'API de modification du wiki
Accordé à : editeur
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é à : editeur

Type de données

Les entrées dans MediaWiki doivent être en UTF-8 à la norme NFC. MediaWiki peut tenter de convertir d’autres types d’entrées, mais cela peut faire échouer certaines opérations (comme les modifications avec contrôles MD5).

Certains types de paramètres dans les requêtes de l’API nécessitent plus d’explication :

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, enlever complètement le paramètre.
timestamp
Les horodatages peuvent être spécifiés sous différentes formes, voir les formats d’entrées de la librairie Timestampdocumentés sur mediawiki.org pour plus de détails. La date et heure ISO 8601 est recommandée : 2001-01-15T14:56:00Z. De plus, la chaîne de caractères now peut être utilisée pour spécifier le fuseau horaire actuel.
séparateur multi-valeurs alternatif
Les paramètres prenant plusieurs valeurs sont normalement validés lorsque celles-ci sont séparées par le caractère « pipe » (|), ex. paramètre=valeur1|valeur2 ou paramètre=valeur1%7Cvaleur2. Si une valeur doit contenir le caractère « pipe », utiliser U+001F (séparateur de sous-articles) comme séparateur et la préfixer de U+001F, ex. paramètre=%1Fvaleur1%1Fvaleur2.

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 Sept. 2006–Sept. 2007)
  • Roan Kattouw (développeur en chef 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/.