Помош со Извршникот на МедијаВики
Ова е самосоздадена документациска страница за извршникот на МедијаВики.
Документација и примери: https://www.mediawiki.org/wiki/API
General information
Статус: Сите ставки на страницава би требало да работат, но Извршникот сепак е во активна разработка, што значи дека може да се смени во секое време. Објавите за измени можете да ги дознавате ако се пријавите на поштенскиот список „the mediawiki-api-announce“.
Погрешни барања: Кога Извршникот ќе добие погрешни барања, ќе се испрати HTTP-заглавие со клучот „MediaWiki-API-Error“ и потоа на вредностите на заглавието и шифрата на грешката што ќе се појават ќе им биде зададена истата вредност. Повеќе информации ќе најдете на Извршник: Грешки и предупредувања.
Request methods
Action API requests may use GET and POST methods. Prefer using the GET method, which allows requests to be routed to faster replica servers and responses to be cached, unless the length of the URL with parameters would exceed its length limit (commonly 8000 bytes), or a module only accepts POST requests.
Parameters for POST requests may be sent in the query part of the request URL (like in GET requests) and in the POST request body, and mixing both ways in one request is allowed. Certain parameters such as passwords must be sent in the request body. If the same parameter is sent as part of the URL and also in the request body, it must have the same value in both places.
Типови на податоци
Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.
Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.
Some parameter types in API requests need further explanation:
- boolean
Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
- expiry
Expiry values may be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). For no expiry, use infinite, indefinite, infinity or never.
- timestamp
Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. The string now may be used to specify the current time.
Limits
Most API modules can accept up to 50 inputs in multivalue parameters, and can return up to 500 results per query (50 results for slow queries).
For users with the apihighlimits right (Ботови и Администратори), the limits are increased to 500 inputs and 5.000 results (500 results for slow queries).
Templated parameters
Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.
Главен модул
- Извор: MediaWiki
- Лиценца: GPL-2.0-or-later
Specify the action to perform, the format of the response, and options that apply to all API modules.
- action
Кое дејство да се изврши.
- abusefiltercheckmatch
- Проверете дали филтерот пронаоѓа даден збир променливи, уредување или заведен настан во филтерот.
- abusefilterchecksyntax
- Провери ја синтаксата на даден филтер на злоупотреби.
- abusefilterevalexpression
- Оценува израз во Филтерот на злоупотреби.
- abusefilterunblockautopromote
- Отстранува блок на автоунапредување на даден корисник, добиен поради последица од филтер на злоупотреби.
- abuselogprivatedetails
- Преглед на лични податоци за ставка во Дневникот на злоупотреби.
- acquiretempusername
- Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.
- antispoof
- Проверете го корисничко име со нормализациската проверка на AntiSpoof.
- block
- Блокирај корисник.
- centralauthtoken
- Дај шифра за централна најава за заверено барање до приврзано вики.
- centralnoticecdncacheupdatebanner
- Побарај пречистување на содржината складирана во меѓускладот на CDN (предницата) за анонимни корисниици, за бараниот разглас и јазик
- centralnoticechoicedata
- Дај ги податоците потребни за избор на заглавие за даден проект и јазик
- centralnoticequerycampaign
- Добијте ги сите нагодени поставки за даден поход.
- changeauthenticationdata
- Change authentication data for the current user.
- changecontentmodel
- Промени го содржинскиот модел на страница
- checktoken
- Проверка на полноважноста на шифрата од action=query&meta=tokens.
- clearhasmsg
- Ја отстранува ознаката „
hasmsg“ од тековниот корисник. - clientlogin
- Log in to the wiki using the interactive flow.
- communityconfigurationedit
- Change the content of a configuration provider in Community configuration
- compare
- Добивање на разлика помеѓу две страници.
- createaccount
- Создај нова корисничка сметка.
- createlocalaccount
- Принудно создавање на месна сметка. Мора да постои централна сметка.
- cxdelete
- Бришење на нацрт-превод, создаден користејќи до додатокот за превод на содржини.
- cxtoken
- Дај JWT-шифри за заверка со cxserver.
- delete
- Избриши страница.
- deleteglobalaccount
- Избриши глобален корисник.
- discussiontoolsedit
- Напишете порака на разговорната страница.
- discussiontoolsfindcomment
- Најдете коментар според назнака или име.
- discussiontoolsgetsubscriptions
- Дај ги претплатните статуси на дадените теми.
- discussiontoolssubscribe
- Претплатете се (или отпишете се) за да добивате известувања на тема.
- discussiontoolsthank
- Испратете јавна благодарница за коментар.
- echocreateevent
- Рачно пушти известување за корисник
- echomarkread
- Означи ги сите известувања како прочитани за тековниот корисник.
- echomarkseen
- Означи ги известувањата како прочитани за тековниот корисник.
- echomute
- Занемување или однемување на известувања од извесни корисници или страници.
- edit
- Создај или уреди страници.
- editmassmessagelist
- Уредување на список за масовна достава на пораки.
- emailuser
- Испрати е-пошта на корисник.
- expandtemplates
- Ги проширува сите предлошки во викитекст.
- featuredfeed
- Дава тековник со избрана содржина.
- feedcontributions
- Дава тековник со придонеси на корисник.
- feedrecentchanges
- Дава тековник со скорешни промени.
- feedwatchlist
- Дава тековник со набљудуваните.
- filerevert
- Врати податотека на претходна верзија.
- flagconfig
- Дај основни информации за поставеноста на означените проверки за мрежново место.
- globalblock
- Глобално блокирајте или одблокирајте корисник.
- globalpreferenceoverrides
- Измена на месната замена на глобалните нагодувања за тековниот корисник.
- globalpreferences
- Смени глобални нагодувања на тековниот корисник.
- globaluserrights
- Додај/отстрани корисник во/од глобални групи.
- growthmanagementorlist
- Manage information in the structured mentor list (usually stored in MediaWiki:GrowthMentors.json). This module can be used by both current and future mentors (to add themselves or change their details) and administrators (for all users).
- growthmentordashboardupdatedata
- Schedule an extraordinary update of the mentee overview module in the mentor dashboard. You can only schedule one update per two hours for performance reasons.
- growthsetmenteestatus
- Set mentee's status (allows mentees to enable/disable mentorship module, or to opt-out entirely, which deletes the mentee/mentor relationship)
- growthsetmentor
- Set user's mentor. Change will be publicly logged.
- growthstarmentee
- Mark or unmark a mentee as starred by current user (stored privately and not logged)
- help
- Прикажувај помош за укажаните модули.
- homepagequestionstore
- Obtain formatted questions posted via homepage modules
- imagerotate
- Модулот е деактивиран.
- import
- Увези страница од друго вики или од XML-податотека.
- jsonconfig
- Оозможува непосреден пристап до потсистемот JsonConfig.
- languagesearch
- Пребарајте имиња на јазици на било кое писмо.
- linkaccount
- Link an account from a third-party provider to the current user.
- login
- Најавете се и добијте колачиња за заверка.
- logout
- Одјави се и исчисти ги податоците на седницата.
- managetags
- Извршување на раководни задачи по промена на ознаки.
- massmessage
- Испрати порака на страници на список.
- mergehistory
- Спојување на истории на страници.
- move
- Премести страница.
- opensearch
- Пребарување на викито со протоколот OpenSearch.
- options
- Смени ги нагодувањата на тековниот корисник.
- paraminfo
- Набави информации за извршнички (API) модули.
- parse
- Parses content and returns parser output.
- patrol
- Испатролирај страница или преработка.
- protect
- Смени го степенот на заштита на страница.
- purge
- Purge the cache for the given titles.
- query
- Преземи податоци од и за МедијаВики.
- removeauthenticationdata
- Remove authentication data for the current user.
- resetpassword
- Send a password reset email to a user.
- review
- Прегледајте преработка и одобрете ја или одземете ѝ го одобрението.
- revisiondelete
- Delete and undelete revisions.
- rollback
- Undo the last edit to the page.
- rsd
- Export an RSD (Really Simple Discovery) schema.
- setglobalaccountstatus
- Скриј или заклучи (или откриј/отклучи) глобална корисничка сметка.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Change the language of a page.
- shortenurl
- Скратување на долга URL во покус облик.
- sitematrix
- Дава список на Викимедиини викија.
- spamblacklist
- Провери една или повеќе URL-адреси во списокот за блокирање на спам.
- stabilize
- Поставки за стабилноста на измената на страниците.
- streamconfigs
- Изложува поставки на тековници за настани. Го дава само format=json со formatversion=2.
- strikevote
- Им овозможува на администраторите да поништат или повратат глас.
- sxdelete
- Избриши нацрт-превод на одделот и неговите напоредни корпуси од базата.
- tag
- Додавање или отстранување ознаки за промени од поединечни преработки или дневнички записи.
- templatedata
- Преземање на податоци складирани од додатокот „Предложни податоци“ (TemplateData).
- thank
- Испрати благодарница на уредник.
- titleblacklist
- Провери наслов на страница, име на податотека или корисничко име во Црниот список.
- torblock
- Проверете дали некоја IP-адреса е блокирана како излезен јазол на Tor.
- transcodereset
- Корисниците со правото „transcode-reset“ можат прекодирањата да ги вршат одново.
- unblock
- Одблокирај корисник.
- undelete
- Undelete revisions of a deleted page.
- unlinkaccount
- Remove a linked third-party account from the current user.
- upload
- Upload a file, or get the status of pending uploads.
- userrights
- Change a user's group membership.
- validatepassword
- Validate a password against the wiki's password policies.
- watch
- Додај или отстрани страници од набљудуваните на тековниот корисник.
- webapp-manifest
- Дава манифест на семрежиот прилог.
- webauthn
- Извршничкиот модул кој посредува меѓу опслужувачот и клиентот при зачленувањето/заверката.
- wikilove
- Дајте викиљубов на корисник.
- bouncehandler
- Внатрешен. Испрати повратно известување по е-пошта за обработка за работа со неуспешен прием.
- categorytree
- Внатрешен. Внатрешен модул на додатокот „Дрво на категории“.
- chartinfo
- Внатрешен. Добивање на бројот на одделни употреби на Графикон. Повеќекратните употреби на еден ист графикон на истата страница се бројат како едно.
- cirrus-check-sanity
- Внатрешен. Известува за исправноста на опсег на опсези на страници во пребарувачкиот индекс
- cirrus-config-dump
- Внатрешен. Складиштен извадок од поставките на CirrusSearch.
- cirrus-profiles-dump
- Внатрешен. Складиштен извадок од профилите на CirrusSearch за ова вики.
- cirrus-schema-dump
- Внатрешен. Резервен склад на шемата за CirrusSearch (нагодувања и пресликувања) за ова вики.
- codemirror-validate
- Внатрешен. Провери грешки во заверката за дадениот контекст
- collection
- Внатрешен. Приложнички модул за вршење на разни постапки врз нечија корисничка збирка.
- cspreport
- Внатрешен. Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
- cxcheckunreviewed
- Внатрешен. Проверете дали тековниот корисник има скорешни преводи направени брзо и без проверка.
- cxfavoritesuggestions
- Внатрешен. Додај или отстрани омилен предлог во списокот на тековиот корисник.
- cxpublish
- Внатрешен. Зачувај страница создадена со додатокот „Превод на содржини“.
- cxpublishsection
- Внатрешен. Зачувај оддел создаден со можноста за превод на оддели на додатокот „Превод на содржини“.
- cxsave
- Внатрешен. Овој модул ви овозможува да зачувате недовршени преводи по оддели за заштеда на семрежен проток и поврзување на напоредни корпуси.
- cxsplit
- Внатрешен. Создај и зачувај превод на оддел во базата, за секој преведен оддел на даден превод на статија
- discussiontoolscompare
- Внатрешен. Дај информации за изменетите коментари помеѓу две преработки на страницата.
- discussiontoolspageinfo
- Внатрешен. Дава метаподатоци потребни за покревање на разговорните алатки.
- discussiontoolspreview
- Внатрешен. Преглед на порака на разговорна страница.
- echopushsubscriptions
- Внатрешен. Раководење со претплати на наметнувања за тековниот корисник.
- editcheckreferenceurl
- Внатрешен. Check the status of a URL for use as a reference.
- fancycaptchareload
- Внатрешен. Дај нова FancyCaptcha.
- growthinvalidateimagerecommendation
- Внатрешен. Invalidate an image recommendation.
- growthinvalidatepersonalizedpraisesuggestion
- Внатрешен. Invalidates a suggestion of a praiseworthy mentee in the Personalized praise module on the Mentor dashboard
- growthinvalidaterevisetonerecommendation
- Внатрешен. Drop a 'Revise Tone' recommendation for a given page.
- helppanelquestionposter
- Внатрешен. Работа со прашања поставени преку за тековниот корисник.
- jsondata
- Внатрешен. Повикува локализирани JSON-податоци.
- jsontransform
- Внатрешен. Добивање на JSON-податоци преобразени со Lua-функција.
- parser-migration
- Внатрешен. Расчлени страници со две различни расчленувачки поставки.
- readinglists
- Внатрешен. Reading list write operations.
- sanitize-mapdata
- Внатрешен. Врши проверка на податоци за додатокот „Картограф“.
- scribunto-console
- Внатрешен. Внатрешен модул за опслужување на XHR-барања од конзолата на Scribunto.
- securepollauth
- Внатрешен. Овозможува далечинско вики да заверува корисници пред да им даде пристап до гласање на избори.
- stashedit
- Внатрешен. Prepare an edit in shared cache.
- sxsave
- Внатрешен. Зачувај го нацрт-преводот на одделот и складирај ги напоредните корпуси
- timedtext
- Внатрешен. Дава времеводена текстуална содржина за употреба од елементи $lt;track>
- ulslocalization
- Внатрешен. Дај превод на универзалниот јазичен избрач на дадениот јазик.
- ulssetlang
- Внатрешен. Менување на претпочитаниот јазик на посредникот.
- visualeditor
- Внатрешен. Дава HTML5 за страница од службата Parsoid.
- visualeditoredit
- Внатрешен. Зачувајте HTML5-страница во МедијаВики (се претвора во викитекст преку службата Parsoid).
- wikimediaeventsblockededit
- Внатрешен. Заведувај информации во дневникот за блокирани обиди за најава
- wikimediaeventshcaptchaeditattempt
- Внатрешен. Заведи ја разликата во уредувањата кога ќе се појави предизвик hCaptcha, но уредувањето е нецелосно
- Една од следниве вредности: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, cxdelete, cxtoken, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flagconfig, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, growthmanagementorlist, growthmentordashboardupdatedata, growthsetmenteestatus, growthsetmentor, growthstarmentee, help, homepagequestionstore, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, review, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, stabilize, streamconfigs, strikevote, sxdelete, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, wikilove, bouncehandler, categorytree, chartinfo, cirrus-check-sanity, cirrus-config-dump, cirrus-profiles-dump, cirrus-schema-dump, codemirror-validate, collection, cspreport, cxcheckunreviewed, cxfavoritesuggestions, cxpublish, cxpublishsection, cxsave, cxsplit, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, echopushsubscriptions, editcheckreferenceurl, fancycaptchareload, growthinvalidateimagerecommendation, growthinvalidatepersonalizedpraisesuggestion, growthinvalidaterevisetonerecommendation, helppanelquestionposter, jsondata, jsontransform, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, sxsave, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit, wikimediaeventshcaptchaeditattempt
- По основно: help
- format
Формат на изводот.
- json
- Давај го изводот во JSON-формат.
- jsonfm
- Давај го изводот во JSON-формат (подобрен испис во HTML).
- none
- Не давај извод.
- rawfm
- Давај го изводот со елементи за отстранување грешки во JSON-формат (подобрен испис во HTML).
- xml
- Давај го изводот во XML-формат.
- xmlfm
- Давај го изводот во XML-формат (подобрен испис во HTML).
- Една од следниве вредности: json, jsonfm, none, rawfm, xml, xmlfm
- По основно: jsonfm
- maxlag
Најголемиот допуштен заостаток може да се користи кога МедијаВики е воспоставен на грозд умножен од базата. За да спречите дополнителни заостатоци од дејства, овој параметар му наложува на клиентот да почека додека заостатокот не се намали под укажаната вредност. Во случај на преголем заостаток, системт ја дава грешката со код maxlag со порака од обликот Го чекам $host: има заостаток од $lag секунди.
Погл. Прирачник: Параметар Maxlag за повеќе информации.- Вид: цел број
- smaxage
Задајте му олку секунди на заглавието за контрола HTTP-меѓускладот
s-maxage. Грешките никогаш не се чуваат во меѓускладот.- Вид: цел број
- Вредноста не може да изнесува помалку од 0.
- По основно: 0
- maxage
Задајте му олку секунди на заглавието за контрола HTTP-меѓускладот
s-maxage. Грешките никогаш не се чуваат во меѓускладот.- Вид: цел број
- Вредноста не може да изнесува помалку од 0.
- По основно: 0
- assert
Провери дали корисникот е најавен ако е зададено user или дали го има корисничкото право на бот, ако е зададено bot.
- Една од следниве вредности: anon, bot, user
- assertuser
Verify the current user is the named user.
- Вид: корисник, од некое од корисничко име и Привремен корисник
- requestid
Тука внесената вредност ќе биде вклучена во извештајот. Може да се користи за разликување на барањата.
- servedby
Вклучи го домаќинското име што го услужило барањето во исходот.
- Type: boolean (details)
- curtimestamp
Вклучи тековно време и време и датум во исходот.
- Type: boolean (details)
- responselanginfo
Include the languages used for uselang and errorlang in the result.
- Type: boolean (details)
- origin
Кога му пристапувате на Прилогот користејќи повеќедоменско AJAX-барање (CORS), задајте му го на ова изворниот домен. Ова мора да се вклучи во секое подготвително барање и затоа мора да биде дел од URI на барањето (не главната содржина во POST). Ова мора точно да се совпаѓа со еден од изворниците на заглавието Origin:, така што мора да е зададен на нешто како https://mk.wikipedia.org or https://meta.wikimedia.org. Ако овој параметар не се совпаѓа со заглавието
Origin:, ќе се појави одговор 403. Ако се совпаѓа, а изворникот е на бел список (на допуштени), тогаш ќе се зададе заглавиетоAccess-Control-Allow-Origin.- crossorigin
When accessing the API using a cross-domain AJAX request (CORS) and using a session provider that is safe against cross-site request forgery (CSRF) attacks (such as OAuth), use this instead of
origin=*to make the request authenticated (i.e., not logged out). This must be included in any pre-flight request, and therefore must be part of the request URL (not the POST body).Note that most session providers, including standard cookie-based sessions, do not support authenticated CORS and cannot be used with this parameter.
- Type: boolean (details)
- uselang
Јазик за преведување на пораките. action=query&meta=siteinfo со siprop=languages дава список на јазични кодови, или укажете user за да го користите тековно зададениот јазик корисникот, или пак укажете content за да го користите јазикот на содржината на ова вики.
- По основно: user
- variant
Variant of the language. Only works if the base language supports variant conversion.
- errorformat
Format to use for warning and error text output
- plaintext
- Wikitext with HTML tags removed and entities replaced.
- wikitext
- Нерасчистен викитекст.
- html
- HTML
- raw
- Message key and parameters.
- none
- Без текстуален излез, само кодови за грешки.
- bc
- Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
- Една од следниве вредности: bc, html, none, plaintext, raw, wikitext
- По основно: bc
- errorlang
Language to use for warnings and errors. action=query&meta=siteinfo&siprop=languages returns a list of language codes. Specify content to use this wiki's content language or uselang to use the same value as the uselang parameter.
- По основно: uselang
- errorsuselocal
If given, error texts will use locally-customized messages from the МедијаВики namespace.
- Type: boolean (details)
- centralauthtoken
Кога пристапувате на прилогот со прекудоменско AJAX-барање (CORS), употребете го ова за да се легитимирате како тековниот корисник со обединета сметка. Послужете се со action=centralauthtoken на ова вики за да ја добиете шифрата пред да го направите барањето. Секоја шифра може да се употреби само еднаш и истекува по 60 секунди. Ова треба да се вклучи во секое предбарање, и затоа треба да биде вклучено во URI на барањето (не во содржината на POST).
На ова вики очекуваната вредност е семрежна шифра на JSON, што може да се потврди од застапнички опслужувачи пред МедијаВики. Ако шифрата е истечена или поинаку неважечка, може да добиете HTTP-грешка од застапник во поинаков формат отколку нормалната приложничка грешка.
- Помош за главниот модул
- api.php?action=help [open in sandbox]
- Сета помош на една страница
- api.php?action=help&recursivesubmodules=1&toc [open in sandbox]
Признанија
Разработувачи на Извршникот:
- Роан Катау (главен резработувач од септември 2007 до 2009 г.)
- Виктор Василев
- Брајан Тонг Мињ
- Сем Рид
- Јуриј Астрахан (создавач, главен разработувач од септември 2006 до септември 2007 г.)
- Brad Jorsch (главен разработувач од 2013 г. до денес)
Вашите коментари, предлози и прашања испраќајте ги на mediawiki-api@lists.wikimedia.org а грешките пријавувајте ги на https://phabricator.wikimedia.org/.