API:Edit

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page API:Edit and the translation is 100% complete.

Other languages:
Deutsch • ‎English • ‎Tiếng Việt • ‎dansk • ‎español • ‎français • ‎polski • ‎русский • ‎тоҷикӣ • ‎中文 • ‎日本語
Version de MediaWiki : 1.13

Requête POST pour modifier une page.

Documentation de l'API




action=edit

(main | edit)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Create and edit pages.

Parameters:
title

Title of the page to edit. Cannot be used together with pageid.

pageid

Page ID of the page to edit. Cannot be used together with title.

Type: integer
section

Section number. 0 for the top section, new for a new section.

sectiontitle

The title for a new section.

text

Page content.

summary

Edit summary. Also section title when section=new and sectiontitle is not set.

tags

Change tags to apply to the revision.

Values (separate with | or alternative):
minor

Mark this edit as a minor edit.

Type: boolean (details)
notminor

Do not mark this edit as a minor edit even if the "Mark all edits minor by default" user preference is set.

Type: boolean (details)
bot

Mark this edit as a bot edit.

Type: boolean (details)
basetimestamp

Timestamp of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions&rvprop=timestamp.

Type: timestamp (allowed formats)
starttimestamp

Timestamp when the editing process began, used to detect edit conflicts. An appropriate value may be obtained using curtimestamp when beginning the edit process (e.g. when loading the page content to edit).

Type: timestamp (allowed formats)
recreate

Override any errors about the page having been deleted in the meantime.

Type: boolean (details)
createonly

Don't edit the page if it exists already.

Type: boolean (details)
nocreate

Throw an error if the page doesn't exist.

Type: boolean (details)
watch
Deprecated.

Add the page to the current user's watchlist.

Type: boolean (details)
unwatch
Deprecated.

Remove the page from the current user's watchlist.

Type: boolean (details)
watchlist

Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.

One of the following values: watch, unwatch, preferences, nochange
Default: preferences
md5

The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated. If set, the edit won't be done unless the hash is correct.

prependtext

Add this text to the beginning of the page. Overrides text.

appendtext

Add this text to the end of the page. Overrides text.

Use section=new to append a new section, rather than this parameter.

undo

Undo this revision. Overrides text, prependtext and appendtext.

The value must be no less than 0.
Type: integer
undoafter

Undo all revisions from undo to this one. If not set, just undo one revision.

The value must be no less than 0.
Type: integer
redirect

Automatically resolve redirects.

Type: boolean (details)
contentformat

Content serialization format used for the input text.

One of the following values: application/json, text/css, text/plain, text/x-wiki, text/javascript
contentmodel

Content model of the new content.

One of the following values: GadgetDefinition, SecurePoll, sanitized-css, MassMessageListContent, flow-board, Scribunto, JsonSchema, NewsletterContent, wikitext, javascript, json, css, text
token

A "csrf" token retrieved from action=query&meta=tokens

The token should always be sent as the last parameter, or at least after the text parameter.

This parameter is required.
captchaword

Answer to the CAPTCHA

captchaid

CAPTCHA ID from previous request

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:Jetons 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":"Sandbox",
        "contentmodel":"wikitext",
        "oldrevid":371705,
        "newrevid":371707,
        "newtimestamp":"2018-12-18T16:59:42Z"
    }
}

Exemple de code

edit.py

#!/usr/bin/python3

"""
    edit.py

    MediaWiki Action API Code Samples
    Demo of `Edit` module: POST request to edit a page
    Based on User:Александр Сигачёв, 
    https://www.mediawiki.org/wiki/API:Edit/Editing_with_Python
    MIT license
"""

import requests

S = requests.Session()

URL = "https://test.wikipedia.org/w/api.php"

# Step 1: Retrieve a login token
PARAMS_1 = {
    "action": "query",
    "meta": "tokens",
    "type": "login",
    "format": "json"
}

R = S.get(url=URL, params=PARAMS_1)
DATA = R.json()

LOGIN_TOKEN = DATA["query"]["tokens"]["logintoken"]

# Step 2: Send a post request to log in. For this login 
# method, Obtain credentials by first visiting
# https://test.wikipedia.org/wiki/Special:BotPasswords/
# See https://www.mediawiki.org/wiki/API:Login for more
# information on log in methods.
PARAMS_2 = {
    "action": "login",
    "lgname": "user_name",
    "lgpassword": "password",
    "format": "json",
    "lgtoken": LOGIN_TOKEN
}

R = S.post(URL, data=PARAMS_2)

# Step 3: While logged in, retrieve a CSRF token
PARAMS_3 = {
    "action": "query",
    "meta": "tokens",
    "format": "json"
}

R = S.get(url=URL, params=PARAMS_3)
DATA = R.json()

CSRF_TOKEN = DATA["query"]["tokens"]["csrftoken"]

# Step 4: Send a post request to edit a page
PARAMS_4 = {
    "action": "edit",
    "title": "Sandbox",
    "format": "json",
    "appendtext": "Hello",
    "token": CSRF_TOKEN,
}

R = S.post(URL, data=PARAMS_4)
DATA = R.json()

print(DATA)

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

Longues modifications

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'espacement, 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 Python des « Request » 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.
notext One of the text, appendtext, prependtext and undo parameters must be set
notoken Le paramètre token doit être défini.
invalidsection Le paramètre section doit être un ID de section valide ou new.
protectedtitle This title has been protected from creation
cantcreate You don't have permission to create new pages
cantcreate-anon Anonymous users can't create new pages
articleexists L’article que vous essayez de créer l’a déjà été.
noimageredirect-anon Les utilisateurs anonymes ne peuvent pas créer des redirections d’images.
noimageredirect Vous n’avez pas le droit de créer des redirections d’images.
spamdetected Votre modification a été refusée parce qu’elle contenait un fragment de pourriel : Wikitext.
filtered The filter callback function refused your edit
contenttoobig ⧼Apieror-contenttoobig⧽
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 Edit conflict detected
revwrongpage rrevid n'est pas une révision de pagename.
Thrown if an invalid revid is given for undo or undoafter
undofailure L'annulation a échoué à cause de modifications intermédiaires conflictuelles.
missingtitle La page que vous avez spécifiée n’existe pas.
(see above nocreate parameter)
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. Assurez-vous que la déclaration $wgEnableWriteAPI=true; est incluse dans le fichier LocalSettings.php du wiki.
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 ».
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.
undofailure Undo failed due to conflicting intermediate edits
badmd5 Le hachage MD5 fourni n’était pas correct.
hookaborted La modification que vous avez essayé de faire a été annulée par une extension.
parseerror Failed to parse the given text.
summaryrequired Summary required
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 Editing of this type of page is not supported using the text based edit API.
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.
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 You don't have permission to set change tags
tpt-target-page Cette page ne peut pas être mise à jour manuellement.

Elle est une version traduite de $1 et la traduction peut être mise à jour en utilisant [$2 l’outil de traduction].
When using Extension:Translate, editing of a translated subpage is not allowed.


Historique des paramètres

  • 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:Jetons 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 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 mw.Api pour faire des requêtes, cela est fait automatiquement.
  • Bien que captchaid et captchaword aient, 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:Édition - contient des liens utiles pour modifier les articles.
  • Manual:Bot passwords - 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.
  • Resource Loader - fournit un moyen d'accéder aux jetons d'édition à partir de l'exécution du Javascript présent dans une page MediaWiki.
  • API:Jetons - 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:Jetons , pour demander des jetons dans les versions plus anciennes de MediaWiki.
  • API:Comparer - vous permet de faire des diffs entre les modifications d'une page.
  • API:Managetags - modifie les balises d'une page
  • API:Révocateur - 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

Références