MediaWiki API гӀо

ХӀара авто кхоьллина агӀо йу MediaWiki API документацин.

Документаци а, масалш а: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Коьрта модуль

Статус: MediaWiki API — кхиъна а, стабилан а интерфейс, жигара тайеш йолу. Тхо хьожу доьхна хийцамаш цахилийта, делахь наггахь уьш хила мега. ДӀадазло поштан дӀасакхехьийтарш тӀе mediawiki-api-announce, карладахарш хаархьама.

ГӀалатан дехарш: API гӀалат долу дехар хилахь, HTTP корта гучубаьра бу «MediaWiki-API-Error» догӀанца, цул тӀаьхьа кортан маьӀна а, гӀалатан код а йухадӀайахьитина дӀахӀоттор йу, оцу маьӀна тӀе. Мадарра. API: ГӀалаташ а, дӀахьедарш а.

Билгалйаьккхина параметр:
action

Кхочушдан дезарг.

acquiretempusername
Цхьана ханна лелоран цӀе схьа а эций, иза карарчу сеансехь Ӏалашйе, нагахь санна ханна лерина аккаунт кхоллар дӀахӀоттийна делахь, карарчу хенахь декъашхо системин чуьра араваьлла велахь. Нагахь санна цӀе хӀинцале а Ӏалашйина йелахь, изза цӀе йухайерзайо.
block
Декъашхочун блоктохар.
changeauthenticationdata
Карарчу декъашхочунна аутентификацин параметраш хийцар.
changecontentmodel
АгӀонан контентан модель хийца
checktoken
Токенан бакъ хилар толлу action=query&meta=token чуьра.
clearhasmsg
Карарчу хенахь декъашхочунна hasmsg байракх дӀайаккха.
clientlogin
Интерактиван дӀахӀоттаман гӀоьнца вики тӀехь авторизаци йе.
compare
Шина агӀонна йукъахь йолу башхалла схьаэцар.
createaccount
Керла аккаунт кхоллар.
delete
ДӀайаккха агӀо.
edit
АгӀонаш кхоллар а, тайар а.
emailuser
Декъашхочунга кехат
expandtemplates
Массо а кепаш вики-текстехь йаржор.
feedcontributions
Декъашхойн къинхьегам болу лента йухайерзайо.
feedrecentchanges
ТӀаьххьара хийцамийн лента йухайерзайо.
feedwatchlist
Тергаме могӀаман лента йухайерзайо.
filerevert
Файл ширачу верси тӀе йухайерзор.
help
Билгалйаьхначу модулашна гӀо дар гойту.
imagerotate
Цхьаъ йа масех сурт дерзор.
import
Кхечу вики йа XML-файлан агӀо импорт йе.
linkaccount
КхоалгӀачу агӀонан аккаунт карарчу хенахь йолчу декъашхочуьнца уьйр латтайе.
login
Авторизаци а, аутентификацин cookies схьаэца а.
logout
ЧугӀой сессийн хаамаш дӀацӀанбе.
managetags
Билгалонаш хийцарца доьзна гӀуллакхаш кхочушдар.
mergehistory
Нисдарийн истори цхьаьнатохар.
move
АгӀонан цӀе хийца.
opensearch
Викеш тӀехь леха OpenSearch протоколца.
options
Карарчу декъашхочунна лерина нисдаран гӀирсаш хийца.
paraminfo
API модулех лаьцна информаци схьаэцар.
parse
Чулацаман парсинг йеш, парсинган жамӀ йухадерзадо.
patrol
АгӀо йа верси таллар.
protect
АгӀо ларйаран тегӀа хийцар.
purge
Билгалйиначу агӀонийн кэш дӀацӀанйар.
query
MediaWiki чуьра а, цунах лаьцна а хаамаш схьаэца.
removeauthenticationdata
Карарчу декъашхочунна аутентификацин хаамаш дӀабахар.
resetpassword
Декъашхочунна е-мейл дӀайахьийта, пароль меттахӀотто.
revisiondelete
ДӀайахар / меттахӀотайар агӀонийн версеш.
rollback
АгӀонан тӀехь тӀаьххьара хийцамаш йухабаха.
rsd
RSD схемин экспорт (Really Simple Discovery).
setnotificationtimestamp
Тергамехь йолу йолчу агӀонашна хаамийн хенан билгало карлайаккхар.
setpagelanguage
АгӀонан мотт хийца.
tag
Билгалонаш тӀетохар йа дӀайахар цхьадолу нисдаршкахь а, журналийн дӀайаздаршкахь а
unblock
Декъашхочун тӀера блокдӀайакхар
undelete
ДӀайаьккхинчу агӀонан версеш меттахӀиттор.
unlinkaccount
Карарчу декъашхочуьнца йоьзна йолу йистера аккаунт дӀайаккхар.
upload
Файл чуйаккхар йа чуйаккхаран статус схьаэцар.
userrights
Декъашхочун тобанаш хийцар.
validatepassword
Пароль толлуш, иза викин политикаца йогӀуш йуйла.
watch
Карарчу декъапшхочун тергаме могӀаман тӀера агӀонаш тӀетохар йа дӀайахар.
cspreport
Чоьхьара. Браузерша лелайо кхерамазаллин политика (CSP) йохош хиларх лаьцна хаам бан. ХӀара модуль цкъа а лело ца йеза, CSP-ца йогӀуш йолчу браузерша авто лелош йоцург.
stashedit
Чоьхьара. Йукъарчу кэшехь хийцамаш кечбар.
РогӀерчу маьӀнех цхьаъ: acquiretempusername, 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, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, stashedit
Ӏадйитаран кеп: help
format

Гойту формат.

json
Арабоху хаамаш JSON форматехь.
jsonfm
JSON форматехь арахеца хаамаш (HTML форматехь).
none
ХӀума ара ма даккха.
php
Арахецна хаамаш сериализаци йинчу PHP форматехь.
phpfm
Арахеца хаамаш сериализаци йинчу PHP форматехь (HTML формат йинчу).
rawfm
Арахецна хаамаш, шайна йукъахь отладкин элементаш а йолуш, JSON форматехь (HTML формат йинчу).
xml
Арабоху хаамаш XML форматехь.
xmlfm
XML форматехь арахеца хаамаш (HTML форматехь).
РогӀерчу маьӀнех цхьаъ: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Ӏадйитаран кеп: jsonfm
maxlag

Максималан маьӀна лело мегар ду MediaWiki базехь репликацин кластер тӀехь дӀахӀоттийча. Сайтан репликацин маьӀна кхуллуш долу гӀуллакхаш кӀелхьардаха, оцу параметро клиентана репликацин маьӀна билгалдаьккхинчу махал кӀезиг хилчахьана собар дан йиш йу. ТӀех сов маьӀна хилча, гӀалатан код «maxlag» хаамца «Waiting for $host: $lag seconds lagged» санна хаамца.
Хьажа Manual: Maxlag параметран.

Тайпа: дийнатерахьан маьӀна
smaxage

Cache-Control-ан HTTP корта s-maxage билгалдаьккхинчу секундийн терахьца дӀахӀоттабе. ГӀалаташ цкъа а кэш йеш йац.

Тайпа: дийнатерахьан маьӀна
МаьӀна 0 доца хила ца деза.
Ӏадйитаран кеп: 0
maxage

Cache-Control-ан HTTP корта max-age билгалдаьккхинчу секундийн терахьца дӀахӀоттабе. ГӀалаташ цкъа а кэш йеш йац.

Тайпа: дийнатерахьан маьӀна
МаьӀна 0 доца хила ца деза.
Ӏадйитаран кеп: 0
assert

Таллам бе декъашхочо авторизаци йина хилар (цу йукъахь хила тарло ханна декъашхо санна) нагахь санна user хӀоттийна делахь, not авторизаци йина хилар нагахь санна anon хӀоттийна делахь, йа ботан декъашхочун бакъо йу нагахь санна bot хилча.

РогӀерчу маьӀнех цхьаъ: anon, bot, user
assertuser

Карара декъашхочун ник билгалйаьккхинчуьнца йогӀуш йуй хьовса.

Тайпа: декъахо, муьлххачура Декъашхочун цӀе, Ханна декъашхо
requestid

Кхузахь луш болу муьлхха а маьӀна жоьпана йукъабоккхур бу. Дехарш къастош лело мегар ду.

servedby

Дехар дӀадаьхьначу серверан цӀе йукъайаккха жамӀашна йукъа.

Тайпа: булин (мадарра)
curtimestamp

Хилламийн йукъатоха ханна йолу билгало

Тайпа: булин (мадарра)
responselanginfo

uselang а, errorlang а лелош долу меттанаш жамӀехь йукъадаха.

Тайпа: булин (мадарра)
origin

API-на тӀекхаьчча, доменашна йукъара AJAX дехарца (CORS), параметр дӀахӀоттайе хьалхара домене. И параметр йукъайаккха йеза муьлхха а хьалха-рейс дехарехь, цундела хила деза дехаран-URI дакъа (POST дегӀ дац).

Аутентификаци йинчу дехаршна иза нийса догӀуш хила деза цхьана схьадовларца Origin корта тӀехь, цундела иза хӀотто деза https://ce.wikipedia.org йа https://meta.wikimedia.org санна. Нагахь санна параметр Origin кортаца нийса ца хилахь, 403 жоп лур ду. Нагахь санна параметр нийса йелахь Origin кортаца, ткъа схьадалар бакъо йелахь, Access-Control-Allow-Origin а, Access-Control-Allow-Credentials а кортош хӀиттор ду.

Таллам боцучу дехаршна билгалдаккха *. Оцу гӀуллакхо дӀахӀоттор ду Access-Control-Allow-Origin корта, амма дӀахӀоттор ду Access-Control-Allow-Credentials false дӀахӀоттор ду, массо а лелоран хаамашна дозанаш хӀиттор ду.

crossorigin

API-на тӀекхаьчча, кросс-доменан AJAX дехаран (CORS) а, сеансаш лелош а, иза кхераме йац кросс-сайтийн дехарш харцдарна (CSRF) тӀелетаршна дуьхьал (масала, OAuth), леладе хӀара origin=* меттана, дехар бакъдан (и.е., logged ца хилийта). Иза йукъадаккха деза муьлхха а дехар дале хьалха динчу дехарехь, цундела хила деза дехаран URI дакъа (POST дегӀ дац).

Тидам бе, дукхах йолу сеансийн провайдерш, шайна йукъахь стандартан cookie-н бух тӀехь йолу сеансаш а йолуш, гӀо ца до аутентификаци йина CORS-на, лело йиш йац оцу параметрца.

Тайпа: булин (мадарра)
uselang

Хаамаш гочбеш лелош болу мотт. action=query&meta=siteinfo&siprop=languages дехаро йухаберзабо меттанийн кодийн могӀам. Ахь билгалдаккха мегар ду user декъашхочун карарчу хенахь меттан нисдаран гӀирс лело, йа content хӀокху викин коьрта мотт лело.

Ӏадйитаран кеп: user
variant

Меттан вариант. Нагахь санна базан матто вариант хийцар ловш хилча бен болх ца бо.

errorformat

ДӀахьедарш а, гӀалаташ а гучудоккху формат

plaintext
ДӀайаьккхина HTML-билгалонашца а, хийцина энтитеш а Вики-текст.
wikitext
Парсийина йоцу вики-текст.
html
HTML
raw
Хааман догӀа а, параметраш а.
none
Текст ца гойту, гӀалатийн кодаш бен.
bc
MediaWiki 1.29 хьалха лелийна формат. errorlang а, errorsuselocal а тидаме ца оьцу.
РогӀерчу маьӀнех цхьаъ: bc, html, none, plaintext, raw, wikitext
Ӏадйитаран кеп: bc
errorlang

ДӀахьедарш а, гӀалатийн хаамаш а гойтуш лелош болу мотт. action=query&meta=siteinfo&siprop=languages хаттаро йухаберзабо меттанийн кодийн могӀам. Билгалдаккха content хӀокху викин коьрта мотт лело, йа uselang uselang параметрехь санна маьӀна лело.

Ӏадйитаран кеп: uselang
errorsuselocal

Нагахь санна хӀоттийна хилча, гӀалатан тексташа лелор бу локалан модификаци йина хаамаш MediaWiki цӀерийн меттигера.

Тайпа: булин (мадарра)
Масалаш:
Коьртачу модулехь гӀодар.
api.php?action=help [ловзаран майда къайлайаккха]
Дерриге гӀоьнаш цхьана агӀонгахь.
api.php?action=help&recursivesubmodules=1 [ловзаран майда къайлайаккха]
Шордар:
apihighlimits
API дехаршна лакхара лимиташ леладе (меллаша дехарш: 500, сиха дехарш: 5000). Меллаша дехаран лимиташ леладо дуккха а маьӀна долчу параметрашца а.
Гарантийо: bot, sysop

Хаамийн тайпанаш

MediaWiki чу йаздар NFC-нормализаци йина UTF-8 хила деза. MediaWiki гӀорта тарло кхин чубогӀу хаамаш хийца, амма цунах хила тарло цхьайолу операцеш (масала edits MD5 талламца) ца хилийта.

Дуккха а маьӀна схьаоьцу параметраш Ӏадатехь дӀакхачайо маьӀна дӀасакъаьстина вертикалан хьаьркца, масала, param=value1|value2 йа param=value1%7Cvalue2. Нагахь санна маьӀнан вертикалан хьаьрк хила дезаш делахь, леладе U+001F (Unit Separator) дӀасакъастаран санна ткъа маьӀнан хьалха U+001F йазде, масала, param=%1Fvalue1%1Fvalue2>.

API дехаршкахь цхьадолу параметрийн тайпанаш кхин а дӀадийца деза:

boolean

Булин параметраш HTML байракхаш санна болх беш йу: нагахь санна параметр билгалйаьккхина йелахь, маьӀна ца лоьруш, иза бакъ лоруш йу. Харц маьӀна хилча, параметр йерриг а лахайаккха.

expiry

Чекхйаларан хенан маьӀна хила тарло гергара (масала, 5 бутт йа 2 кӀира) йа абсолютан (масала, 2014-09-18T12:34:56Z). Хан чекх ца йалархьама леладе чаккхе йоцуш, чаккхе йоцуш, чаккхе йоцуш йа цкъа а.

timestamp

Хенан билгалонаш къастайе тарло масех форматехь, хьажа хенан билгалонийн библиотекин чуйаларан форматаш mediawiki.org сайта тӀехь документашца кхин дӀа хаа. ISO 8601 терахь а, хан а ларйан йеза: 2001-01-15T14:56:00Z. Цул сов, могӀа now лело мегар ду карарчу хенан билгало билгалйаккхархьама.

Кепан параметраш

Подстановочни параметраш лелайо API модулехь кхечу параметран хӀора маьӀна долуш параметр схьаэца йезаш хилча. Масала, нагахь санна API модуль хиллехь стоьмаш боьхуш, цуьнан хила тарло fruits масала, гойтуш муьлха стоьмаш боьхуш бу, ткъа {fruit}-quantity диаметр параметр гойтуш, хӀора тайпанан стоьмех маса стоьмаш боьхуш бу. Ӏаш, 5 банан, 20 апельсин дехар динчу API клиенто тӀаккха дехар дан мегар дара fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

Кхоллархой

API кечдархой:

  • Yuri Astrakhan (кхоллархо, коьрта кечдархо 2006 шеран сентябрера 2007 шеран сентябрь кхаччалц)
  • Roan Kattouw (коьрта кечдархо 2007—2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (коьрта кечдархо 2013—2020)

Дехар до, шайн комментареш, кховдораш, хаттарш дӀакхачаде mediawiki-api@lists.wikimedia.org . йа гӀалаташ дӀакхачаде https://phabricator.wikimedia.org/ сайте.