MediaWiki API yardımı
Bu, otomatik olarak oluşturulmuş bir MediaWiki API belgeler sayfasıdır.
Genel bilgiler
Status: The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to the mediawiki-api-announce mailing list for notice of updates.
Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings.
Testing: For ease of testing API requests, see Special:ApiSandbox.
İstek yöntemleri
Eylem API istekleri GET ve POST yöntemlerini kullanabilir. GET yöntemini tercih edin; bu, isteklerin önbelleğe alınmasına olanak tanır.
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 olabilir (ö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ı çeşitli biçimlerde belirtilebilir, ayrıntılar için Zaman damgası kütüphanesi giriş biçimlerine bakın.
Sınırlar
Çoğu API modülü, çok değerli parametrelerde en fazla 50 inputs kabul edebilir ve sorgu başına en fazla 500 results (yavaş sorgular için 50 results) döndürebilir.
apihighlimits hakkına sahip kullanıcılar için ( Botlar ve Hizmetliler ), limitler 500 inputs ve 5.000 results (yavaş sorgular için 500 results) olarak artırılır.
Ş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.
Ana modül
- Kaynak: MediaWiki
- Lisans: GPL-2.0-or-later
Specify the action to perform, the format of the response, and options that apply to all API modules.
- action
Hangi işlemin gerçekleştirileceği. Bu parametre, hata ayıklama, analiz ve istek yönlendirme veya filtreleme kolaylığı için istek URL'sinin bir parçası olarak (POST gövdesinde değil) gönderilmelidir.
- acquiretempusername
- Geçici bir kullanıcı kullanıcı adı edinin ve geçici hesap oluşturma etkinleştirilmişse ve geçerli kullanıcı oturumdan çıkarılmışsa, geçerli oturumda saklayın. Bir ad zaten saklanmışsa, aynı adı döndürür.
- 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
hasmsgiş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.
- languagesearch
- Herhangi bir betikte dil isimlerini arayı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.
- tag
- Tek tek düzeltmelere veya günlük girişlerine değişiklik etiketleri ekleyin veya kaldırın.
- unblock
- Bir kullanıcının engellemesini kaldırın.
- undelete
- Silinen bir sayfanın silinmiş revizyonlarını geri getirin.
- 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.
- wbavailablebadges
- Kullanılabilir rozet ögelerini sorgular.
- wbcreateclaim
- Wikibase talebi oluşturur.
- wbcreateredirect
- Varlık yönlendirmesi oluşturur.
- wbeditentity
- Tek bir yeni Wikibase varlığı oluşturur ve seri hale getirilmiş bilgilerle değiştirir.
- wbformatentities
- Varlık kimliklerini HTML veya düz metne biçimlendirir.
- wbformatvalue
- DataValues biçimlendirir.
- wbgetclaims
- Wikibase taleplerini alır.
- wbgetentities
- Birden çok Wikibase varlığı için veri alır.
- wblinktitles
- İki farklı vikideki iki sayfayı bir Wikibase öğesiyle ilişkilendirir.
- wbmergeitems
- Birden çok öğeyi birleştirir.
- wbparsevalue
- Değerleri bir
ValueParserkullanarak ayrıştırır. - wbremoveclaims
- Wikibase hak taleplerini kaldırır.
- wbremovequalifiers
- Bir talepteki niteleyiciyi kaldırır.
- wbremovereferences
- Aynı ifadeye ait bir veya daha fazla referansı kaldırır.
- wbsearchentities
- Etiketleri ve takma adları kullanan varlıkları arar.
- wbsetaliases
- Bir Wikibase varlığı için diğer adları ayarlar.
- wbsetclaim
- Bir Bildirimin veya Talebin tamamını oluşturur veya günceller.
- wbsetclaimvalue
- Ayarlar Wikibase bir iddia değerini.
- wbsetdescription
- Ayarlar tek Wikibase bir varlık için bir açıklama.
- wbsetlabel
- Tek bir Wikibase varlığı için bir etiket ayarlar.
- wbsetqualifier
- Bir niteleyici oluşturur veya mevcut bir değerin değerini ayarlar.
- wbsetreference
- Bir referans oluşturur veya mevcut bir referansın değerini ayarlar.
- wbsetsitelink
- Vikideki bir sayfayı bir Wikibase öğesiyle ilişkilendirir veya önceden oluşturulmuş bir ilişkilendirmeyi kaldırır.
- webapp-manifest
- Bir web uygulaması bildirimi döndürür.
- 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.
- editcheckreferenceurl
- Dahili. Check the status of a URL for use as a reference.
- scribunto-console
- Dahili. Scribunto konsolundan XHR taleplerine hizmet vermek için dahili modül.
- stashedit
- Dahili. Paylaşılan önbellekte bir düzenleme hazırlayın.
- visualeditor
- Dahili. Parsoid hizmetinden bir sayfa için HTML5 değerini döndürür.
- visualeditoredit
- Dahili. Bir HTML5 sayfasını MediaWiki'ye (Parsoid hizmeti aracılığıyla vikimetine dönüştürülür) kaydedin.
- Aşağıdaki değerlerden biri: acquiretempusername, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, languagesearch, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, wbavailablebadges, wbcreateclaim, wbcreateredirect, wbeditentity, wbformatentities, wbformatvalue, wbgetclaims, wbgetentities, wblinktitles, wbmergeitems, wbparsevalue, wbremoveclaims, wbremovequalifiers, wbremovereferences, wbsearchentities, wbsetaliases, wbsetclaim, wbsetclaimvalue, wbsetdescription, wbsetlabel, wbsetqualifier, wbsetreference, wbsetsitelink, webapp-manifest, cspreport, editcheckreferenceurl, scribunto-console, stashedit, visualeditor, visualeditoredit
- Varsayılan: help
- format
Çıkışının biçimi.
- Aşağıdaki değerlerden biri: json, jsonfm, none, 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-maxageHTTP önbellek kontrolü üstbilgisini bu kadar saniye olarak ayarlayın. Hatalar asla önbelleğe alınmaz.- Tür: tamsayı
- Değer, 0 daha az olmamalıdır.
- Varsayılan: 0
- maxage
max-ageHTTP önbellek kontrolü üstbilgisini bu kadar saniye olarak ayarlayın. Hatalar asla önbelleğe alınmaz.- Tür: tamsayı
- Değer, 0 daha az olmamalıdır.
- Varsayılan: 0
- assert
user olarak ayarlanmışsa kullanıcının oturum açtığını (geçici kullanıcı dahil), anon olarak ayarlanmışsa oturum açmadığını veya bot olarak ayarlanmışsa 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ı ve Geçici kullanıcı
- 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
Alanlar arası AJAX isteği (CORS) kullanarak API'ye erişirken, bunu kaynak alan adına ayarlayın. Bu, herhangi bir ön kontrol isteğine dahil edilmelidir ve bu nedenle istek URL'sinin bir parçası olmalıdır (POST gövdesi değil).
Kimliği doğrulanmış istekler için, bu,
Originbaşlığındaki kaynaklardan biriyle tam olarak eşleşmelidir, bu nedenle https://en.wikipedia.org veya https://meta.wikimedia.org gibi bir şeye ayarlanmalıdır. Bu parametreOriginbaşlığıyla eşleşmezse, 403 yanıtı döndürülür. Bu parametreOriginbaşlığıyla eşleşirse ve kaynak izin verilirse,Access-Control-Allow-OriginveAccess-Control-Allow-Credentialsbaşlıkları ayarlanır.Kimliği doğrulanmamış istekler için * değerini belirtin. Bu
Access-Control-Allow-Originbaşlığının ayarlanmasına neden olur, ancakAccess-Control-Allow-Credentialsfalseolur ve tüm kullanıcıya özgü veriler kısıtlanır.- crossorigin
Alanlar arası AJAX isteği (CORS) kullanarak API'ye erişirken ve siteler arası istek sahteciliği (CSRF) saldırılarına karşı güvenli bir oturum sağlayıcısı (OAuth gibi) kullanırken, isteğin kimlik doğrulamalı (yani oturum kapatılmamış) olması için
origin=*yerine bunu kullanın. Bu, herhangi bir ön kontrol isteğine dahil edilmeli ve bu nedenle istek URL'sinin bir parçası olmalıdır (POST gövdesinin değil).Çoğu oturum sağlayıcısının, standart çerez tabanlı oturumlar da dahil olmak üzere, kimlik doğrulamalı CORS'u desteklemediğini ve bu parametreyle kullanılamayacağını unutmayın.
- Tür: boole (ayrıntılar)
- 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)
- 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&toc [sandbox'ta açın]
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–2020)
Lütfen yorumlarınızı, önerilerinizi ve sorularınızı mediawiki-api@lists.wikimedia.org adresine gönderin. veya https://phabricator.wikimedia.org/ adresinde bir hata raporu sunun.