MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
پودمان اصلی
- منبع: MediaWiki
- License: GPL-2.0-or-later
وضعیت: تمام ویژگیهایی که در این صفحه نمایش یافتهاند باید کار بکنند، ولی رابط برنامهنویسی کاربردی کماکان در حال توسعه است، و ممکن است در هر زمان تغییر بکند. به عضویت فهرست پست الکترونیکی mediawiki-api-announce در بیایید تا از تغییرات باخبر شوید.
درخواستهای معیوب: وقتی درخواستهای معیوب به رابط برنامهنویسی کاربردی فرستاده شوند، یک سرایند اچتیتیپی با کلید «MediaWiki-API-Erorr» فرستاده میشود و بعد هم مقدار سرایند و هم کد خطای بازگردانده شده هر دو به یک مقدار نسبت داده میشوند. برای اطلاعات بیشتر API: Errors and warnings را ببینید.
آزمایش: برای انجام درخواستهای API آزمایشی Special:ApiSandbox را ببینید.
- action
کدام عملیات را انجام دهد.
- block
- بستن کاربر
- changeauthenticationdata
- تغيير اطلاعات احراز هويت برای کاربر فعلی
- checktoken
- Check the validity of a token from action=query&meta=tokens.
- clearhasmsg
- پرچم
hasmsg
را برای کاربر جاری پاک کن. - clientlogin
- Log in to the wiki using the interactive flow.
- compare
- تفاوت بین ۲ صفحه را بیابید.
- createaccount
- ایجاد حساب کاربری
- 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.
- delete
- حذف صفحه
- edit
- ایجاد و ویرایش صفحه
- emailuser
- ایمیل به کاربر
- expandtemplates
- گسترش همه الگوها در ویکی نبشته
- feedcontributions
- خوراک مشارکتهای یک کاربر را برمیگرداند.
- feedrecentchanges
- خوراک تغییرات اخیر را برمیگرداند.
- feedwatchlist
- برگرداندن فهرست پیگیریهای خوراک.
- filerevert
- واگردانی فایل به یک نسخه قدیمی
- help
- راهنما برای پودمانهای مشخصشده را نمایش دهید.
- imagerotate
- چرخاندن یک یا چند تصویر
- import
- Import a page from another wiki, or from an XML file.
- 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.
- 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.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Change the language of a page.
- stashedit
- Prepare an edit in shared cache.
- tag
- Add or remove change tags from individual revisions or log entries.
- unblock
- بازکردن کاربر.
- undelete
- Restore 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
- tokens
- توصیه. Get tokens for data-modifying actions.
- One of the following values: block، changeauthenticationdata، checktoken، clearhasmsg، clientlogin، compare، createaccount، cspreport، 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، stashedit، tag، unblock، undelete، unlinkaccount، upload، userrights، validatepassword، watch، webapp-manifest، tokens
- پیشفرض: help
- format
فرمت خروجی.
- json
- Output data in JSON format.
- jsonfm
- Output data in JSON format (pretty-print in HTML).
- none
- بیرونریزی هیچ.
- 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
- پیشفرض: jsonfm
- maxlag
Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.- Type: integer
- smaxage
تنظيم
s-maxage
سرآیند کنترل حافضهٔ نهان HTTP بر اين تعداد ثانيه.- Type: integer
- پیشفرض: 0
- maxage
تنظيم
s-maxage
سرآیند کنترل حافضهٔ نهان HTTP بر اين تعداد ثانيه. خطاها هيچگاه در حافظهٔ نهان قرار نمیگيرند.- Type: integer
- پیشفرض: 0
- assert
Verify the user is logged in if set to user, or has the bot user right if bot.
- One of the following values: user، bot
- assertuser
Verify the current user is the named user.
- Type: user name
- 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
When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).
For authenticated requests, this must match one of the origins in the
Origin
header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match theOrigin
header, a 403 response will be returned. If this parameter matches theOrigin
header and the origin is whitelisted, theAccess-Control-Allow-Origin
andAccess-Control-Allow-Credentials
headers will be set.For non-authenticated requests, specify the value *. This will cause the
Access-Control-Allow-Origin
header to be set, butAccess-Control-Allow-Credentials
will befalse
and all user-specific data will be restricted.- uselang
Language to use for message translations. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify user to use the current user's language preference, or specify content to use this wiki's content language.
- پیشفرض: user
- errorformat
Format to use for warning and error text output.
- plaintext
- Wikitext with HTML tags removed and entities replaced.
- wikitext
- Unparsed wikitext.
- html
- HTML.
- raw
- Message key and parameters.
- none
- No text output, only the error codes.
- bc
- Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
- One of the following values: plaintext، wikitext، html، raw، none، bc
- پیشفرض: bc
- errorlang
Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify 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)
- راهنما برای پودمان اصلی
- api.php?action=help [open in sandbox]
- همهٔ راهنما در یک صفحه
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
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.
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.
- timestamp
- Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
- ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
- ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
- MediaWiki format, 20010115145600
- Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
- EXIF format, 2001:01:15 14:56:00
- RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
- RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
- C ctime format, Mon Jan 15 14:56:00 2001
- Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
- The string now
- alternative multiple-value separator
- 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.
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.
اعتبار
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–present)
Please send your comments, suggestions and questions to [email protected] or file a bug report at https://phabricator.wikimedia.org/.