راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی

عملیاتی که باید انجام شود. این پارامتر باید جهت سهولت استفاده در اشکال‌زدایی، تحلیل، و مسیریابی یا فیلتر کردن درخواست، به عنوان بخشی از URL درخواست (نه بدنهٔ POST) ارسال شود.

abusefiltercheckmatch

بررسی کنید تا ببینید پالایهٔ ویرایش با مجموعه‌ای از متغیرها، یک ویرایش، یا یک رویداد سیاههٔ پالایهٔ ویرایش کاربر مطابق است یا خیر.

abusefilterchecksyntax

نحو یک پالایهٔ ویرایش را بررسی کنید.

abusefilterevalexpression

یک عبارت پالایهٔ ویرایش را ارزشیابی می‌کند.

abusefilterunblockautopromote

باز کردن یک کاربر از ارتقاء خودکار بر پایهٔ نتیجهٔ پالایهٔ ویرایش.

abuselogprivatedetails

مشاهدهٔ جزئیات خصوصی یک مدخل سیاههٔ ویرایش.

acquiretempusername

دریافت یک نام کاربری برای کاربر موقت و ذخیرهٔ آن در نشست کنونی، در صورتی که ایجاد حساب موقت فعال باشد و کاربر کنونی از سامانه خارج شده باشد. اگر نامی از قبل ذخیره شده باشد، همان نام را بازمی‌گرداند.

antispoof

بررسی یک نام کاربری به وسیلهٔ آزمون‌های بهنجارسازی عبارات سردرگم‌کننده

block

بستن یک کاربر.

centralauthtoken

دریافت یک بلیط ورود متمرکز برای ارسال یک درخواست تأییدشده به یک ویکی متصل شده.

centralnoticecdncacheupdatebanner

درخواست پاک‌سازی محتوای بنر ذخیره‌شده در حافظۀ نهان CDN (پیشانه) برای کاربران ناشناس، برای بنر و زبان مورد درخواست

centralnoticechoicedata

Get data needed to choose a banner for a given project and language

centralnoticequerycampaign

Get all configuration settings for a campaign.

changeauthenticationdata

تغییر دادۀ اصالت‌سنجی برای کاربر کنونی

changecontentmodel

تغییر مدل محتوای یک صفحه

checktoken

بررسی اعتبار بلیط از action=query&meta=tokens.

clearhasmsg

پرچم hasmsg را برای کاربر جاری پاک کن.

clientlogin

ورود به ویکی با استفاده از گردش کار تعاملی.

communityconfigurationedit

Change the content of a configuration provider in Community configuration

compare

تفاوت بین ۲ صفحه را بیابید.

createaccount

ایجاد یک حساب تازه کاربری

createlocalaccount

ایجاد اجباری یک حساب محلی. حساب مرکزی باید موجود باشد.

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

واگردانی فایل به یک نسخه قدیمی

globalblock

بستن یا باز کردن یک کاربر به‌طور سراسری.

globalpreferenceoverrides

Change local overrides for global preferences for the current user.

globalpreferences

تغییر ترجیحات سراسری کاربر کنونی.

globaluserrights

افزودن/حذف یک حساب به/از یک گروه سراسری.

help

نمایش راهنمای پودمان‌های مشخص‌شده.

imagerotate

این پودمان غیرفعال شده است.

import

Import a page from another wiki, or from an XML file.

jsonconfig

Allows direct access to JsonConfig subsystem.

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

خروج به همراه پاک نمودن اطلاعات این نشست

managetags

Perform management tasks relating to change tags.

massmessage

فرستادن یک پیام به فهرستی از صفحه‌ها.

mergehistory

ادغام تاریخچه‌های صفحه

move

انتقال صفحه

opensearch

جستجو در ویکی بااستفاده از پروتکل اوپن‌سرچ.

options

تغییر ترجیحات کاربر جاری

paraminfo

Obtain information about API modules.

parse

Parses content and returns parser output.

patrol

گشت‌زنی یک صفحه یا نسخهٔ ویرایشی.

protect

تغییر سطح محافظت صفحه

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.

setglobalaccountstatus

تنظیم وضعیت یک حساب سراسری.

setnotificationtimestamp

Update the notification timestamp for watched pages.

setpagelanguage

Change the language of a page.

shortenurl

کوتاه کردن یک نشانی اینترنتی بلند به یک نشانی اینترنتی کوتاه

sitematrix

گرفتن فهرست وب‌گاه‌های ویکی‌مدیا

spamblacklist

Validate one or more URLs against the spam block list.

streamconfigs

Exposes event stream config. Returns only format=json with formatversion=2.

strikevote

اجازه می‌دهد که مدیران رأیی را خط بزنند یا از خط‌خوردگی به درش آورند.

tag

Add or remove change tags from individual revisions or log entries.

templatedata

واکشی داده‌های ذخیره‌شده توسط افزونهٔ الگوداده.

thank

پیام تشکری به یک ویرایشگر ارسال کنید.

titleblacklist

Validate a page title, filename, or username against the TitleBlacklist.

torblock

Check if an IP address is blocked as a Tor exit node.

transcodereset

کاربران با دسترسی 'فرارمزگردانی-بازنشانی' می‌توانند یک فرارمزگردانی را بازنشانی و مجدد اجرا کنند.

unblock

بازکردن کاربر.

undelete

احیای نسخه‌های یک صفحهٔ حذف‌شده.

unlinkaccount

Remove a linked third-party account from the current user.

upload

بارگذاری یک پرونده یا دریافت وضعیت بارگذاری‌های در انتظار.

userrights

تغییر گروهی که کاربر در آن عضو است.

validatepassword

Validate a password against the wiki's password policies.

watch

Add or remove pages from the current user's watchlist.

webapp-manifest

بازگشت بیانیهٔ اپلیکیشن وب

webauthn

API Module to communicate between server and client during registration/authentication process.

wikifunctions_run

Run a function call

wikilambda_fetch

Fetch the JSON model of ZObjects.

wikilove

فرستادن ویکی‌عشق به یک کاربر دیگر

abstractwiki_fetch_section

داخلی Request the currently available Abstract Wikipedia rendered fragments for the given topic Qid (Wikidata Item Id), section Qid, language Zid and date. Alternatively (and only with special rights), request the currently available rendered output of an array of fragments passed in the request, which can be different from the currently persisted version.

This request is never blocking. When any of the requested fragments is not ready, the returned value for that fragment will have a "pending" flag set to true.

The response is always guaranteed to return as many results as requested. For example, if the "fragments" param is empty and the requested section has N fragments, all N will be returned; similarly, if M fragments are requested in the "fragments" parameter, the respond will return M items.

abstractwiki_run_fragment

داخلی Render an Abstract Wikipedia content fragment for the given Wikidata Item Id, language Zid and date

bouncehandler

داخلی Receive a bounce email and process it to handle the failing recipient.

categorytree

داخلی پودمان داخلی برای افزونهٔ درخت رده

chartinfo

داخلی Retrieve current count of how many unique Chart page usages there are. Multiple uses of the same chart on the same page are considered a single use.

cirrus-check-sanity

داخلی Reports on the correctness of a range of page ids in the search index

cirrus-config-dump

داخلی دامپ تنظیمات سیروس‌سرچ

cirrus-profiles-dump

داخلی Dump of CirrusSearch profiles for this wiki.

cirrus-schema-dump

داخلی Dump of CirrusSearch schema (settings and mappings) for this wiki.

codemirror-validate

داخلی بررسی خطاهای اعتبارسنجی در محتوای داده‌شده

collection

داخلی API module for performing various operations on a wiki user's 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.

discussiontoolscompare

داخلی Get information about comment changes between two page revisions.

discussiontoolspageinfo

داخلی فرادادهٔ مورد نیاز برای راه‌اندازی ابزارهای گفت‌وگو را برمی‌گرداند

discussiontoolspreview

داخلی پیش‌نمایش یک پیام در یک صفحهٔ گفتگو

editcheckreferenceurl

داخلی Check the status of a URL for use as a reference.

fancycaptchareload

داخلی کپچای جدید دریافت کن.

jsondata

داخلی Retrieve localized JSON data.

jsontransform

داخلی Retrieve JSON data transformed by a Lua function.

parser-migration

داخلی تجزیه صفحه با دو تظیمات متفاوت

readinglists

داخلی Reading list write operations.

sanitize-mapdata

داخلی Performs data validation for Kartographer extension

scribunto-console

داخلی Internal module for servicing XHR requests from the Scribunto console.

securepollauth

داخلی به یک ویکی راه‌دور اجازه می‌دهد تا پیش از اعطای دسترسی برای رأی‌دادن در انتخابات، کاربران را تأیید هویت کند

stashedit

داخلی Prepare an edit in shared cache.

timedtext

داخلی Provides timed text content for usage by <track> elements

ulslocalization

داخلی Get the localization of ULS in the given language.

ulssetlang

داخلی Update user's preferred interface language.

visualeditor

داخلی HTML5 یک صفحه را از خدمت پارسوید برمی‌گرداند.

visualeditoredit

داخلی ذخیره صفحه HTML5 به مدیاویکی (تبدیل به متن ویکی با سرویس پارسوید)

wikifunctions_html_sanitiser

داخلی API to sanitise a string of HTML for user-facing display on Wikifunctions.org and client Wikimedia wikis.

wikilambda_edit

داخلی Create or edit a ZObject.

wikilambda_function_call

داخلی Invoke a function by calling the function-orchestrator

wikilambda_perform_test

داخلی Endpoint to query test results for a ZFunction. Accepts a ZFunction, a list of ZImplementations, and a list of ZTesters. Accepts either a list of ZIDs or the full ZObject for the function, implementations, or testers. Also accepts a key to utilize a back end cache or not.

wikilambda_supported_programming_languages

داخلی Retrieve the programming languages supported by the evaluator

wikimediaeventsblockededit

داخلی Log information about blocked edit attempts

wikimediaeventshcaptchaeditattempt

داخلی Log edit diff when hCaptcha challenge is shown but edit is incomplete

فرمت خروجی.

json

خروجی داده در قالب جی‌سان.

jsonfm

خروجی داده در قالب جی‌سان (چاپ زیبا در اچ‌تی‌ام‌ال).

none

بیرون‌ریزی هیچ.

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).

بیشینهٔ تأخیر زمانی می‌تواند استفاده شود که مدیاویکی روی یک خوشهٔ همگون‌سازی‌شدهٔ پایگاه داده نصب شده باشد. برای جلوگیری از این‌که اقدامات باعث تأخیر همگون‌سازی بیشتر در سایت شوند، این پارامتر می‌تواند کارخواه را تا زمانی که تأخیر همگون‌سازی کمتر از مقدار مشخص‌شده باشد، منتظر نگه دارد. در صورت تأخیر بیش از حد، کد خطای maxlag همراه با پیامی مانند Waiting for $host: $lag seconds lagged بازگردانده می‌شود.
برای اطلاعات بیشتر، راهنما: پارامتر Maxlag را ببینید.

تنظيم s-maxage سرآیند کنترل حافضهٔ نهان HTTP بر اين تعداد ثانيه‌ها. خطاها هرگز در حافظه نهان نمی‌شوند.

تنظيم s-maxage سرآیند کنترل حافضهٔ نهان HTTP بر اين تعداد ثانيه‌ها. خطاها هرگز در حافظه نهان نمی‌شوند.

بررسی اینکه اگر روی user تنظیم شده باشد، کاربر وارد شده باشد (از جمله احتمالاً به عنوان کاربر موقت)، اگر روی anon تنظیم شده باشد، وارد نشده باشد، یا اگر روی bot باشد، اختیارات کاربر ربات را داشته باشد.

تأیید این که کاربر کنونی همان کاربر نام‌دار است.

هر مقداری که در اینجا وارد شود در پاسخ گنجانده می‌شود. ممکن است برای تمايز بين درخواست‌ها بکار رود.

نام ميزبانی که درخواست را سرويس داده در نتايج گنجانده شود.

برچسب زمان کنونی را در نتیجه قرار دهید.

گنجاندن زبان مورد استفاده برای userlang و errorlang در نتیجه.

هنگام دسترسی به API با استفاده از درخواست AJAX فرادامنه‌ای (CORS)، این مقدار را روی دامنهٔ مبدأ تنظیم کنید. این پارامتر باید در هر درخواست پیش‌پرواز (pre-flight) گنجانده شود، و بنابراین باید بخشی از URL درخواست باشد (نه بدنهٔ POST).

برای درخواست‌های احرازهویت‌شده، این مقدار باید دقیقاً با یکی از مبدأها در سرآیند Origin مطابقت داشته باشد، بنابراین باید روی چیزی مانند https://en.wikipedia.org یا https://meta.wikimedia.org تنظیم شود. اگر این پارامتر با سرآیند Origin مطابقت نداشته باشد، پاسخ ۴۰۳ بازگردانده خواهد شد. اگر این پارامتر با سرآیند Origin مطابقت داشته باشد و مبدأ مجاز باشد، سرآیندهای Access-Control-Allow-Origin و Access-Control-Allow-Credentials تنظیم خواهند شد.

برای درخواست‌های احرازهویت‌نشده، مقدار * را مشخص کنید. این کار باعث تنظیم سرآیند Access-Control-Allow-Origin می‌شود، اما مقدار Access-Control-Allow-Credentials برابر با false خواهد بود و تمامی داده‌های اختصاصی کاربر محدود خواهند شد.

هنگام دسترسی به API با استفاده از درخواست AJAX فرادامنه‌ای (CORS) و استفاده از ارائه‌دهندهٔ نشستی که در برابر حملات جعل درخواست بین‌سایتی (CSRF) ایمن است (مانند OAuth)، از این به جای origin=* استفاده کنید تا درخواست احرازهویت‌شده انجام شود (یعنی از سامانه خارج نشود). این پارامتر باید در هر درخواست پیش‌پرواز (pre-flight) گنجانده شود، و بنابراین باید بخشی از URL درخواست باشد (نه بدنهٔ POST).

توجه داشته باشید که بیشتر ارائه‌دهندگان نشست، از جمله نشست‌های استاندارد مبتنی بر کوکی، از CORS احرازهویت‌شده پشتیبانی نمی‌کنند و نمی‌توان از آن‌ها با این پارامتر استفاده کرد.

زبانی که برای ترجمهٔ پیام‌ها استفاده می‌شود. action=query&meta=siteinfo&siprop=languages فهرستی از کدهای زبان را بازمی‌گرداند. می‌توانید user را برای استفاده از ترجیح زبان کاربر کنونی یا content را برای استفاده از زبان محتوای این ویکی مشخص کنید.

گونهٔ زبان. تنها در صورتی کار می‌کند که زبان مبنا از تبدیل گونه پشتیبانی کند.

قالبی به‌منظور استفاده برای متن خروجی هشدار و خطا

plaintext

ویکی‌متن با برچسب‌های اچ‌تی‌ام‌ال حذف‌شده و موجودیت‌های جایگزین‌شده.

wikitext

ویکی‌متن تجزیه‌نشده.

html

HTML

raw

کلید پیام و پارامترها.

none

بدون متن خروجی، فقط شناسه‌های خطا.

bc

قالب مورد استفاده تا پیش از مدیاویکی ۱.۲۹. از errorlang و errorsuselocal چشم‌پوشی می‌شود.

زبانی که برای هشدارها و خطاها استفاده می‌شود. action=query&meta=siteinfo&siprop=languages فهرستی از کدهای زبان را بازمی‌گرداند. content را برای استفاده از زبان محتوای این ویکی یا uselang را برای استفاده از همان مقدار پارامتر uselang مشخص کنید.

در صورت وارد شدن، متن خطاها از پیام‌های سفارشی‌سازی‌شدهٔ محلی از فضای نام مدیاویکی استفاده خواهند کرد.

When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after ۶۰ seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).

On this wiki the expected value is a JSON Web Token, which may be validated by proxy servers in front of MediaWiki. If the token has expired or is otherwise invalid, you may receive a HTTP error from a proxy in a different format than a normal API error.