API:Block
 | Cette page fait partie de la documentation de l'API MediaWiki Action. |
| Version de MediaWiki : | ≥ 1.12 |
Requête POST pour bloquer ou débloquer un utilisateur.
Bloquer des utilisateurs
Documentation de l'API
action=block(main | block)
Block a user. Specific parameters: Other general parameters are available.
Examples:
|
Exemple
Faire une requête POST est un processus en plusieurs étapes :
- Se connecter au travers de l'une des méthodes décrites sur API:Authentification.
- GET sur un jeton. Ce jeton est égal au jeton de modification et change à chaque connexion.
- Envoyer une requête POST avec le jeton pour bloquer un utilisateur.
Requête POST
Exemple de blocage d'un utilisateur pendant 1 jour en inhibant la création de compte et de courriel.
api.php?
Réponse
{
"block": {
"user": "Example",
"userID": 2,
"expiry": "2015-02-25T07:27:50Z",
"id": "8",
"reason": "Time out",
"nocreate": "",
"noemail": ""
}
}
Exemple de code de blocage d'utilisateurs
Python
#!/usr/bin/python3
"""
block_user.py
MediaWiki API Demos
Demo of `Block` module: sending POST request to block user
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": "your_bot_username",
"lgpassword": "your_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 block user
PARAMS_3 = {
"action": "block",
"user": "Example",
"expiry": "2015-02-25T07:27:50Z",
"reason": "Time out",
"token": CSRF_TOKEN,
"format": "json"
}
R = S.post(URL, data=PARAMS_3)
DATA = R.json()
print(DATA)
PHP
<?php
/*
block_user.php
MediaWiki API Demos
Demo of `Block` module: sending POST request to block user
MIT license
*/
$endPoint = "http://dev.wiki.local.wmftest.net:8080/w/api.php";
$login_Token = getLoginToken(); // Step 1
loginRequest( $login_Token ); // Step 2
$csrf_Token = getCSRFToken(); // Step 3
block( $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 block user
function block( $csrftoken ) {
global $endPoint;
$params4 = [
"action" => "block",
"user" => "ABCD",
"expiry" => "2020-02-25T07:27:50Z",
"reason" => "API Test",
"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
/*
block_user.js
MediaWiki API Demos
Demo of `Block` module: sending POST request to block user
MIT license
*/
var request = require('request').defaults({jar: true}),
url = "http://dev.wiki.local.wmftest.net:8080/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);
block(data.query.tokens.csrftoken);
});
}
// Step 4: POST request to block user
function block(csrf_token) {
var params_3 = {
action: "block",
user: "ABCDEF",
expiry: "2020-02-25T07:27:50Z",
reason: "API Test",
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
/*
block_user.js
MediaWiki API Demos
Demo of `Block` module: sending POST request to block user
MIT License
*/
var params = {
action: 'block',
user: 'ABCD',
expiry: '2020-02-25T07:27:50Z',
reason: 'API Test',
format: 'json'
},
api = new mw.Api();
api.postWithToken( 'csrf', params ).done( function ( data ) {
console.log( data );
} );
Débloquer des utilisateurs
Documentation de l'API
action=unblock(main | unblock)
Unblock a user. Specific parameters: Other general parameters are available.
Examples:
|
Exemple
Requête POST
Exemple de déblocage avec excuses
api.php?
Réponse
{
"id": "16",
"user": "Example",
"userid": 2,
"reason": "Sorry Example"
}
Erreurs possibles
| Code (Bloquer) | Information |
|---|---|
| alreadyblocked | L'utilisateur que vous souhaitez bloquer est déjà bloqué |
| cantblock | Vous n’avez pas le droit de bloquer des utilisateurs. |
| cantblock-email | Vous n’avez pas le droit de bloquer des utilisateurs pour envoyer des courriels via ce wiki. |
| canthide | Vous n’avez pas le droit de masquer les noms d’utilisateur du journal de blocages.
Cette fonctionnalité doit être activée explicitement dans LocalSettings.php.
|
| invalidexpiry | Valeur non valide de la temporisation |
| invalidip | Adresse IP spécifiée non valide |
| invalidrange | Intervalle non valide d'adresses IP |
| notoken | Le paramètre token doit être défini. |
| nouser | Le paramètre user doit être défini. |
| pastexpiry | La date d’expiration « $1 » est dépassée. |
| permissiondenied | Vous n’avez pas le droit de bloquer des utilisateurs.
Sur la plupart des wikis, le blocage des utilisateurs est réservé aux administrateurs système, mais les autres wikis peuvent avoir des règles différentes.
|
| rangedisabled | Le bocage d'intervalles d'adresses IP a été désactivé |
| Code (Débloquer) | Information |
|---|---|
| notarget | Il faut déclarer soit le paramètre utilisateur, soit l'ID |
| notoken | Le paramètre token doit être défini. |
| idanduser | L'ID et les paramètres utilisateur ne peuvent pas être utilisés simultanément |
| blockedasrange | L'addresse IP « address » a été bloquée comme faisant partie de l'intervalle « range ». Vous ne pouvez pas la débloquer individuellement, mais vous pouvez débloquer l'intervalle dans sa totalité. |
| cantunblock | Le blocage que vous avez indiqué n'existe pas. Il est possible qu'il ait été débloqué entre temps |
| permissiondenied | Vous n’avez pas le droit de débloquer les utilisateurs.
Sur la plupart des wikis, le déblocage des utilisateurs est réservé aux administrateurs système, mais les autres wikis peuvent avoir des règles différentes.
|
Historique des paramètres
- 1.29: Ajouté
tags - 1.21: Supprimé
gettoken - 1.20: Obsolète
gettoken - 1.18: Ajouté
watchuser - 1.14: Ajouté
allowusertalk,reblock
Voir aussi
- API:Groupe d'apartenance de l'utilisateur - Ajouter ou supprimer des utilisateurs dans un groupe
- API:Blocks - Lister tous les blocages