API:Edit
| Cette page fait partie de la documentation de l'API MediaWiki Action. |
| Version de MediaWiki : | ≥ 1.13 |
Requête POST pour modifier une page.
Documentation de l'API
Exemple
L'extrait de code de cet exemple est en Python. Voir API:Edit/Editing with Ajax pour les exemples et les réponses dans Ajax.
Requête POST
Faire des modifications, et bien sûr toute requête POST, sont un processus qui se déroule en plusieurs étapes.
- 1. Se connecter, en utilisant une des méthodes décrites dans API:Authentification. Notez bien que ceci est nécessaire pour attribuer correctement les modifications à leur auteur, mais que beaucoup de wikis permettent réellement à l'utilisateur de modifier sans être enregistré ni être connecté sous un compte.
- 2. OBTENIR un jeton CSRF:
- 3. Envoyer une requête POST, avec le jeton CSRF, pour faire une action sur une page :
La section Response ci-dessous est pour la fin de la requête POST, pour réaliser l'action sur la page. Voir les pages sur API:Authentification et API:Tokens pour les réponses intermédiaires JSON et les étapes qui précèdaient.
Notez aussi que les jetons des requêtes sur cette page sont des valeurs utilisées à titre d'exemple. Les jetons actuels sont uniques à chaque session de connexion et aux requêtes inter-sites. Ils sont ici seulement pour montrer comment formater proprement les requêtes.
Réponse
{
"edit": {
"result": "Success",
"pageid": 94542,
"title": "Wikipedia:Sandbox",
"contentmodel": "wikitext",
"oldrevid": 371705,
"newrevid": 371707,
"newtimestamp": "2018-12-18T16:59:42Z"
}
}
Exemple de code
Python
#!/usr/bin/python3
"""
edit.py
MediaWiki API Demos
Demo of `Edit` module: POST request to edit a page
MIT license
"""
import requests
S = requests.Session()
URL = "https://test.wikipedia.org/w/api.php"
# Step 1: GET request to fetch login token
PARAMS_0 = {
"action": "query",
"meta": "tokens",
"type": "login",
"format": "json"
}
R = S.get(url=URL, params=PARAMS_0)
DATA = R.json()
LOGIN_TOKEN = DATA['query']['tokens']['logintoken']
# Step 2: POST request to log in. Use of main account for login is not
# supported. Obtain credentials via Special:BotPasswords
# (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
PARAMS_1 = {
"action": "login",
"lgname": "bot_user_name",
"lgpassword": "bot_password",
"lgtoken": LOGIN_TOKEN,
"format": "json"
}
R = S.post(URL, data=PARAMS_1)
# Step 3: GET request to fetch CSRF token
PARAMS_2 = {
"action": "query",
"meta": "tokens",
"format": "json"
}
R = S.get(url=URL, params=PARAMS_2)
DATA = R.json()
CSRF_TOKEN = DATA['query']['tokens']['csrftoken']
# Step 4: POST request to edit a page
PARAMS_3 = {
"action": "edit",
"title": "Project:Sandbox",
"token": CSRF_TOKEN,
"format": "json",
"appendtext": "Hello"
}
R = S.post(URL, data=PARAMS_3)
DATA = R.json()
print(DATA)
PHP
<?php
/*
edit.php
MediaWiki API Demos
Demo of `Edit` module: POST request to edit a page
MIT license
*/
$endPoint = "https://test.wikipedia.org/w/api.php";
$login_Token = getLoginToken(); // Step 1
loginRequest( $login_Token ); // Step 2
$csrf_Token = getCSRFToken(); // Step 3
editRequest($csrf_Token); // Step 4
// Step 1: GET request to fetch login token
function getLoginToken() {
global $endPoint;
$params1 = [
"action" => "query",
"meta" => "tokens",
"type" => "login",
"format" => "json"
];
$url = $endPoint . "?" . http_build_query( $params1 );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
$result = json_decode( $output, true );
return $result["query"]["tokens"]["logintoken"];
}
// Step 2: POST request to log in. Use of main account for login is not
// supported. Obtain credentials via Special:BotPasswords
// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
function loginRequest( $logintoken ) {
global $endPoint;
$params2 = [
"action" => "login",
"lgname" => "bot_user_name",
"lgpassword" => "bot_password",
"lgtoken" => $logintoken,
"format" => "json"
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endPoint );
curl_setopt( $ch, CURLOPT_POST, true );
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query( $params2 ) );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
}
// Step 3: GET request to fetch CSRF token
function getCSRFToken() {
global $endPoint;
$params3 = [
"action" => "query",
"meta" => "tokens",
"format" => "json"
];
$url = $endPoint . "?" . http_build_query( $params3 );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
$result = json_decode( $output, true );
return $result["query"]["tokens"]["csrftoken"];
}
// Step 4: POST request to edit a page
function editRequest( $csrftoken ) {
global $endPoint;
$params4 = [
"action" => "edit",
"title" => "Project:Sandbox",
"appendtext" => "Hello",
"token" => $csrftoken,
"format" => "json"
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endPoint );
curl_setopt( $ch, CURLOPT_POST, true );
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query( $params4 ) );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
echo ( $output );
}
JavaScript
/*
edit.js
MediaWiki API Demos
Demo of `Edit` module: POST request to edit a page
MIT license
*/
var request = require('request').defaults({jar: true}),
url = "https://test.wikipedia.org/w/api.php";
// Step 1: GET request to fetch login token
function getLoginToken() {
var params_0 = {
action: "query",
meta: "tokens",
type: "login",
format: "json"
};
request.get({ url: url, qs: params_0 }, function (error, res, body) {
if (error) {
return;
}
var data = JSON.parse(body);
loginRequest(data.query.tokens.logintoken);
});
}
// Step 2: POST request to log in.
// Use of main account for login is not
// supported. Obtain credentials via Special:BotPasswords
// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
function loginRequest(login_token) {
var params_1 = {
action: "login",
lgname: "bot_username",
lgpassword: "bot_password",
lgtoken: login_token,
format: "json"
};
request.post({ url: url, form: params_1 }, function (error, res, body) {
if (error) {
return;
}
getCsrfToken();
});
}
// Step 3: GET request to fetch CSRF token
function getCsrfToken() {
var params_2 = {
action: "query",
meta: "tokens",
format: "json"
};
request.get({ url: url, qs: params_2 }, function(error, res, body) {
if (error) {
return;
}
var data = JSON.parse(body);
editRequest(data.query.tokens.csrftoken);
});
}
// Step 4: POST request to edit a page
function editRequest(csrf_token) {
var params_3 = {
action: "edit",
title: "Project:Sandbox",
appendtext: "test edit",
token: csrf_token,
format: "json"
};
request.post({ url: url, form: params_3 }, function (error, res, body) {
if (error) {
return;
}
console.log(body);
});
}
// Start From Step 1
getLoginToken();
MediaWiki JS
/*
edit.js
MediaWiki API Demos
Demo of `Edit` module: POST request to edit a page
MIT License
*/
var params = {
action: 'edit',
title: 'Project:Sandbox',
appendtext: 'Hello',
format: 'json'
},
api = new mw.Api();
api.postWithToken( 'csrf', params ).done( function ( data ) {
console.log( data );
} );
Cas d'utilisation
Conflits d'édition
L'exemple Python est une implémentation basique d'une requête de modification venant d'un utilisateur enregistré. Dans les scénarii du monde réél il faut faire attention à empêcher les conflits d'édition. Ceux-ci se produisent quand deux utilisateurs ou plus essaient de modifier la même page au même moment.
Les conflits peuvent être évités en récupérant la date de la dernière version de votre demande de jeton CSRF.
En ajoutant prop=info|revisions à la demande de jeton CSRF de l'étape 3 vous accèderez à la date de la dernière version.
Cette date sera utilisée comme basetimestamp lorsque la modification vous sera attribuée.
Il faut également disposer de l'heure exacte à laquelle nous avons commencé à modifier.
Ceci peut être obtenu en ajoutant de la même manière curtimestamp à la demande CSRF.
Celle valeur sera notre starttimestamp.
Enfin, dans la demande de modification actuelle, initialisez les paramètres basetimestamp et starttimestamp ainsi :
api.php?
Modifications longues
Les requêtes POST qui véhiculent un contenu long de texte (plus de 8000 caractères) doivent être envoyées avec Content-Type: multipart/form-data marqué dans l'entête.
Parce que multipart/form-data ne nécessite pas d'ajouter les caractères d'échappement HTML pour les espaces et la ponctuation (c'est à dire un encodage avec des pour-cents), la quantité de données passées sera par conséquent beaucoup plus petite que l'équivalent encodé avec les caractères pour-cents ('%').
Néanmoins, il existe encore un certain dépassement ajouté par multipart/form-data -- en gros, 160 octets par paramètre.
Pour les messages courts qui ne nécessitent pas d'ajouter beaucoup de caractères d'échappement, cette quantité supplémentaire peut être inefficace, et l'encodage avec des pour-cents est préferrable.[1]
Notez que dans notre exemple de code Python, la requête est codée par défaut avec des pour-cents.
Voir la documentation web de MDN pour une discussion plus technique de « content-type » et des requêtes POST.
Voir la Documentation des requêtes Python sur la manière de passer multipart/form-data en utilisant une syntaxe similaire à notre exemple de code Python.
Les CAPTCHAs
Si le wiki que vous ciblez utilise les CAPTCHAs, votre requête peut retourner une erreur contenant un identifiant et un simple test, tel qu'une question, un problème mathématique, ou une URL vers une image.
Afin de terminer votre modification, vous devez terminer le test, puis réessayer votre requête avec l'Id et la/les réponses correctes ajoutées à la chaîne originale de votre requête ainsi : captchaid=sampleId&captchaword=answer
D'autres systèmes de CAPTCHA et d'extensions peuvent utiliser différents paramètres pour une utilisation similaire. En général, utilisez dans les paramètres de votre second requête, le nom des champs dans les questions concernant l'id et le test.
Erreurs possibles
| Code | Informations | ||||||
|---|---|---|---|---|---|---|---|
| notitle | Le paramètre title doit être défini. | ||||||
| missingparam | Au moins un des paramètres text, appendtext et undo est obligatoire. | ||||||
| notoken | Le paramètre token doit être défini. | ||||||
| invalidsection | Le paramètre section doit être un identifiant de section valide ou new. | ||||||
| protectedpage |
| ||||||
| cantcreate | Vous n’avez pas la permission de créer de nouvelles pages. | ||||||
| cantcreate-anon | Les utilisateurs anonymes ne peuvent pas créer de nouvelles pages | ||||||
| articleexists | La page que vous essayez de créer est déjà créée. | ||||||
| noimageredirect-anon | Les utilisateurs anonymes ne peuvent pas créer des redirections d’images. | ||||||
| noimageredirect | Vous n’avez pas la permission de créer des redirections d’image. | ||||||
| spamdetected | Votre modification a été refusée parce qu’elle contenait un fragment de pourriel : Wikitext.
| ||||||
| abusefilter-warning | Cette action a été automatiquement identifiée comme nocive. | ||||||
| abusefilter-disallowed | Cette action a été automatiquement identifiée comme nuisible, et donc interdite. | ||||||
| contenttoobig | Le contenu que vous avez fourni dépasse la taille maximale autorisée pour une page (bytes kibioctet). Where bytes is the value of $wgMaxArticleSize. | ||||||
| noedit-anon | Les utilisateurs anonymes ne peuvent pas modifier les pages. | ||||||
| noedit | Vous n’avez pas le droit de modifier les pages. | ||||||
| pagedeleted | La page a été supprimée depuis que vous avez récupéré son horodatage. | ||||||
| emptypage | Il n’est pas possible de créer de nouvelles pages vides. | ||||||
| emptynewsection | Il n’est pas possible de créer de nouvelles sections vides. | ||||||
| editconflict | Conflit de modification. | ||||||
| revwrongpage | rrevid n’est pas une révision de pagename. Se produit si un revid non valide est fournit pour undo ou undoafter
| ||||||
| undofailure | Cette modification ne peut pas être annulée : cela entrerait en conflit avec les modifications intermédiaires. | ||||||
| missingtitle | La page que vous avez spécifiée n’existe pas. (voir ci-dessus le paramètre nocreate)
| ||||||
| mustbeposted | Le module edit nécessite une requête POST. | ||||||
| readapidenied | Vous avez besoin du droit de lecture pour utiliser ce module. | ||||||
| writeapidenied | Vous n’êtes pas autorisé à modifier ce wiki au travers de l’API. | ||||||
| noapiwrite | La modification de ce wiki via l’API est désactivée. | ||||||
| badtoken | Jeton CSRF non valide. | ||||||
| missingparam | Le paramètre title, pageid doit être défini. | ||||||
| invalidparammix | Les paramètres title, pageid ne peuvent pas être utilisés ensemble. | ||||||
| invalidtitle | Mauvais titre « title ». | ||||||
| invalid-content-data | Données du contenu non valides se produit lorsque vous essayez de modifier une page JSON avec des données non conformes, ou lorsque vous essayer de modifier une page MassMessageListContent | ||||||
| nosuchpageid | Il n’y a pas de page avec l’ID pageid. | ||||||
| pagecannotexist | L’espace de noms ne permet pas de pages réelles. | ||||||
| nosuchrevid | Il n’y a pas de révision d’ID undo. | ||||||
| nosuchrevid | Il n’y a pas de révision d’ID undoafter. | ||||||
| badmd5 | Le hachage MD5 fourni n’était pas correct. | ||||||
| hookaborted | La modification que vous avez essayé de faire a été empêchée par une extension. | ||||||
| parseerror | Échec de sérialisation du contenu : parseerror | ||||||
| summaryrequired | ⧼apierror-summaryrequired⧽ | ||||||
| blocked | Vous avez été bloqué pour modifier. | ||||||
| ratelimited | Vous avez dépassé votre limite de débit. Veuillez attendre un peu et réessayer. | ||||||
| unknownerror | Erreur inconnue : « retval ». | ||||||
| nosuchsection | Il n’y a pas de section $1. | ||||||
| sectionsnotsupported | Les sections ne sont pas prises en charge pour le modèle de contenu $1. | ||||||
| editnotsupported | La modification de ce type de page n'est pas prise en charge par l'API de modification basée sur le texte. | ||||||
| appendnotsupported | Impossible d’ajouter aux pages utilisant le modèle de contenu $1. | ||||||
| redirect-appendonly | Vous avez essayé de modifier en utilisant le mode de suivi de redirection, qui doit être utilisé en lien avec section=new, prependtext, ou appendtext. | ||||||
| edit-invalidredirect | Impossible de modifier $1 en suivant une redirection, car la cible $2 n’est pas valide. | ||||||
| badformat | Le format demandé $1 n’est pas pris en charge pour le modèle de contenu $2 utilisé par $3. | ||||||
| customcssprotected | Vous n’avez pas la permission de modifier cette feuille de style CSS, car elle contient les paramètres personnels d’un autre utilisateur. | ||||||
| customjsprotected | Vous n’avez pas la permission de modifier cette page de JavaScript, car elle contient les paramètres personnels d’un autre utilisateur. | ||||||
| taggingnotallowed | Vous n'avez pas l'autorisation de définir les libellés de modification | ||||||
| badtags | La balise « Tag » n’est pas autorisée à être appliquée manuellement. La balise suivante n’est pas autorisée à être appliquée manuellement : Tag1, Tag2 | ||||||
| tpt-target-page | Cette page ne peut pas être mise à jour manuellement.
C’est une traduction de la page $1 et la traduction peut être mise à jour en utilisant [$2 l’outil de traduction]. |
Historique des paramètres
- v1.35: ajouté
baserevid - v1.25: ajouté
tags - v1.21: ajouté
contentformat,contentmodel - v1.20: ajouté
pageid - v1.19: ajouté
sectiontitle - v1.18: obsolète
captchaid,captchaword - v1.17: ajouté
redirect - v1.16: obsolète
watch,unwatch - v1.16: ajouté
watchlist - v1.15: ajouté
undo,undoafter - v1.14: ajouté
starttimestamp
Notes supplémentaires
- L'API n'oblige pas que l'on soit strictement connecté, mais il faut attribuer correctement la modification à son auteur. Une modification réussie d'un utilisateur non connecté sera attribuée à son adresse IP.
- Les robots qui ne sont pas connectés peuvent rencontrer des restrictions lors des demandes de modification ou d'autres écritures; voir Manuel:Creation de robot#Connexion pour plus de détails.
- Les utilisateurs qui ne sont pas connectés recevront toujours le jeton CSRF vide,
+\. - Le processus de demande de jeton a évolué à plusieurs reprises au fil des versions. Voir API:Tokens pour plus d'information.
- ResourceLoader fournit un moyen d'accéder aux jetons d'édition à partir de l'exécution du code présent dans une page wiki.
- Vous pouvez utiliser le même jeton CSRF pour toutes les opérations de modification du même wiki, dans une même session connectée.
- Une bonne habitude est de passer les jetons dans la requête à la fin de la chaîne « query », ou au moins après le paramètre de texte. Ainsi, si la connexion est rompue, le jeton ne sera pas passé et la modification échouera. Si vous utilisez l'objet mw.Api pour faire des requêtes, cela est fait automatiquement.
- Bien que
captchaidetcaptchawordaient, techniquement, été supprimés de API:Edit depuis v1.18, Extension:ConfirmEdit étend API:Edit pour travailler avec les CAPTCHAs. Ainsi, si vous installez ConfirmEdit, ces paramètres sont encore disponibles. ConfirmEdit est fourni dans le même paquet que le logiciel MediaWiki, v1.18+.
Voir aussi
- Aide:Contribuer - contient des liens utiles pour modifier les articles.
- Manuel:Mots de passe des robots - décrit comment se connecter en utilisant un interface simplifié quand on accède aux wikis par un script ou une application, plutôt que par l'interface graphique.
- Manual:Creating a bot - davantage de détails sur la façon d'utiliser un robot pour modifier automatiquement des pages.
- ResourceLoader - fournit un moyen d'accéder aux jetons d'édition à partir de l'exécution du JavaScript présent dans une page MediaWiki.
- API:Tokens - contient davantage de détails sur la manière d'utiliser les jetons pour se connecter ou pour faire des requêtes POST.
- API:Tokens (action) - une API désuète, différente de API:Tokens, pour demander des jetons dans les versions plus anciennes de MediaWiki.
- API:Compare - vous permet de faire des diffs entre les modifications d'une page.
- API:Managetags - modifie les balises d'une page
- API:Révocation - annule une série de modifications.
- API:Filerevert - restitue les fichiers à un état antérieur.
- API:Revisiondelete - supprime et restitue les modifications d'une page