API:Edit
Outdated translations are marked like this.
| Bu sayfa MediaWiki Eylem API'si belgelerinin bir parçasıdır. |
| MediaWiki sürümü: | ≥ 1.13 |
Bir sayfayı düzenlemek için POST isteği.
API belgesi
Örnek
Bu örnekteki örnek kod Python'dadır. Ajax içindeki örnekler ve yanıtlar için API:Edit/Editing with Ajax sayfasına bakın.
POST isteği
Düzenlemeler ve gerçekten de herhangi bir POST isteği yapmak çok adımlı bir süreçtir.
- 1. API:Oturum aç üzerinde açıklanan yöntemlerden birini kullanarak oturum açın. Düzenlemeyi yazarına doğru bir şekilde atfetmek için gerekli olsa da, birçok viki kullanıcının bir hesaba kaydolmadan veya bir hesaba giriş yapmadan düzenleme yapmasına izin verdiğini unutmayın.
- 2. CSRF anahtar GET'i:
- 3. Bir sayfada işlem yapmak için CSRF anahtarıyla bir POST isteği gönderin:
Aşağıdaki Yanıt bölümü, son POST isteği için sayfada işlem yapılması içindir. Önceki adımlara verilen JSON aracı yanıtları için API:Oturum aç ve API:Tokens sayfalarına bakın.
Ayrıca, bu sayfadaki sorgulardaki anahtarlarını örnek değerler olduğunu unutmayın. Gerçek anahtarlar her oturum açma oturumu ve siteler arası istek için benzersizdir. Bunlar yalnızca sorguların nasıl düzgün biçimlendirileceğini göstermek için dahil edilmiştir.
Yanıt
{
"edit": {
"result": "Success",
"pageid": 94542,
"title": "Wikipedia:Sandbox",
"contentmodel": "wikitext",
"oldrevid": 371705,
"newrevid": 371707,
"newtimestamp": "2018-12-18T16:59:42Z"
}
}
Örnek kod
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 );
} );
Kullanım örnekleri
Düzenleme çakışması
Python örneği, kayıtlı bir kullanıcının düzenleme isteğinin temel bir uygulamasıdır. Gerçek dünya senaryolarında, düzenleme çatışmalarını önlemek için özen gösterilmelidir. Bunlar, iki veya daha fazla kullanıcı aynı sayfayı aynı anda düzenlemeye çalıştığında ortaya çıkar.
Bir CSRF jetonu istediğimizde, son revizyon zaman damgası alınarak çakışmalar önlenebilir.
3. Adım'daki CSRF anahtarı isteğine prop=info|revisions eklemek, son revizyonun zaman damgasına erişmemizi sağlar.
Düzenleme isteğimizi yaptığımızda bu zaman damgası basetimestamp olarak kullanılacak.
Ayrıca düzenlememize başladığımız zamanın tam zamanı.
Bu, CSRF isteğine curtimestamp eklenerek de elde edilebilir.
Bu değer starttimestamp olarak hizmet edecektir.
Son olarak, gerçek düzenleme isteğinde, basetimestamp ve starttimestamp parametrelerini ayarlayın, şöyle:
api.php?
Büyük düzenlemeler
Çok miktarda metin içeriği (8000+ karakter) içeren POST istekleri başlığında belirtilen Content-Type: multipart/form-data ile gönderilmelidir.
multipart/form-data HTML çıkış karakterleri eklemesi gerekmediğinden (yani, yüzde kodlama) boşluklar ve noktalama işaretleri için, iletilen veri miktarı daha sonra yüzde kodlanmış eşdeğerinden çok daha küçük olacaktır.
Bununla birlikte, hala multipart/form-data eklenmiş bazı yükler vardır, kabaca parametre başına 160 bayt.
Çok sayıda kaçış karakteri eklemeyi gerektirmeyen kısa mesajlar için bu ek yük miktarı verimsiz olabilir ve yüzde kodlama tercih edilir$ref.[1]
Python örnek kodumuzda, isteğin varsayılan olarak yüzde olarak kodlandığını unutmayın.
İçerik türü ve POST istekleri hakkında daha teknik tartışma için web belgelerine bakın
Python örnek kodumuza benzer bir sözdizimini kullanarak multipart/form-data ile nasıl geçireceğinizi öğrenmek için Python İstekleri belgelerine bakınız.
CAPTCHA'lar
Hedeflediğiniz viki CAPTCHAs kullanıyorsa, isteğiniz bir kimlik numarası ve bir resme soru, matematik sorunu veya URL gibi basit bir test içeren bir hata döndürebilir.
Düzenlemenizi tamamlamak için testi tamamlamanız ve ardından isteğinizi kimlikle ve orijinal sorgu dizesine eklenmiş doğru yanıtlarla yeniden denemeniz gerekir: captchaid=sampleId&captchaword=answer
Diğer CAPTCHA sistemleri ve uzantıları benzer kullanım için farklı parametreler kullanabilir. Genel olarak, kimlik ve test soruları için alan adlarını ikinci isteğinizdeki parametreler olarak kullanın.
Olası hatalar
| Kod | Bilgi |
|---|---|
| notitle | title parametresi ayarlanmalıdır. |
| missingparam | text, appendtext ve undo parametrelerden en az biri gerekli. |
| notoken | token parametresi ayarlanmalıdır. |
| invalidsection | section parametresi geçerli bir bölüm kimliği veya new olmalıdır. |
| protectedpage | Bu sayfa değişiklik ya da diğer eylemlerin yapılmasını engellemek için koruma altına alınmıştır. |
| cantcreate | Yeni sayfalar oluşturmaya yetkiniz yok. |
| cantcreate-anon | Anonim kullanıcılar yeni sayfa oluşturamaz |
| articleexists | Oluşturmaya çalıştığınız madde zaten oluşturuldu. |
| noimageredirect-anon | Anonim kullanıcılar resim yönlendirmeleri oluşturamaz. |
| noimageredirect | Görüntü yönlendirmeleri oluşturma izniniz yok. |
| spamdetected | Düzenlemeniz bir spam parçası içerdiği için reddedildi: Wikitext.
|
| abusefilter-warning | Bu eylem otomatik olarak zararlı olarak tanımlandı. |
| abusefilter-disallowed | Bu eylem otomatik olarak zararlı olarak tanımlanmıştır ve bu nedenle izin verilmemiştir. |
| contenttoobig | Sağladığınız içerik, bytes kibibit ürün boyutu sınırını aşıyor. Where bytes is the value of $wgMaxArticleSize. |
| noedit-anon | Anonim kullanıcılar sayfaları düzenleyemez. |
| noedit | Sayfa değiştirme izniniz yok. |
| pagedeleted | Sayfa, zaman damgasını getirdiğiniz için silindi. |
| emptypage | Yeni, boş bir sayfa oluşturmaya izin verilmez. |
| emptynewsection | Boş yeni bölümler oluşturmak mümkün değildir. |
| editconflict | Değişiklik çakışması. |
| revwrongpage | rrevid, pagename bir düzeltme değildir.undo veya undoafter için geçersiz revizyon kimliği verilirse atılır
|
| undofailure | Değişikliklerin çakışması nedeniyle geri alma işlemi başarısız oldu. |
| missingtitle | Belirttiğiniz sayfa mevcut değil. ( nocreate parametre yukarıya bakın)
|
| mustbeposted | edit modülü bir POST isteği gerektirir. |
| readapidenied | Bu modülü kullanmak için okuma iznine ihtiyacınız var. |
| writeapidenied | Bu vikiyi API aracılığıyla düzenlemenize izin verilmiyor. |
| noapiwrite | Bu vikinin API aracılığıyla düzenlenmesi devre dışı bırakıldı. |
| badtoken | Geçersiz CSRF anahtarı. |
| missingparam | title, pageid parametresi ayarlanmalıdır. |
| invalidparammix | Parametreleri title, pageid birlikte kullanılamaz. |
| invalidtitle | Kötü başlık "title". |
| invalid-content-data | Geçersiz içerik verisi occurs when trying to edit a JSON page with non-conforming data, or while trying to edit a MassMessageListContent page |
| nosuchpageid | pageid kimliğine sahip sayfa yok. |
| pagecannotexist | Ad alanı gerçek sayfalara izin vermez. |
| nosuchrevid | undo kimliğine sahip bir düzeltme yok. |
| nosuchrevid | undoafter kimliğine sahip bir düzeltme yok. |
| badmd5 | Sağlanan MD5 karması yanlış. |
| hookaborted | Yapmaya çalıştığınız değişiklik bir uzantı çengeliyle iptal edildi. |
| parseerror | İçerik serileştirme başarısız oldu: parseerror |
| summaryrequired | ⧼apierror-summaryrequired⧽ |
| blocked | Düzenlemeniz engellendi. |
| ratelimited | Gönderme sınırını aştınız. Lütfen bir süre sonra tekrar deneyin. |
| unknownerror | Bilinmeyen hata: "retval". |
| nosuchsection | Bölüm $1 yok. |
| sectionsnotsupported | Bölümler, içerik modeli $1 için desteklenmiyor. |
| editnotsupported | Bu tür bir sayfanın düzenlenmesi, metin tabanlı düzenleme API'si kullanılarak desteklenmez. |
| appendnotsupported | $1 içerik modelini kullanan sayfalara eklenemez. |
| redirect-appendonly | section=new, prependtext veya prependtext ile birlikte kullanılması gereken yönlendirme takip modunu kullanarak düzenlemeye çalıştınız. |
| edit-invalidredirect | $2 hedefi geçerli olmadığından, yönlendirmeleri izlerken $1 düzenlenemez. |
| badformat | İstenen $1 biçimi, $3 tarafından kullanılan $2 içerik modeli için desteklenmiyor. |
| customcssprotected | Başka bir kullanıcının kişisel ayarlarını içerdiği için bu CSS sayfasını düzenleme izniniz yok. |
| customjsprotected | Başka bir kullanıcının kişisel ayarlarını içerdiği için bu JavaScript sayfasını düzenleme izniniz yok. |
| taggingnotallowed | Değişiklik etiketlerini ayarlama izniniz yok |
| badtags | "Tag" etiketi elle uygulanamaz. Bu etiketler elle uygulanamaz: Tag1, Tag2 |
| tpt-target-page | Bu sayfa elle güncellenemez.
Bu sayfa $1 sayfasının bir çevirisidir ve çeviri, [$2 çeviri aracı] kullanılarak güncellenebilir. |
Parametre geçmişi
- v1.35: Introduced
baserevid - v1.25:
tagstanıtıldı - v1.21:
contentformat,contentmodeltanıtıldı - v1.20:
pageidtanıtıldı - v1.19:
sectiontitletanıtıldı - v1.18:
captchaid,captchawordkullanımdan kaldırıldı - v1.17:
redirecttanıtıldı - v1.16:
watch,unwatchkullanımdan kaldırıldı - v1.16:
watchlisttanıtıldı - v1.15:
undo,undoaftertanıtıldı - v1.14:
starttimestamptanıtıldı
Ek notlar
- Oturum açma API tarafından kesinlikle gerekli değildir, ancak düzenlemenin yazarına doğru bir şekilde atfedilmesi gerekir. Oturum açmamış bir kullanıcının başarılı bir düzenlemesi IP adresleriyle ilişkilendirilir.
- Oturum açmayan botlar, düzenleme ve diğer yazma taleplerinde kısıtlamalarla karşılaşabilir; daha fazla ayrıntı için Manual:Bot oluşturma#Oturum açma sayfasına bakın.
- Oturum açmayan kullanıcılara her zaman boş CSRF anahtarıverilir,
+\. - Bir anahtar isteme süreci çeşitli sürümlerde değişti. Daha fazla bilgi için API:Tokens sayfasına bakın.
- ResourceLoader, bir viki sayfasında kod çalıştırırken düzenleme anahtarlarına erişmenin bir yolunu sunar.
- Tek bir oturum açma oturumu sırasında, aynı viki üzerindeki tüm düzenleme işlemleri için aynı CSRF anahtarı kullanabilirsiniz.
- Sorgu dizesinin sonunda veya en azından text parametresinden sonra isteğinizde herhangi bir anahtarı iletmek iyi bir uygulamadır. Bu şekilde, bağlantı kesilirse jeton iletilmez ve düzenleme başarısız olur. İstek yapmak için mw.Api nesnesini kullanıyorsanız, bu otomatik olarak yapılır.
captchaidvecaptchawordteknik olarak API:Edit v1.18'den beri kaldırılmış olsa da, Extension:ConfirmEdit API:Edit'i CAPTCHA'larla çalışacak şekilde genişletir. Böylece, ConfirmEdit kurulu olduğunda, bu parametreler hala kullanılabilir. ConfirmEdit, MediaWiki yazılımı v1.18 + ile birlikte gelir.
Ayrıca bakınız
- Help:Düzenleme - maddeleri düzenlemeyle ilgili faydalı bağlantılar içeriyor.
- Manual:Bot passwords - vikilere GUI yerine bir komut dosyası veya uygulama aracılığıyla erişirken basitleştirilmiş bir arabirim kullanarak nasıl oturum açılacağını açıklar.
- Manual:Creating a bot - sayfaları otomatik olarak düzenlemek için bot kullanma hakkında daha fazla ayrıntı.
- ResourceLoader - bir MediaWiki sayfasında JavaScript çalıştırırken düzenleme anahtarına erişmenin bir yolunu sunar.
- API:Tokens - oturum açmak veya POST istekleri yapmak için anahtarları kullanma hakkında daha fazla ayrıntıya sahiptir.
- API:Tokens (eylem) - MediaWiki'nin önceki sürümlerinde anahtar istemek için API:Tokens üzerinden farklı, kullanımdan kaldırılmış bir API.
- API:Compare - bir sayfadaki düzenlemeler arasında değişiklik yapmanızı sağlar.
- API:Managetags - bir sayfadaki etiketleri değiştirir.
- API:Rollback - bir dizi düzenlemeyi geri alır.
- API:Filerevert - dosyaları daha önceki bir duruma geri alır.
- API:Revisiondelete - bir sayfadaki revizyonları siler ve geri yükler.