MediaWiki API help

This is an auto-generated MediaWiki Action API documentation page.

General information

Status: API MediaWiki adalah antarmuka yang matang dan stabil yang secara aktif didukung dan diperbagus. Walu kami berusaha untuk menghindarinya, kami mungkin sesekali perlu membuat perubahan yang merusak; langgani daftar penyurelan mediawiki-api-announce untuk pemberitahuan pemutakhiran.

Permintaan salah: Ketika permintaan yang salah dikirim ke API, pengepala HTTP akan dikirim dengan kunci "MediaWiki-API-Error" dan kemudian nilai pengepala dan kode galat yang dikirim balik akan diatur ke nilai yang sama. Untuk informasi lebih, lihat API: Galat dan peringatan.

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.

Data types

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 (Bot dan Pengurus), 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.

Main module

Specify the action to perform, the format of the response, and options that apply to all API modules.

Specific parameters:
action

Tindakan manakah yang akan dilakukan.

abusefiltercheckmatch
Melihat apakah sebuah Filter Penyalahgunaan sesuai dengan seperangkat variabel, sebuah suntingan, atau sebuah kejadian yang dicatat Filter Penyalahgunaan.
abusefilterchecksyntax
Periksa sintaks dari filter AbuseFilter.
abusefilterevalexpression
Mengevaluasi ekspresi AbuseFilter.
abusefilterunblockautopromote
Membuka blokir pengguna dari menerima konfirmasi otomatis karena konsekuensi filter penyalahgunaan.
abuselogprivatedetails
Lihat rincian pribadi dari entri LogPenyalahgunaan.
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
Periksa nama pengguna dengan pemeriksaan normalisasi AntiPenipuan.
block
Blokir pengguna.
changeauthenticationdata
Change authentication data for the current user.
changecontentmodel
Ganti model konten sebuah halaman
checktoken
Check the validity of a token from action=query&meta=tokens.
clearhasmsg
Clears the hasmsg flag for the current user.
clientlogin
Log in to the wiki using the interactive flow.
compare
Dapatkan perbedaan antara dua halaman.
createaccount
Buat akun pengguna baru.
delete
Hapus halaman
discussiontoolsedit
Kirim pesan di halaman diskusi.
discussiontoolsfindcomment
Find a comment by its ID or name.
discussiontoolsgetsubscriptions
Mendapatkan status langganan untuk topik yang diberikan.
discussiontoolssubscribe
Berlangganan (atau batalkan langganan) untuk menerima notifikasi tentang sebuah topik.
discussiontoolsthank
Send a public thank-you notification for a comment.
echocreateevent
Manually trigger a notification to a user
echomarkread
Tandai pemberitahuan dari pengguna ini sebagai telah dibaca.
echomarkseen
Tandai pemberitahuan dari pengguna ini sebagai telah dibaca.
echomute
Bisukan atau suarakan pemberitahuan dari pengguna atau halaman tertentu.
edit
Buat dan sunting halaman.
emailuser
Kirim surel ke pengguna ini.
embedvideo
Get generated video embed code for given parameters.
expandtemplates
Longgarkan semua templat dalam teks wiki.
feedcontributions
Returns a user's contributions feed.
feedrecentchanges
Returns a recent changes feed.
feedwatchlist
Returns a watchlist feed.
filerevert
Revert a file to an old version.
help
Display help for the specified modules.
imagerotate
Rotate one or more images.
import
Import a page from another wiki, or from an XML file.
languagesearch
Search for language names in any script.
linkaccount
Link an account from a third-party provider to the current user.
login
Log in and get authentication cookies.
logout
Keluar log dan hapus data sesi.
managetags
Perform management tasks relating to change tags.
mergehistory
Merge page histories.
moderation
Performs moderation-related action like Approve or Reject.
move
Memindahkan halaman.
opensearch
Search the wiki using the OpenSearch protocol.
options
Change preferences of the current user.
paraminfo
Obtain information about API modules.
parse
Parses content and returns parser output.
patrol
Patrol a page or revision.
protect
Change the protection level of a page.
purge
Purge the cache for the given titles.
query
Fetch data from and about MediaWiki.
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
Send a password reset email to a user.
revisiondelete
Delete and undelete revisions.
rollback
Undo the last edit to the page.
rsd
Export an RSD (Really Simple Discovery) schema.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Change the language of a page.
spamblacklist
Validate one or more URLs against the spam block list.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
Mengambil data yang disimpan oleh ekstensi DataTemplat.
thank
Kirim pemberitahuan terima kasih publik kepada seorang penyunting.
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
unblock
Unblock a user.
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
Add or remove pages from the current user's watchlist.
webapp-manifest
Returns a webapp manifest.
categorytree
Internal. Modul internal untuk ekstensi CategoryTree.
cspreport
Internal. 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.
discussiontoolscompare
Internal. Mendapatkan informasi tentang perubahan komentar antara dua revisi halaman.
discussiontoolspageinfo
Internal. Dapatkan metadata yang diperlukan untuk menginisialisasi perkakas diskusi.
discussiontoolspreview
Internal. Preview a message on a discussion page.
editcheckreferenceurl
Internal. Check the status of a URL for use as a reference.
scribunto-console
Internal. Internal module for servicing XHR requests from the Scribunto console.
stashedit
Internal. Prepare an edit in shared cache.
visualeditor
Internal. Mengembalikan HTML5 untuk halaman dari layanan Parsoid.
visualeditoredit
Internal. Simpan halaman HTML5 ke MediaWiki (dikonversi menjadi teks wiki melalui layanan Parsoid).
One of the following values: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, languagesearch, linkaccount, login, logout, managetags, mergehistory, moderation, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, spamblacklist, tag, templatedata, thank, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, categorytree, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, scribunto-console, stashedit, visualeditor, visualeditoredit
Default: help
format

Format keluaran.

json
Output data in JSON format.
jsonfm
Output data in JSON format (pretty-print in HTML).
none
Output nothing.
php
Output data in serialized PHP format.
phpfm
Output data in serialized PHP format (pretty-print in HTML).
rawfm
Output data, including debugging elements, in JSON format (pretty-print in HTML).
xml
Output data in XML format.
xmlfm
Output data in XML format (pretty-print in HTML).
One of the following values: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Default: jsonfm
maxlag

Sendat maksimum dapat digunakan saat MediaWiki dipasang pada gugus replikasi pangkalan data. Untuk menghemat tindakan yang menyebabkan sendat replikasi situs lebih lanjut, parameter ini dapat membuat kelayan menunggu hingga sendat replikasi kurang dari nilai yang diperinci. Jika terjadi sendat berlebihan, kode galat maxlag akan dikembalikan dengan pesan seperti Menunggu detik $host: $lag disendat/samp>.
Lihat Panduan: Parameter Maxlag untuk informasi lebih.

Type: integer
smaxage

Mengatur pengepala kendali tembolok HTTP s-maxage ke jumlah detik ini. Galat tidak akan pernah ditembolokkan.

Type: integer
The value must be no less than 0.
Default: 0
maxage

Mengatur pengepala kendali tembolok HTTP max-age ke jumlah detik ini. Galat tidak akan pernah ditembolokkan.

Type: integer
The value must be no less than 0.
Default: 0
assert

Pastikan bahwa si pengguna sedang masuk log (termasuk kemungkinan sebagai pengguna sementara) bila diatur ke pengguna, tidak masuk log bila diatur ke anon, atau telah punya hak pengguna bot bila itu bot.

One of the following values: anon, bot, user
assertuser

Verifikasi bahwa pengguna saat ini adalah pengguna yang disebutkan namanya.

Tipe: pengguna, dengan salah satu dari nama pengguna dan Pengguna sementara
requestid

Nilai apa pun yang diberikan di sini akan disertakan dalam tanggapan. Bisa saja digunakan untuk membedakan permintaan.

servedby

Menyertakan nama inang yang melayani permintaan dalam hasil.

Type: boolean (details)
curtimestamp

Menyertakan stempel waktu saat ini dalam hasil.

Type: boolean (details)
responselanginfo

Menyertakan bahasa yang digunakan untuk uselang dan errorlang dalam hasil.

Type: boolean (details)
origin

Saat mengakses API menggunakan permintaan AJAX lintas domain (CORS), atur ini ke domain asal. Ini harus disertakan dalam setiap permintaan pra-penerbangan, dan oleh karena itu harus menjadi bagian dari URI permintaan (bukan tubuh POST).

Untuk permintaan terautentikasi, ini harus mencocoki salah satu asal dalam pengepala Origin, jadi harus diatur ke sesuatu seperti https://en.wikipedia.org atau https://meta.wikimedia.org. Jika parameter ini tidak mencocoki pengepala Origin, tanggapan 403 akan dikembalikan. Jika parameter ini sesuai dengan pengepala Origin dan asalnya diizinkan, pengepala Access-Control-Allow-Origin dan Access-Control-Allow-Credentials akan diatur.

Untuk permintaan yang tak terautentikasi, perincikan nilai *. Ini akan menyebabkan pengepala Access-Control-Allow-Origin diatur, tetapi Access-Control-Allow-Credentials akan menjadi false dan semua data khusus pengguna akan dibatasi.

crossorigin

Saat mengakses API menggunakan permintaan AJAX lintas domain (CORS) dan menggunakan penyedia sesi yang aman terhadap serangan pemalsuan permintaan lintas situs (CSRF) (seperti OAuth), gunakan ini alih-alih origin=* untuk membuat permintaan terautentikasi (yaitu, tidak keluar log). Ini harus disertakan dalam setiap permintaan pra-penerbangan, dan oleh karena itu harus menjadi bagian dari URI permintaan (bukan tubuh POST).

Perhatikan bahwa sebagian besar penyedia sesi, termasuk sesi berbasis kuki baku, tidak mendukung CORS terautentikasi dan tidak dapat digunakan dengan parameter ini.

Type: boolean (details)
uselang

Bahasa yang akan digunakan untuk terjemahan pesan. action=query&meta=siteinfo&siprop=languages mengembalikan daftar kode bahasa. Anda bisa memperinci user untuk menggunakan preferensi bahasa pengguna saat ini atau content untuk menggunakan bahasa konten wiki ini.

Default: user
variant

Varian dari bahasa. Hanya berfungsi bila bahasa dasarnya mendukung percakapan varian.

errorformat

Format untuk digunakan untuk peringatan dan keluaran teks galat

plaintext
Teks wiki dengan tag HTML tercopot dan entitas terganti.
wikitext
Teks wiki yang tak diurai.
html
HTML
raw
Kunci pesan dan parameter.
none
Tidak ada keluaran teks, hanya kode galat.
bc
Format yang digunakan sebelum MediaWiki 1.29. errorlang dan errorsuselocal diabaikan.
One of the following values: bc, html, none, plaintext, raw, wikitext
Default: bc
errorlang

Bahasa yang digunakan untuk peringatan dan galat. action=query&meta=siteinfo&siprop=languages mengembalikan daftar kode bahasa. Perincikan content untuk menggunakan bahasa konten wiki ini atau uselang untuk menggunakan nilai yang sama dengan parameter uselang.

Default: uselang
errorsuselocal

Bila diberikan, teks galat akan menggunakan pesan yang tersesuaikan secara lokal dari ruangnama {{ns

MediaWiki}}.
Type: boolean (details)
Examples:
Help for the main module.
api.php?action=help [open in sandbox]
Semua bantuan dalam satu halaman.
api.php?action=help&recursivesubmodules=1&toc [open in sandbox]

Credits

API developers:

  • Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
  • Roan Kattouw (lead developer Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (lead developer 2013–2020)

Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org or file a bug report at https://phabricator.wikimedia.org/.