Bac à sable de l'API

Utilisez cette page pour expérimenter l’API webservice de MediaWiki. Reportez-vous à la documentation de l’API pour plus de détails sur l’utilisation de l’API. Exemple : Rechercher des titres de page correspondant à un mot-clé donné. Choisissez une option pour voir d’autres exemples.

main

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

Exemples

Quelle action effectuer.

acquiretempusername: Obtenir un nom d’utilisateur temporaire et le stocker dans la session en cours, si la création de comptes temporaires est activée et si l’utilisateur actuel est déconnecté. Si un nom a déjà été stocké, renvoie ce même nom.
ask: Module d’API pour interroger MediaWiki Sémantique en utilisant le langage de requête « ask ».
askargs: Module d’API pour interroger MediaWiki Sémantique en utilisant le langage de requête « ask » avec une liste de conditions, de résultats et de paramètres.
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.
ext.srf.datatables.api
ext.srf.slideshow.show
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.
pfautocomplete: Complétion automatique utilisée par l’extension Formulaires de page.
pfautoedit: Créer ou modifier une page en utilisant un formulaire défini par l’extension Formulaires de page.
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.
smwbrowse: Module API pour prendre en charge l’analyse des activités pour différents types d’entités dans MediaWiki Sémantique.
smwinfo: Module d’API pour récupérer des informations concernant les statistiques de MediaWiki Sémantique ainsi que d’autres méta-informations.
smwtask: Module d’API pour exécuter les tâches relatives à MediaWiki Sémantique (pour un usage interne uniquement, pas pour un usage public).
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.
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.
veforall-parsoid-utils: Convertir le texte dans les deux sens, du wikicode au HTML
watch: Ajouter ou supprimer des pages de la liste de suivi de l’utilisateur actuel.
browsebyproperty: Obsolète. Module d’API pour récupérer des informations concernant une propriété ou une liste de propriétés.
browsebysubject: Obsolète. Module d’API pour récupérer des informations concernant un sujet.
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.
stashedit: Interne. Préparer des modifications dans le cache partagé.
visualeditor: Interne. Renvoie une page HTML5 du service Parsoid.
visualeditoredit: Interne. Enregistrer une page HTML5 en MediaWiki (convertie en wikicode 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 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.

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

La valeur ne peut pas être inférieure à 0.

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.

La valeur ne peut pas être inférieure à 0.

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.

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

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.

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

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.

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.