MediaWiki API yardımı

Bu otomatik olarak oluşturulan bir MediaWiki API belgelenme sayfasıdır.

Belgeler ve örnekler: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Ana modül

Durum: MediaWiki API, aktif olarak desteklenen ve geliştirilen olgun ve kararlı bir arayüzdür. Bundan kaçınmaya çalışırken, zaman zaman kırılma değişiklikleri yapmamız gerekebilir; güncellemeleri bildirmek için posta listesine abone olun.

Hatalı istekler: API'ya hatalı istekler gönderildiğinde, "MediaWiki-API-Error" anahtarını içeren bir HTTP başlığı gönderilir ve daha sonra hem başlığın değeri hem de geri gönderilen hata kodu olarak ayarlanır. aynı değer. Daha fazla bilgi için API:Hatalar ve uyarılar sayfasına bakın.

Parametre:
action

Eylemin gerçekleştirileceği.

advancedmeta-tasks
AdvancedMeta için silme ve düzenleme gibi işlemler sağlar
block
Bir kullanıcıyı engelleyin.
changeauthenticationdata
Geçerli kullanıcı için kimlik doğrulama verilerini değiştirin.
changecontentmodel
Sayfanın içerik modelini değiştirin
checktoken
action=query&meta=tokens üzerinden bir simgenin geçerliliğini kontrol edin.
clearhasmsg
Geçerli kullanıcı için hasmsg işaretini temizler.
clientlogin
Etkileşimli akışı kullanarak viki oturumu açın.
compare
İki sayfa arasındaki farkı elde edin.
createaccount
Yeni bir kullanıcı hesabı oluşturun.
delete
Sayfayı silin.
edit
Sayfa oluşturun ve düzenleyin.
emailuser
Bir kullanıcıya e-posta gönderin.
expandtemplates
Vikimetin içindeki tüm şablonları genişletir.
feedcontributions
Bir kullanıcının katkı yayını döndürür.
feedrecentchanges
Son yapılan değişiklikler özet akışını döndürür.
feedwatchlist
Bir izleme listesi beslemesini döndürür.
filerevert
Bir dosyayı eski bir revizyona geri döndürün.
help
Belirtilen modüller için yardımı görüntüleyin.
imagerotate
Bir veya daha fazla görüntüyü döndürün.
import
Bir sayfayı başka bir vikiden veya bir XML dosyasından içe aktarın.
linkaccount
Bir üçüncü taraf sağlayıcıdan bir hesabı geçerli kullanıcıya bağlayın.
login
Oturum açın ve kimlik doğrulama çerezlerini alın.
logout
Oturumu kapatın ve oturum verilerini temizleyin.
managetags
Değişiklik etiketleriyle ilgili yönetim görevlerini gerçekleştirin.
mergehistory
Sayfa geçmişlerini birleştirin.
move
Bir sayfayı taşı.
opensearch
OpenSearch protokolünü kullanarak vikide arama yapın.
options
Geçerli kullanıcının tercihlerini değiştirin.
paraminfo
API modülleri hakkında bilgi edinin.
parse
İçeriği ayrıştırır ve ayrıştırıcı çıkışını döndürür.
patrol
Bir sayfa veya revizyon devriye edin.
protect
Sayfanın koruma seviyesini değiştirin.
purge
Verilen başlıklar için önbelleği temizleyin.
query
MediaWiki'den ve MediaWiki hakkında veri getirin.
removeauthenticationdata
Geçerli kullanıcı için kimlik doğrulama verilerini kaldırın.
resetpassword
Bir kullanıcıya parola sıfırlama e-postası gönderin.
revisiondelete
Revizyonları silin ve geri alın.
rollback
Sayfadaki son düzenlemeyi geri alın.
rsd
Bir RSD (Gerçekten Basit Keşif) şemasını dışa aktarın.
setnotificationtimestamp
İzlenen sayfalar için bildirim zaman damgasını güncelleyin.
setpagelanguage
Sayfanın dilini değiştirin.
spamblacklist
SpamBlacklist'e karşı bir veya daha fazla URL doğrulayın.
tag
Tek tek düzeltmelere veya günlük girişlerine değişiklik etiketleri ekleyin veya kaldırın.
templatedata
TemplateData uzantısı tarafından depolanan verileri alın.
titleblacklist
TitleBlacklist ile bir sayfa başlığını, dosya adını veya kullanıcı adını doğrulayın.
unblock
Bir kullanıcının engellemesini kaldırın.
undelete
Silinen bir sayfanın düzeltmelerini geri yükleyin.
unlinkaccount
Bağlı bir üçüncü taraf hesabını geçerli kullanıcıdan kaldırın.
upload
Bir dosya yükleyin veya bekleyen yüklemelerin durumunu öğrenin.
userrights
Bir kullanıcının grup üyeliğini değiştirin.
validatepassword
Vikinin parola politikalarına göre bir parola doğrulayın.
watch
Geçerli kullanıcının izleme listesine sayfalar ekleyin veya listeden sayfa kaldırın.
webapp-manifest
Bir web uygulaması bildirimi döndürür.
mobileview
Kaldırıldı. Mobil görünümler için gerekli verileri döndürür.
categorytree
Dahili. CategoryTree uzantısı için iç modül.
cspreport
Dahili. Tarayıcılar tarafından İçerik Güvenliği İlkesi ihlallerini bildirmek için kullanılır. Bu modül, CSP uyumlu bir web tarayıcısı tarafından otomatik olarak kullanıldığı durumlar dışında asla kullanılmamalıdır.
stashedit
Dahili. Paylaşılan önbellekte bir düzenleme hazırlayın.
Aşağıdaki değerlerden biri: advancedmeta-tasks, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, spamblacklist, tag, templatedata, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, mobileview, categorytree, cspreport, stashedit
Varsayılan: help
format

Çıkışının biçimi.

json
JSON formatında veri çıkışı.
jsonfm
Verileri JSON biçiminde çıktılar (HTML'de güzel baskı).
none
Çıkış yok.
php
Serileştirilmiş PHP biçimde veri çıkışı.
phpfm
Serileştirilmiş PHP biçiminde veri çıkışı (HTML'de güzel baskı).
rawfm
Hata ayıklama öğeleri dahil çıktı verileri, JSON biçiminde (HTML'de güzel yazdırılır).
xml
XML formatında veri çıkışı.
xmlfm
XML biçiminde çıkış (HTML'de güzel baskı).
Aşağıdaki değerlerden biri: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Varsayılan: jsonfm
maxlag

Maksimum gecikme, MediaWiki veritabanı çoğaltılmış bir kümeye yüklendiğinde kullanılabilir. Daha fazla site çoğaltma gecikmesine neden olan eylemleri kaydetmek için, bu parametre istemcinin çoğaltma gecikmesi belirtilen değerden daha az olana kadar beklemesini sağlayabilir. Aşırı gecikme durumunda, maxlag hata kodu, $host bekleniyor: $lag saniye geçikli gibi bir mesajla birlikte döndürülür.
Daha fazla bilgi için Manual:Maxlag parametresi sayfasına bakınız.

Tür: tamsayı
smaxage

s-maxage HTTP önbellek kontrolü üstbilgisini bu kadar saniye olarak ayarlayın. Hatalar asla önbelleğe alınmaz.

Tür: tamsayı
Varsayılan: 0
maxage

max-age HTTP önbellek kontrolü üstbilgisini bu kadar saniye olarak ayarlayın. Hatalar asla önbelleğe alınmaz.

Tür: tamsayı
Varsayılan: 0
assert

Kullanıcının user olarak ayarlanmışsa, anon olarak ayarlanmışsa oturum açmamış olduğunu veya bot ise bot kullanıcı hakkına sahip olduğunu doğrulayın.

Aşağıdaki değerlerden biri: anon, bot, user
assertuser

Geçerli kullanıcının adlandırılmış kullanıcı olduğunu doğrulayın.

Şunu yazın: kullanıcı, herhangi biri kullanıcı adı
requestid

Burada verilen herhangi bir değer yanıta dahil edilecektir. İstekleri ayırt etmek için kullanılabilir.

servedby

İsteği sunan ana bilgisayar adını sonuçlara ekleyin.

Tür: boole (ayrıntılar)
curtimestamp

Geçerli zaman damgasını sonuca dahil et.

Tür: boole (ayrıntılar)
responselanginfo

Sonuçta uselang ve errorlang için kullanılan dilleri ekleyin.

Tür: boole (ayrıntılar)
origin

Etki alanları arası AJAX isteği (CORS) kullanarak API'ye erişirken bunu kaynak etki alanına ayarlayın. Bu, uçuş öncesi tüm taleplere dahil edilmeli ve bu nedenle istek URI'sinin bir parçası olmalıdır (POST kuruluşu değil).

Kimliği doğrulanmış istekler için, bunun Origin başlığındaki orijinlerden biriyle tam olarak eşleşmesi gerekir, bu nedenle https://en.wikipedia.org gibi https://meta.wikimedia.org bir şeye ayarlanması gerekir. Bu parametre Origin üstbilgisiyle eşleşmezse, 403 yanıtı döndürülür. Bu parametre Origin üstbilgisiyle eşleşiyorsa ve orijin izin verilirse, Access-Control-Allow-Origin ve Access-Control-Allow-Credentials başlıklar ayarlanacaktır.

Kimliği doğrulanmamış istekler için * değerini belirtin. Bu, Access-Control-Allow-Origin üstbilgisinin ayarlanmasına neden olur, ancak Access-Control-Allow-Credentials, false ve tümü kullanıcıya özgü veriler kısıtlanacaktır.

uselang

Mesaj çevirileri için kullanılacak dil. action=query&meta=siteinfo ile siprop=languages bir dil kodu listesi döndürür veya user Mevcut kullanıcının dil tercihini kullanmak için bu vikinin içerik dilini kullanmak için content belirtin.

Varsayılan: user
variant

Dilin varyantı. Yalnızca temel dil, değişken dönüştürmeyi destekliyorsa çalışır.

errorformat

Uyarı ve hata metni çıkışı için kullanılacak biçim

plaintext
HTML etiketlerinin kaldırıldığı ve varlıkların değiştirildiği vikimetin.
wikitext
Ayrıştırılmamış vikimetin.
html
HTML
raw
Mesaj anahtarı ve parametreleri.
none
Metin çıkışı yok, yalnızca hata kodları.
bc
MediaWiki 1.29'dan önce kullanılan biçim. errorlang ve errorsuselocal yoksayılır.
Aşağıdaki değerlerden biri: bc, html, none, plaintext, raw, wikitext
Varsayılan: bc
errorlang

Uyarılar ve hatalar için kullanılacak dil. action=query&meta=siteinfo ile siprop=languages veya content bir dil kodu listesi döndürür. Bu vikinin içerik dilini kullanmak için uselang parametresiyle aynı değeri kullanmak için uselang değerini belirtin.

Varsayılan: uselang
errorsuselocal

Verilirse, hata metinleri MediaWiki ad alanından yerel olarak özelleştirilmiş iletiler kullanır.

Tür: boole (ayrıntılar)
Örnekler:
Ana modül için yardım.
api.php?action=help [sandbox'ta açın]
Hepsi tek bir sayfada yardım.
api.php?action=help&recursivesubmodules=1 [sandbox'ta açın]
İzin:
writeapi
Yazma API'sini kullan
Kabul edildi: all, user ve bot
apihighlimits
API sorgularında daha yüksek sınırlar kullanın (yavaş sorgular: 500; hızlı sorgular: 5000). Yavaş sorgulama sınırları çok değerli parametreler için de geçerlidir.
Kabul edildi: bot ve sysop

Veri türleri

MediaWiki'ye giriş, NFC normalleştirilmiş UTF-8 olmalıdır. MediaWiki diğer girdileri dönüştürmeye çalışabilir, ancak bu MD5 denetimleriyle bazı işlemlerin (düzenlemeler gibi) başarısız olmasına neden olabilir.

Birden çok değer alan parametreler normalde dikey çizgi karakteri kullanılarak ayrılmış değerlerle gönderilir; param=value1|value2 veya param=value1%7value2. Bir değerin boru karakterini içermesi gerekiyorsa, ve ayırıcısı olarak U+001F (Birim Ayırıcı) kullanın. ör. param=%1Fvalue1%1Fvalue2.

API isteklerindeki bazı parametre türlerinin daha fazla açıklanması gerekir:

boolean

Boole parametreleri HTML onay kutuları gibi çalışır: parametre belirtilirse, değerine bakılmaksızın doğru kabul edilir. Yanlış bir değer için parametreyi tamamen atlayın.

expiry

Vade sonu değerleri göreceli (ör. 5 months veya 2 weeks) veya kesin (ör. 2014-09-18T12:34:56Z). Bitişi olmayan için, infinite, indefinite, infinity veya never kullanın.

timestamp

Zaman damgaları birkaç biçimde belirtilebilir; ayrıntılar için mediawiki.org'da belgelenen Zaman Damgası kütüphane giriş biçimlerine bakın. ISO 8601 tarih ve saat önerilir: 2001-01-15T14:56:00Z. Ayrıca, geçerli zaman damgasını belirtmek için now dizesi kullanılabilir.

Şablonlu parametreleri

Geçici parametreler, bir API modülünün başka bir parametrenin her değeri için bir değere ihtiyaç duyduğu durumları destekler. Örneğin, meyve istemek için bir API modülü varsa, hangi meyvelerin talep edildiğini belirtmek için fruits parametresine ve {fruit}-quantity her meyveden kaç tane talep edileceğini belirtin. Daha sonra 1 elma, 5 muz ve 20 çilek isteyen bir API istemcisi fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20 gibi bir istekte bulunabilir.

Katkıda bulunanlar

API geliştiricileri:

  • Yuri Astrakhan (yaratıcı, baş geliştirici Eylül 2006 – Eylül 2007)
  • Roan Kattouw (öncü geliştirici Eylül 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (öncü geliştirici 2013 – günümüz)

Lütfen yorumlarınızı, önerilerinizi ve sorularınızı [email protected] adresine gönderin. veya https://phabricator.wikimedia.org/ adresinde bir hata raporu sunun.