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
- Kaynak: MediaWiki
- Lisans: GPL-2.0-or-later
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.
Deneme: API isteklerini test etme kolaylıÄı için, Special:ApiSandbox sayfasına bakın.
- 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
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.
- 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-maxageHTTP önbellek kontrolü üstbilgisini bu kadar saniye olarak ayarlayın. Hatalar asla önbelleÄe alınmaz.- Tür: tamsayı
- Varsayılan: 0
- maxage
max-ageHTTP ö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
OriginbaÅ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 parametreOriginüstbilgisiyle eÅleÅmezse, 403 yanıtı döndürülür. Bu parametreOriginüstbilgisiyle eÅleÅiyorsa ve orijin izin verilirse,Access-Control-Allow-OriginveAccess-Control-Allow-CredentialsbaÅlıklar ayarlanacaktır.KimliÄi doÄrulanmamıŠistekler için * deÄerini belirtin. Bu,
Access-Control-Allow-Originüstbilgisinin ayarlanmasına neden olur, ancakAccess-Control-Allow-Credentials,falseve 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)
- 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]
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.