API:Edit/fr

Requête POST pour modifier une page.

Exemple
L'extrait de code de cet exemple est en Python. Voir pour les exemples et les réponses dans.

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


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

Exemple de code
edit.py

Conflits d'édition
L'exemple Python ci-dessus 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 de votre demande de jeton CSRF. En ajoutant  à 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  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   à la demande CSRF. Celle valeur sera notre.

Enfin, dans la demande de modification actuelle, initialisez les paramètres  et   ainsi :

Longues modifications
Les requêtes POST qui véhiculent un contenu long de texte (plus de 8000 caractères) doivent être envoyées avec  marqué dans l'entête. Parce que  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  -- en gros, 160 octets par paramètre. Pour les messages courts qui ne nécessitent pas d'ajouter beaucoup de caractères d'espacement, cette quantité supplémentaire peut être inefficace, et l'encodage avec des pour-cents est préferrable.

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 Python des « Request » sur la manière de passer   en utilisant une syntaxe similaire à notre exemple de code Python.

Les CAPTCHAs
Si le wiki que vous ciblez utilise les, 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 :

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.

Historique des paramètres

 * v1.25: ajouté
 * v1.21: ajouté ,
 * v1.20: ajouté
 * v1.19: ajouté
 * v1.18: obsolète ,
 * v1.17: ajouté
 * v1.16: obsolète ,
 * v1.16: ajouté
 * v1.15: ajouté ,
 * v1.14: ajouté

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 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 pour plus d'information.
 * 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 de connexion 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 pour faire des requêtes, cela est fait automatiquement.
 * Bien que  et   aient, techniquement, été supprimés de API:Edit depuis v1.18,  é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

 * - contient des liens utiles pour modifier les articles.
 * - 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.
 * - davantage de détails sur la façon d'utiliser un robot pour modifier automatiquement des pages.
 * - fournit un moyen d'accéder aux jetons d'édition à partir de l'exécution du Javascript présent dans une page MediaWiki.
 * - contient davantage de détails sur la manière d'utiliser les jetons pour se connecter ou pour faire des requêtes POST.
 * - une API désuète, différente de, pour demander des jetons dans les versions plus anciennes de MediaWiki.
 * - vous permet de faire des diffs entre les modifications d'une page.
 * - modifie les balises d'une page
 * - annule une série de modifications.
 * - restitue les fichiers à un état antérieur.
 * - supprime et restitue les modifications d'une page