Aide de l’API de MediaWiki

Ceci est une page d’aide de l’API de MédiaWiki générée automatiquement.

Documentation et exemples : https://www.mediawiki.org/wiki/API

Module principal

État : Toutes les fonctionnalités affichées sur cette page devraient fonctionner, mais l’API est encore en cours de développement et peut changer à tout moment. 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 en-tête HTTP sera renvoyé avec la clé « MediaWiki-API-Error ». La valeur de cet en-tê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.

Une valeur : block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
Par défaut : help
format

Le format de sortie.

Une valeur : dbg, dbgfm, dump, dumpfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm
Par défaut : jsonfm
maxlag

La latence maximale peut être utilisée quand MédiaWiki est installé sur un cluster de base de données répliqué. 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: Maxlag parameter pour plus d’information.

smaxage

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

Par défaut : 0
maxage

Fixer l’entête max-age à ce nombre de secondes. Les erreurs ne sont jamais mises en cache.

Par défaut : 0
assert

Vérifier si l’utilisateur est connecté si positionné à user, ou a le droit utilisateur robot si positionné à bot.

Une valeur : user, bot
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.

curtimestamp

Inclure l’horodatage actuel dans le résultat.

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). 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, un entête Access-Control-Allow-Origin sera positionné.

uselang

Langue à utiliser pour les traductions de message. Une liste de codes peut être analysée depuis action=query&meta=siteinfo avec siprop=languages, 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
Exemples :
Aide pour le module principal
api.php?action=help
Toute l’aide sur une page
api.php?action=help&recursivesubmodules=1
Droits :
writeapi
Utiliser l'API de modification du wiki
Accordé à : all, user, bot, lelierre
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, sysop

Remerciements

Développeurs de l’API :

  • Roan Kattouw (développeur en chef Sept. 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (créateur, développeur en chef Sept. 2006–Sept. 2007)
  • 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/.