Це автоматично генерована стор?нка документац?? API MediaWiki.
Документац?я та приклади:
https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Головний модуль
Статус:
Ус? функц??, вказан? на ц?й стор?нц?, мають працювати, але API дал? перебува? в активн?й розробц? ? може зм?нитися у будь-який момент. П?дпиш?ться на
список розсилки mediawiki-api-announce
, щоб пом?чати оновлення.
Хибн? запити:
Коли до API надсилаються хибн? запити, буде в?д?слано HTTP-заголовок з ключем ≪MediaWiki-API-Error≫, а тод? ? значення заголовку, ? код помилки, над?слан? назад, будуть встановлен? з тим же значенням. Б?льше ?нформац?? див. на стор?нц?
API: Помилки й попередження
.
Тестування:
Для зручност? тестування запит?в API, див.
Special:ApiSandbox
.
Конкретн? параметри:
- 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
- Отримати centralauthtoken для виконання автентиф?кованого запиту до прикр?плено? в?к?.
- centralnoticecdncacheupdatebanner
- Запитати очистку вм?сту банеру збереженого в CDN-кеш? (на фронт-енд?) для анон?мних користувач?в для обраних банеру та мови.
- centralnoticechoicedata
- Отримати дан?, необх?дн? для вибору банера для даного про?кту та мови
- centralnoticequerycampaign
- Отримати вс? параметри конф?гурац?? для кампан??.
- changeauthenticationdata
- Зм?на параметр?в автентиф?кац?? для поточного користувача.
- changecontentmodel
- Зм?нити модель вм?сту стор?нки
- checktoken
- Перев?рити коректн?сть токена з
action=query&meta=tokens
.
- cirrus-config-dump
- Дамп конф?гурац?? CirrusSearch.
- cirrus-mapping-dump
- Дамп в?дображення CirrusSearch для ц??? В?к?.
- cirrus-profiles-dump
- Дамп проф?л?в CirrusSearch для ц??? в?к?.
- cirrus-settings-dump
- Дамп налаштувань CirrusSearch для ц??? В?к?.
- clearhasmsg
- Очища? прапорець
hasmsg
для поточного користувача.
- clientlogin
- Ув?йд?ть у в?к? з допомогою ?нтерактивного потоку.
- compare
- Отримати пор?вняння двох стор?нок.
- createaccount
- Створити новий обл?ковий запис користувача.
- createlocalaccount
- Примусово створити локальний обл?ковий запис. Центральний обл?ковий запис ма? ?снувати.
- cxdelete
- Вилучити чернетку перекладу, створену за допомогою розширення ContentTranslation.
- cxsuggestionlist
- Керувати списками пропозиц?й. Додавати пропозиц?? до списку й вилучати ?х.
- cxtoken
- Отримати токени JWT для автентиф?кац?? з cxserver.
- delete
- Вилучити стор?нку.
- deleteglobalaccount
- Вилучити глобального користувача.
- discussiontoolsedit
- Опубл?кувати пов?домлення на стор?нку обговорення.
- discussiontoolsfindcomment
- Find a comment by its ID or name.
- discussiontoolsgetsubscriptions
- Отримайте статуси п?дписки на певн? теми.
- discussiontoolssubscribe
- П?дписатися (або скасувати п?дписку), щоб отримувати спов?щення про тему.
- discussiontoolsthank
- Send a public thank-you notification for a comment.
- echocreateevent
- Manually trigger a notification to a user
- echomarkread
- Позначити спов?щення як прочитан? для поточного користувача.
- echomarkseen
- Позначити спов?щення як переглянут? для поточного користувача.
- echomute
- Приглушити або повернути спов?щення в?д деяких стор?нок чи користувач?в.
- edit
- Створювати ? редагувати стор?нки.
- editmassmessagelist
- Редагувати список доставки масових пов?домлень.
- emailuser
- Над?слати електронного листа користувачев?
- expandtemplates
- Розгорта? ус? шаблони в межах в?к?розм?тки.
- featuredfeed
- Вида? стр?чку обраного контенту.
- feedcontributions
- Поверта? стр?чку внеску користувача.
- feedrecentchanges
- Вида? стр?чку нових редагувань.
- feedwatchlist
- Вида? стр?чку списку спостереження.
- filerevert
- Повернути файл до старо? верс??.
- flagconfig
- Отримати базову ?нформац?ю про налаштування патрулювання на цьому сайт?.
- globalblock
- Глобально заблокувати чи розблокувати користувача.
- globalpreferenceoverrides
- Зм?нити локальн? зам?ни глобальних налаштувань для поточного користувача.
- globalpreferences
- Зм?нити глобальн? налаштування поточного користувача.
- globaluserrights
- Додати/вилучити користувача до/з глобальних груп.
- growthmanagementorlist
- Керуйте ?нформац??ю в структурованому списку наставник?в (зазвичай збер?га?ться в
MediaWiki:GrowthMentors.json
). Цим модулем можуть користуватися як поточн?, так ? майбутн? наставники (щоб додати себе чи зм?нити сво? дан?), а також адм?н?стратори (для вс?х користувач?в).
- growthmentordashboardupdatedata
- Запланувати позачергове оновлення модуля огляду п?доп?чних на панел? наставника. З робочих м?ркувань, ви можете запланувати не б?льше одного оновлення упродовж двох годин.
- growthsetmenteestatus
- Зада? статус наставника (дозволя? наставникам вмикати/вимикати модуль наставництва або зовс?м в?дмовитися, що вилучить зв'язок п?доп?чного й наставника)
- growthsetmentor
- Призначити наставника для користувача. Зм?ну буде записано в публ?чному журнал?.
- growthstarmentee
- Позначити п?доп?чного з?рочкою або зняти позначку як поточний користувач (збер?га?ться приватно ? не вноситься в журнали)
- help
- В?дображати дов?дку для зазначених модул?в.
- homepagequestionstore
- Отримати форматован? запитання, опубл?кован? через модул? домашньо? стор?нки
- imagerotate
- Цей модуль було в?дключено.
- import
- ?мпортувати стор?нку з ?ншо? в?к? або з XML-файлу.
- jsonconfig
- Забезпечу? прямий доступ до п?дсистеми JsonConfig.
- languagesearch
- Пошук назв мов у будь-якому написанн?.
- linkaccount
- Пов'язати обл?ковий запис третьо? сторони з поточним користувачем.
- login
- Ув?йти в систему й отримати куки автентиф?кац??.
- logout
- Вийти й очистити дан? сес??.
- managetags
- Виконати кер?вн? завдання щодо зм?ни те??в.
- massmessage
- Над?слати пов?домлення на список стор?нок.
- mergehistory
- Об'?днання ?стор?й редагувань.
- move
- Перейменувати стор?нку.
- opensearch
- Шукати у в?к? з використанням протоколу OpenSearch.
- options
- Зм?нити налаштування поточного користувача.
- paraminfo
- Отримати ?нформац?ю про модул? API.
- parse
- Анал?зу? вм?ст ? вида? парсер виходу.
- patrol
- В?дпатрулювати стор?нку чи верс?ю.
- protect
- Зм?нити р?вень захисту стор?нки.
- purge
- Очистити кеш для вказаних заголовк?в.
- query
- Виб?рка даних з ? про MediaWiki.
- removeauthenticationdata
- Вилучити параметри автентиф?кац?? для поточного користувача.
- resetpassword
- В?дправити користувачу лист для в?дновлення пароля.
- review
- Перев?рити верс?ю, затвердивши ?? або знявши затвердження.
- revisiondelete
- Вилучити або в?дновити верс??.
- rollback
- Скасувати останн? редагування ц??? стор?нки.
- rsd
- Експортувати як схему RSD (Really Simple Discovery).
- setglobalaccountstatus
- Приховати або закрити (або скасувати приховання чи закриття) глобального обл?кового запису користувача.
- setnotificationtimestamp
- Оновити часову м?тку спов?щень для стор?нок, що спостер?гаються.
- setpagelanguage
- Зм?нити мову стор?нки.
- shortenurl
- Перетворити довгу URL-адресу в коротку
- sitematrix
- Отримати список сайт?в В?к?мед?а.
- spamblacklist
- Перев?рити одну або к?лька URL-адрес у списку заблокованих спам-посилань.
- stabilize
- Зм?нити параметри стаб?льност? стор?нки.
- streamconfigs
- Розкрива? конф?гурац?ю потоку под?й. Вида? лише format=json ?з formatversion=2.
- strikevote
- Дозволя? адм?н?страторам викреслити або в?дновити голоси.
- sxdelete
- Delete the draft section translation and its parallel corpora from database.
- tag
- Додати або вилучити зм?ни м?ток з окремих верс?й або запис?в журналу.
- templatedata
- Отримати дан?, що збер?гаються розширенням TemplateData.
- thank
- Над?слати редактору спов?щення про подяку.
- titleblacklist
- Перев?рити назву стор?нки, файлу або ?м'я користувача на наявн?сть у чорному списку назв.
- torblock
- Перев?рте, чи не заблоковано IP-адресу як вих?дний вузол Tor.
- transcodereset
- Користувач? з правом ≪transcode-reset≫ можуть скинути ? повторити задачу перекодування.
- unblock
- Розблокувати користувача.
- undelete
- В?дновити верс?? вилучено? стор?нки.
- unlinkaccount
- Вилучити пов'язаний обл?ковий запис третьо? сторони з поточного користувача.
- upload
- Завантажити файл, або отримати статус завантажень у процес?.
- userrights
- Зм?нити членство користувача у групах.
- validatepassword
- Перев?рити пароль на предмет в?дпов?дност? пол?тикам в?к? щодо парол?в.
- watch
- Додати або вилучити стор?нки з списку спостереження поточного користувача.
- webapp-manifest
- Виводить ман?фест webapp.
- webauthn
- Модуль API для комун?кац?? м?ж сервером та кл??нтом протягом процесу ре?страц??/автентиф?кац??.
- wikilove
- Вислов?ть в?к?симпат?ю ?ншому користувачев?.
- bouncehandler
- Внутр?шн?й.
Отримувати електронний лист-в?дмову ? обробляти його для обробки невдалого одержувача.
- categorytree
- Внутр?шн?й.
Внутр?шн?й модуль для розширення CategoryTree.
- cirrus-check-sanity
- Внутр?шн?й.
Reports on the correctness of a range of page ids in the search index
- collection
- Внутр?шн?й.
API module for performing various operations on a wiki user's collection.
- cspreport
- Внутр?шн?й.
Використову?ться браузерами для пов?домлення порушень Правил безпеки контенту (Content Security Policy). Цей модуль не повинен використовуватися, окр?м випадк?в автоматичного використання веб-браузером для CSP-скарги.
- cxcheckunreviewed
- Внутр?шн?й.
Check if any fast, unreviewed translation has been published recently for the current user.
- cxpublish
- Внутр?шн?й.
Зберегти стор?нку, створену за допомогою розширення ContentTranslation.
- cxpublishsection
- Внутр?шн?й.
Зберегти розд?л, створений функц??ю перекладу розд?лу розширення Переклад вм?сту.
- cxsave
- Внутр?шн?й.
Цей модуль да? змогу збер?гати чернетки переклад?в за розд?лом, щоб збер?гати ширину смуги ? накопичувати паралельн? переклади.
- cxsplit
- Внутр?шн?й.
Create and save a section translation to database, for every translated section of the given article translation
- discussiontoolscompare
- Внутр?шн?й.
Отримати ?нформац?ю про зм?ни коментар?в м?ж двома верс?ями стор?нки.
- discussiontoolspageinfo
- Внутр?шн?й.
Поверта? метадан? необх?дн? для ?н?ц?ал?зац?? ?нструмент?в обговорення.
- discussiontoolspreview
- Внутр?шн?й.
Попередн?й перегляд пов?домлення на стор?нц? обговорення.
- echopushsubscriptions
- Внутр?шн?й.
Керувати пуш-п?дписками для поточного користувача.
- editcheckreferenceurl
- Внутр?шн?й.
Check the status of a URL for use as a reference.
- fancycaptchareload
- Внутр?шн?й.
Отримати нову FancyCaptcha.
- growthinvalidateimagerecommendation
- Внутр?шн?й.
Позначити рекомендац?ю зображення як нед?йсну.
- growthinvalidatepersonalizedpraisesuggestion
- Внутр?шн?й.
Анулю? пропозиц?ю г?дного похвали п?доп?чного в модул? персонал?зовано? похвали на панел? наставника
- helppanelquestionposter
- Внутр?шн?й.
Працювати ?з запитаннями поточного користувача, поставленими через дов?дкову панель.
- jsondata
- Внутр?шн?й.
Отримати локал?зован? дан? JSON.
- oathvalidate
- Внутр?шн?й.
Перев?рити токен двофакторно? автентиф?кац?? (OATH).
- parser-migration
- Внутр?шн?й.
Розпарсити стор?нку з двома р?зними конф?гурац?ями парсера.
- readinglists
- Внутр?шн?й.
Д?? ?з записування у списках читання.
- sanitize-mapdata
- Внутр?шн?й.
Викону? перев?рку даних для розширення Kartographer
- scribunto-console
- Внутр?шн?й.
Внутр?шн?й модуль обробки XHR-запит?в з консол? Scribunto.
- securepollauth
- Внутр?шн?й.
Allows a remote wiki to authenticate users before granting access to vote in the election.
- stashedit
- Внутр?шн?й.
П?дготувати редагування в загальний кеш.
- sxsave
- Внутр?шн?й.
Зберегти чернетку перекладу розд?лу та зберегти паралельн? корпуси
- timedtext
- Внутр?шн?й.
Нада? контент синхрон?зованого тексту для використання в елементах <track>
- ulslocalization
- Внутр?шн?й.
Отримати локал?зац?ю ULS вказаною мовою.
- ulssetlang
- Внутр?шн?й.
Оновити пр?оритетну мову ?нтерфейсу для користувача.
- visualeditor
- Внутр?шн?й.
Поверта? HTML5 для стор?нки в?д серв?су Parsoid.
- visualeditoredit
- Внутр?шн?й.
Зберегти HTML5-стор?нку у MediaWiki (конвертовану у в?к?текст серв?сом Parsoid).
- wikimediaeventsblockededit
- Внутр?шн?й.
Log information about blocked edit attempts
- Одне з наступних значень:
abusefiltercheckmatch
,
abusefilterchecksyntax
,
abusefilterevalexpression
,
abusefilterunblockautopromote
,
abuselogprivatedetails
,
acquiretempusername
,
antispoof
,
block
,
centralauthtoken
,
centralnoticecdncacheupdatebanner
,
centralnoticechoicedata
,
centralnoticequerycampaign
,
changeauthenticationdata
,
changecontentmodel
,
checktoken
,
cirrus-config-dump
,
cirrus-mapping-dump
,
cirrus-profiles-dump
,
cirrus-settings-dump
,
clearhasmsg
,
clientlogin
,
compare
,
createaccount
,
createlocalaccount
,
cxdelete
,
cxsuggestionlist
,
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
,
cirrus-check-sanity
,
collection
,
cspreport
,
cxcheckunreviewed
,
cxpublish
,
cxpublishsection
,
cxsave
,
cxsplit
,
discussiontoolscompare
,
discussiontoolspageinfo
,
discussiontoolspreview
,
echopushsubscriptions
,
editcheckreferenceurl
,
fancycaptchareload
,
growthinvalidateimagerecommendation
,
growthinvalidatepersonalizedpraisesuggestion
,
helppanelquestionposter
,
jsondata
,
oathvalidate
,
parser-migration
,
readinglists
,
sanitize-mapdata
,
scribunto-console
,
securepollauth
,
stashedit
,
sxsave
,
timedtext
,
ulslocalization
,
ulssetlang
,
visualeditor
,
visualeditoredit
,
wikimediaeventsblockededit
- Стандартно: 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
з пов?домленням на зразок
Оч?кування на $host: $lag секунд(и) затримки
.
Див.
Manual: Maxlag parameter
для детальн?шо? ?нформац??.
- Тип: ц?ле число
- smaxage
Встановити
s-maxage
HTTP кеш-контроль заголовок на ст?льки секунд. Помилки н?коли не кешуються.
- Тип: ц?ле число
- Значення ма? бути не меншим, н?ж 0.
- Стандартно: 0
- maxage
Встановити
max-age
HTTP кеш-контроль заголовок на ст?льки секунд. Помилки н?коли не кешуються.
- Тип: ц?ле число
- Значення ма? бути не меншим, н?ж 0.
- Стандартно: 0
- assert
Перев?рити, що користувач ув?йшов у систему (у тому числ?, можливо, тимчасовий користувач), якщо задано
user
,
не
ув?йшов у систему, якщо задано
anon
, або ма? права бота, якщо задано
bot
.
- Одне з наступних значень: anon, bot, user
- assertuser
Перев?рити, чи поточний користувач ? найменованим користувачем.
- Тип: користувач, подано як ?м'я користувача та Тимчасовий користувач
- requestid
Будь-яке значення, вказане тут, буде включене у в?дпов?дь. Може використовуватися, щоб в?др?зняти запити.
- servedby
Включити в результати ?м'я хоста, який обробив запит.
- Тип: лог?чний (
подробиц?
)
- curtimestamp
Включити в результат поточну м?тку часу.
- Тип: лог?чний (
подробиц?
)
- responselanginfo
Включати мови, як? були використан? для
uselang
?
errorlang
, у результат.
- Тип: лог?чний (
подробиц?
)
- origin
При доступ? до API з використанням крос-доменного AJAX-запиту (CORS), задайте параметру значення вих?дного домена. В?н ма? бути включений у будь-який попередн?й запит ? таким чином мусить бути частиною запиту URI (не т?ла POST).
Для автентиф?кованих запит?в в?н повинен точно зб?гатися з одним ?з виход?в у заголовку
Origin
, тобто бути заданим чимось на зразок
https://uk.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
? вс? дан? про користувача будуть заборонен?.
- 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.
- Тип: лог?чний (
подробиц?
)
- centralauthtoken
При доступ? до API з використанням м?ждоменного AJAX-запиту (CORS), використовуйте це для автентиф?кац?? як поточний SUL-користувач. Використовуйте
action=centralauthtoken
у ц?й в?к?, аби вивести токен, перш н?ж зд?йснювати запит CORS. Кожен токен можна використати лише раз, через 10 секунд в?н ста? нед?йсним. Це ма? бути включено в будь-який попередн?й запит, ?, зважаючи на це, ? у запитуваний URI (не в POST-т?ло).
Дозволи:
- writeapi
- Використання API для запису
- Надан?: all, user та bot
- apihighlimits
- Використовувати вищ? л?м?ти у запитах API (пов?льн? запити: 500; швидк? запити: 5000). Л?м?ти для пов?льних запит?в також застосовуються до багатозначних параметр?в.
- Надан?: bot та sysop
Типи даних
Введен? дан? в MediaWiki мають бути в NFC-нормал?зованому формат? UTF-8. MediaWiki може зробити спробу конвертувати дан? в будь-якому ?ншому формат?, але це може спричинити невдачу деяких операц?й (таких як
редагування
з перев?рками MD5).
Параметри, як? допускають два ? б?льше значень, зазвичай подаються з цими значеннями, розд?леними через вертикальну риску, напр.,
param=значення1|значення2
або
param=значення1%7Cзначення2
. Якщо ж значення повинно м?стити вертикальну риску, використовуйте U+001F (Unit Separator) як розд?льник
та
додавайте до значення преф?кс U+001F, напр.,
param=%1Fзначення1%1Fзначення2
.
Деяк? типи параметр?в у запитах до API потребують додаткових пояснень:
- boolean
Лог?чн? типи даних працюють як чекбокси з галочками в HTML: якщо параметр вказано, незалежно в?д значення, то в?н розц?ню?ться як ≪true≫. Для значення ≪false≫, уникн?ть параметра ц?лковито.
- expiry
Час може бути в?дносним (напр.,
5 months
чи
2 weeks
) або абсолютним (напр.,
2014-09-18T12:34:56Z
). Щоб спостер?гати за стор?нкою безстроково, використовуйте
infinite
,
indefinite
,
infinity
, чи
never
.
- timestamp
М?тки часу можна вказувати в р?зних форматах, див.
формати вводу з б?бл?отеки м?ток часу, задокументован? на mediawiki.org
, щоб д?знатись б?льше. Рекомендовано використовувати дату й час у формат? ISO 8601:
2001
-
01
-
15
T
14
:
56
:
00
Z
. Додатково можна використати рядок
now
для вказання поточно? м?тки часу.
Шаблонн? параметри
Шаблонн? параметри п?дтримують випадки, в яких модулю API необх?дне значення для кожного значення якогось ?ншого параметра. Наприклад, якби був модуль API для запит?в фрукт?в, у нього був би параметр
fruits
для зазначення, запит на як? саме фрукти надсила?ться ? шаблонний параметр
{fruit}-quantity
для зазначення, ск?льки саме кожного р?зновиду фрукт?в потр?бно. Кл??нт API, якому потр?бн? 1 яблуко, 5 банан?в ? 20 полуниць, таким чином, м?г би над?слати запит у форм?
fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20
.
Автор(и)
Розробники API:
- Roan Kattouw (головний розробник вер. 2007?2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Yuri Astrakhan (творець, головний розробник вер. 2006 ? вер. 2007)
- Brad Jorsch (головний розробник 2013 ? 2020)
Будь ласка, надсилайте сво? коментар?, пропозиц?? та запитання на mediawiki-api@lists.wikimedia.org
або подайте зв?т про помилку за адресою
https://phabricator.wikimedia.org/
.