رہنمائے میڈیاویکی اےپی‌آئی

ذیل میں میڈیاویکی اےپی‌آئی کی دستاویزی تفصیلات درج ہیں جو خودکار طور پر لکھی گئی ہیں۔

دستاویز اور مثالوں کے لیے ملاحظہ فرمائیں: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

اصل ماڈیول

کیفیت: میڈیاویکی اےپی‌آئی ایک مکمل اور مستحکم انٹرفیس ہے جس میں اصلاح و تحسین کا عمل مستقل جاری رہتا ہے۔ گو کہ ہم ایسی کسی تبدیلی سے گریز کرتے ہیں جس سے سارا نظام شکستہ اور ٹوٹ پھوٹ کا شکار ہو جائے لیکن بعض اوقات اس کے بغیر چارہ نہیں ہوتا؛ چنانچہ ان تبدیلیوں کی بروقت اطلاع پانے کے لیے mediawiki-api-announce نامی فہرست میں اپنا نام درج کر دیں۔

غلط درخواستیں: جب اےپی‌آئی کو غلط درخواستیں بھیجی جاتی ہیں تو «MediaWiki-API-Error» کی کلید کے ساتھ ایک ایچ‌ٹی‌ٹی‌پی سرنامہ روانہ کیا جاتا ہے، اور بعد ازاں ان دونوں کو یعنی سرنامہ کی قدر اور نقص کوڈ کو یکساں قدر دے دی جاتی ہے۔ مزید معلومات کے لیے API: Errors and warnings ملاحظہ فرمائیں۔

مخصوص پیرامیٹر:
action

جونسا کام مطلوب ہو۔

abusefiltercheckmatch
اس بات کو جانچتا ہے کہ آیا مقطر غلط کاری کسی ترمیم، کسی نوشتہ یا متغیرات کے مجموعہ سے مطابقت رکھتا ہے یا نہیں۔
abusefilterchecksyntax
مقطر غلط کاری کے مقطر کی ترکیب جانچتا ہے۔
abusefilterevalexpression
مقطر غلط کاری کے اظہار کو جانچتا ہے۔
abusefilterunblockautopromote
مقطر غلط کاری کے نتیجہ میں خودکار ترقی سے صارف کی پابندی ختم کرتا ہے۔
abuselogprivatedetails
ناشتہ غلط کاری کے اندراج کی نجی تفصیلات کو دیکھتا ہے۔
acquiretempusername
اگر عارضی کھاتے کی تخلیق فعال ہو اور موجودہ صارف داخل نہ تو کسی عارضی صارف کا صارف نام اخذ کر کے اسے موجودہ نشست میں رکھ دیتا ہے۔ اگر وہ نام پہلے سے ہی رکھا جا چکا ہے تو جواب میں وہ نام لوٹا دیا جائے گا۔
antispoof
فریب مخالف (AntiSpoof) کی معمول کی جانچ کے برخلاف صارف کا نام جانچتا ہے۔
block
صارف پر پابندی عائد کرتا ہے۔
centralauthtoken
منسلک ویکی کو مصدقہ درخواست بھیجنے کے لیے centralauthtoken اخذ کرتا ہے۔
centralnoticecdncacheupdatebanner
درخواست کردہ اعلان اور زبان کے لیے گمنام صارفین کے لیے سی ڈی این (فرنٹ اینڈ) کے کیش میں محفوظ اعلان کے مندرجات کو صاف کرنے کی درخواست بھیجتا ہے۔
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
ترجمۂ مواد کی توسیع کی مدد سے لکھے جانے والے تراجم کے مسودہ کو حذف کرتا ہے۔
cxsuggestionlist
تجاویز کی فہرستوں کا نظم کرتا ہے۔ فہرستوں میں تجاویز شامل کرتا ہے اور انھیں ہٹاتا ہے۔
cxtoken
cxserver سے تصدیق پانے کے لیے JWT کے ٹوکن حاصل کرتا ہے۔
delete
صفحہ حذف کرتا ہے۔
deleteglobalaccount
عالمی صارف کو حذف کرتا ہے۔
discussiontoolsedit
تبادلۂ خیال صفحہ پر پیغام بھیجتا ہے۔
discussiontoolsfindcomment
شناختی نمبر یا نام کی مدد سے تبصرہ تلاش کرتا ہے۔
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
فائل کو پرانے نسخے کی جانب لوٹاتا ہے۔
flow
مرتب گفتگو کے صفحات پر کارروائیاں کرنے کی اجازت دیتا ہے۔
flow-parsoid-utils
ویکی متن کو ایچ ٹی ایم ایل میں اور ایچ ٹی ایم ایل کو ویکی متن میں تبدیل کرتا ہے۔
flowthank
فلو تبصرے پر شکریہ کا عمومی اطلاع نامہ بھیجتا ہے۔
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
اوپن سرچ پروٹوکول کا استعمال کرتے ہوئے ویکی ویب گاہ میں تلاش کرتا ہے۔
options
موجودہ صارف کی ترجیحات تبدیل کرتا ہے۔
paraminfo
متعدد اےپی آئی ماڈیول کے بارے میں معلومات حاصل کرتا ہے۔
parse
مندرجات کا تجزیہ کرکے نتائج واپس بھیجتا ہے۔
patrol
صفحہ یا صفحہ کے نسخہ کی مراجعت کرتا ہے۔
protect
صفحہ کے درجۂ حفاظت کو تبدیل کرتا ہے۔
purge
دیے گئے عناوین کے کیش صاف کرتا ہے۔
query
میڈیاویکی سے اور میڈیاویکی کے متعلق معلومات اخذ کرتا ہے۔
removeauthenticationdata
موجودہ صارف کی تصدیق و توثیق کی تفصیلات کو حذف کرتا ہے۔
resetpassword
صارف کو پاس ورڈ دوبارہ مرتب کرنے کے لیے برقی ڈاک بھیجتا ہے۔
revisiondelete
نسخوں کو حذف یا بحال کرتا ہے۔
rollback
صفحہ کی آخری ترمیم کو رد کرتا ہے۔
rsd
RSD خاکہ کو برآمد کرتا ہے۔
setglobalaccountstatus
عالمی صارف کھاتے کو مخفی یا مقفل کرتا ہے (اور ظاہر یا غیر مقفل کرتا ہے)۔
setnotificationtimestamp
زیر نظر صفحات کے اطلاع نامہ کے وقت و تاریخ کو تازہ کرتا ہے۔
setpagelanguage
صفحہ کی زبان تبدیل کرتا ہے۔
shortenurl
طویل یوآرایل کو مختصر کرتا ہے۔
sitematrix
ویکیمیڈیا کی ویب گاہوں کی فہرست حاصل کرتا ہے۔
spamblacklist
فاضل کاری کی فہرست سیاہ کے خلاف ایک یا ایک سے زائد یوآرایل کی توثیق کریں۔
streamconfigs
ایونٹ اسٹریم کی ترتیبات کو پیش کرتا ہے۔ یہ جواب میں formatversion=2 کے ساتھ فقط format=json کو لوٹاتا ہے۔
strikevote
منتظمین کو کسی رائے کے شمار کرنے یا اسے کالعدم کرنے کی اجازت دیتا ہے۔
sxdelete
ڈیٹابیس سے قطعہ کے ترجمہ کے مسودہ کو اور اس کے متوازی مجموعہ کو حذف کرتا ہے۔
tag
انفرادی نوشتوں یا نوشتہ کے اندراجات سے تبدیلی کے ٹیگوں کو ہٹاتا یا ان میں ٹیگوں کو شامل کرتا ہے۔
templatedata
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
Users with the 'transcode-reset' right can reset and re-run a transcode job.
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.
webauthn
API Module to communicate between server and client during registration/authentication process.
wikilove
Give WikiLove to another user.
bouncehandler
داخلی۔ Receive a bounce email and process it to handle the failing recipient.
categorytree
داخلی۔ Internal module for the CategoryTree extension.
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
داخلی۔ 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
داخلی۔ Check if any fast, unreviewed translation has been published recently for the current user.
cxpublish
داخلی۔ Save a page created using the Content Translation extension.
cxpublishsection
داخلی۔ Save a section created using the Content Translation extension's section translation feature.
cxsave
داخلی۔ This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.
cxsplit
داخلی۔ Create and save a section translation to database, for every translated section of the given article translation
discussiontoolscompare
داخلی۔ صفحے کے دو نسخوں کے ما بین تبصروں کی تبدیلی کے متعلق معلومات حاصل کرتا ہے۔
discussiontoolspageinfo
داخلی۔ جواب میں آلات گفتگو کو شروع کرنے کے لیے درکار میٹا ڈیٹا بھیجتا ہے۔
discussiontoolspreview
داخلی۔ تبادلۂ خیال صفحہ پر پیغام کی نمائش دکھاتا ہے۔
echopushsubscriptions
داخلی۔ Manage push subscriptions for the current user.
editcheckreferenceurl
داخلی۔ Check the status of a URL for use as a reference.
fancycaptchareload
داخلی۔ Get a new FancyCaptcha.
growthinvalidateimagerecommendation
داخلی۔ Invalidate an image recommendation.
growthinvalidatepersonalizedpraisesuggestion
داخلی۔ Invalidates a suggestion of a praiseworthy mentee in the Personalized praise module on the Mentor dashboard
helppanelquestionposter
داخلی۔ Handle questions posted via the help panel for the current user.
jsondata
داخلی۔ Retrieve localized JSON data.
oathvalidate
داخلی۔ Validate a two-factor authentication (OATH) token.
parser-migration
داخلی۔ دو مختلف ترتیبات کی مدد سے صفحہ کا تجزیہ کرتا ہے۔
readinglists
داخلی۔ تحریری کارروائیوں کی فہرست کو پڑھتا ہے۔
sanitize-mapdata
داخلی۔ Performs data validation for Kartographer extension
scribunto-console
داخلی۔ Internal module for servicing XHR requests from the Scribunto console.
securepollauth
داخلی۔ Allows a remote wiki to authenticate users before granting access to vote in the election.
stashedit
داخلی۔ Prepare an edit in shared cache.
sxsave
داخلی۔ Save the draft section translation and store the parallel corpora
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
داخلی۔ Returns HTML5 for a page from the Parsoid service.
visualeditoredit
داخلی۔ Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
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، flow-parsoid-utils، flow، flowthank، 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، revisiondelete، rollback، rsd، setglobalaccountstatus، setnotificationtimestamp، setpagelanguage، shortenurl، sitematrix، spamblacklist، 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 شکل میں دیتا ہے (ایچ ٹی ایم ایل کے خوب صورت انداز میں)
none
کوئی معلومات نہیں دیتا۔
php
ڈیٹا کو سیریلائزڈ پی ایچ پی فارمیٹ میں دیتا ہے۔
phpfm
ڈیٹا کو سیریلائزڈ پی ایچ پی فارمیٹ میں دیتا ہے (ایچ ٹی ایم ایل کے خوب صورت انداز میں)۔
rawfm
ڈیٹا کو JSON شکل میں دیتا ہے جس میں غلطیوں کی اصلاح کے عناصر بھی شامل ہوتے ہیں (ایچ ٹی ایم ایل کے خوب صورت انداز میں)۔
xml
ڈیٹا کو XML شکل میں دیتا ہے۔
xmlfm
ڈیٹا کو XML شکل میں دیتا ہے (ایچ ٹی ایم ایل کے خوب صورت انداز میں)۔
ذیل کی قدروں میں سے کوئی ایک: json، jsonfm، none، php، phpfm، rawfm، xml، xmlfm
طے شدہ: jsonfm
maxlag

جب ڈیٹابیس ریپلی کیٹڈ سروَر پر میڈیاویکی نصب ہو تو بغایت تاخیر (Maximum lag) کو استعمال کیا جا سکتا ہے۔ سائٹ ریپلی کیشن میں مزید تاخیر کا سبب بننے والے اقدامات کو محفوظ کرنے کے لیے یہ پیرامیٹر کلائنٹ کو تب تک منتظر رکھ سکتا ہے جب تک ریپلی کیشن کی تاخیر متعینہ قدر سے کم ہو۔ حد سے زیادہ تاخیر کی صورت میں maxlag کا نقص Waiting for $host: $lag seconds lagged جیسے پیغام کے ساتھ نظر آئے گا۔
مزید تفصیلات کے لیے Manual: Maxlag parameter سے رجوع کریں۔

Type: integer
smaxage

s-maxage کے ایچ ٹی ٹی پی کیش کنٹرول سرنامہ کو سیکنڈ کی اس تعداد پر رکھیں۔ غلطیاں کبھی محفوظ نہیں ہوتیں۔

Type: integer
The value must be no less than 0.
طے شدہ: 0
maxage

max-age کے ایچ ٹی ٹی پی کیش کنٹرول سرنامہ کو سیکنڈ کی اس تعداد پر رکھیں۔ غلطیاں کبھی محفوظ نہیں ہوتیں۔

Type: integer
The value must be no less than 0.
طے شدہ: 0
assert

اگر user ہو تو صارف کے داخل ہونے کی، anon درج کرنے کی صورت میں صارف کے داخل نہ ہونے کی اور bot دیے جانے کی صورت میں خودکار صارف کے اختیارات کے حامل ہونے کی تصدیق کرتا ہے۔

ذیل کی قدروں میں سے کوئی ایک: anon، bot، user
assertuser

تصدیق کرتا ہے کہ موجودہ صارف ہی وہ صارف ہے جس کا نام درج کیا گیا ہے۔

طرز: صارف، بذریعہ صارف نام اور عارضی صارف
requestid

یہاں دی گئی کوئی بھی قدر جواب میں شامل کی جائے گی۔ درخواستوں میں فرق کرنے کے لیے اسے استعمال کیا جا سکتا ہے۔

servedby

نتائج میں اس ہوسٹ کا نام شامل کرتا ہے جس نے درخواست کی تکمیل کی۔

طرز: بولین (تفصیلات)
curtimestamp

نتیجہ میں وقت و تاریخ کی موجودہ مہر شامل کرتا ہے۔

طرز: بولین (تفصیلات)
responselanginfo

نتیجہ میں uselang اور errorlang کے لیے استعمال ہونے والی زبانیں شامل کرتا ہے۔

طرز: بولین (تفصیلات)
origin

کراس ڈومین اجیکس رکویسٹ (CORS) کی مدد سے اےپی‌آئی تک پہنچنا ہو تو اس پیرامیٹر میں اصل ڈومین فراہم کریں۔ کسی بھی pre-flight درخواست میں اس کی شمولیت لازمی ہے اور اسی بنا پر اسے یوآرآئی درخواست کا جز ہونا چاہیے (POST کا نہیں)۔

جہاں تک تصدیق شدہ درخواستوں کا معاملہ ہے، ان میں بھی Origin سرنامہ میں موجود مصادر میں سے کسی ایک کے مطابق اس پیرامیٹر کا ہونا لازمی ہے۔ لہذا اسے کچھ یوں https://ur.wikipedia.org یا https://meta.wikimedia.org رکھیں۔ اگر یہ پیرامیٹر 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
ویکی متن جس میں ایچ ٹی ایم ایل کے ٹیگ کو حذف اور موجودات کو بدل دیا جاتا ہے۔
wikitext
غیر تجزیہ شدہ ویکی متن۔
html
HTML
raw
پیغام کی کلید اور پیرامیٹر۔
none
کوئی عبارت نہیں، فقط نقائص کے کوڈ۔
bc
میڈیاویکی کے نسخہ 1.29 سے قبل استعمال ہونے والا فارمیٹ۔ errorlang اور errorsuselocal کو نظر انداز کر دیا جاتا ہے۔
ذیل کی قدروں میں سے کوئی ایک: bc، html، none، plaintext، raw، wikitext
طے شدہ: bc
errorlang

انتباہات اور نقائص کے لیے استعمال کی جانے والی زبان۔ action=query&meta=siteinfo&siprop=languages جواب میں زبانوں کے رموز کی فہرست بھیجتا ہے۔ پیش نظر ویکی کے مندرجات کی زبان استعمال کرنے کے لیے content کا، یا uselang پیرامیٹر کی طرح یکساں قدر استعمال کرنے کے لیے uselang کا استعمال کریں۔

طے شدہ: uselang
errorsuselocal

اسے درج کرنے کی صورت میں نقص کی عبارتیں میڈیاویکی نام فضا میں موجود مقامی زبانوں میں نظر آئیں گی۔

طرز: بولین (تفصیلات)
centralauthtoken

کراس ڈومین اجیکس رکویسٹ (CORS) کی مدد سے اےپی‌آئی تک پہنچنا ہو تو توثیق کے لیے اس پیرامیٹر کو حالیہ SUL صارف کی حیثیت سے استعمال کریں۔ نیز CORS کی درخواست بھیجنے سے قبل ٹوکن اخذ کرنے کے لیے اس ویکی پر action=centralauthtoken کا استعمال کریں۔ خیال رہے کہ ان تمام ٹوکنوں کو فقط ایک دفعہ استعمال کیا جا سکتا ہے اور دس سکنڈ میں ان کی میعاد تمام ہو جاتی ہے۔ کسی بھی pre-flight درخواست میں اس پیرامیٹر کی شمولیت لازمی ہے اور اسی بنا پر اسے یوآرآئی درخواست کا جز ہونا چاہیے (POST کا نہیں)۔

مثالیں
اصل ماڈیول کی رہنما تفصیلات۔
api.php?action=help [تختۂ مشق میں کھولیں]
ایک صفحہ میں تمام رہنمائیاں۔
api.php?action=help&recursivesubmodules=1 [تختۂ مشق میں کھولیں]
اجازت:
writeapi
اے پی آئی تحریر کا استعمال
معطیٰ لہ: all، user اور bot
apihighlimits
اےپی آئی استفسارات میں اعلیٰ حدود کا استعمال کریں (سست استفسارات: 500؛ تیز استفسارات: 5000)۔ سست استفسارات کے حدود کا اطلاق متعدد قدروں کے حامل پیرامیٹر پر بھی ہو سکتا ہے۔
معطیٰ لہ: bot اور sysop

ڈیٹا کی اقسام

میڈیاویکی کو دیا جانے والا اِن پٹ NFC-normalized UTF-8 کی شکل میں ہونا چاہیے۔ گرچہ میڈیاویکی دوسرے اقسام کے اِن پٹ کو مطلوبہ شکل میں تبدیل کر سکتا ہے لیکن اس عمل کی بدولت (مثلاً ترامیم مع MD5 checks جیسی) بعض کارروائیوں کی ناکامی کا امکان ہے۔

ایک پیرامیٹر کی کئی قدریں درج کرنی ہوں تو بالعموم انھیں پائپ کی علامت کے ساتھ لکھا جاتا ہے، مثلاً param=value1|value2 یا param=value1%7Cvalue2۔ اگر کسی قدر میں پائپ کی علامت لگانا ضروری ہو تو انھیں باہم ممتاز رکھنے کے لیے U+001F کا استعمال کریں اور قدر سے قبل U+001F درج کریں۔ مثلاً param=%1Fvalue1%1Fvalue2۔

boolean

بولین پیرامیٹر ایچ ٹی ایم ایل چیک باکس کی طرح کام کرتے ہیں۔ چنانچہ قدر سے قطع نظر، اگر پیرامیٹر لکھا جائے تو true ہوگا۔ اگر false مطلوب ہو تو پیرامیٹر کو مکمل طور پر حذف کر دیں۔

expiry

میعاد کے خاتمہ کی جانب اشارہ کرنے والی قدریں اضافی (مثلاً 5 months یا 2 weeks) اور مطلق (مثلاً 2014-09-18T12:34:56Z) دونوں طرح ہو سکتی ہیں۔ جس کی میعاد کبھی ختم نہ ہو، اس کے لیے infinite، indefinite، infinity یا never استعمال کریں۔

timestamp

تاریخوں اور اوقات کو مختلف شکلوں میں لکھا جا سکتا ہے۔ مزید تفصیلات کے لیے میڈیاویکی کے اس صفحہ سے رجوع کریں۔ تاہم ISO 8601 کی تاریخ اور وقت کا استعمال بہتر ہوگا: 2001-01-15T14:56:00Z نیز موجودہ وقت و تاریخ کو درج کرنے کے لیے now کا استعمال بھی جا سکتا ہے۔

سانچے کے پیرامیٹر

سانچوں کے پیرامیٹر ان صورتوں کی بھی مدد کرتے ہیں جب اےپی آئی ماڈیول کو کسی دوسرے پیرامیٹر کی ہر قدر کے لیے کسی منفرد قدر کی ضرورت ہو۔ مثلاً پھلوں کی درخواست کے لیے کوئی اےپی آئی ماڈیول موجود ہو تو اس میں fruits نامی پیرامیٹر ہو سکتا ہے تاکہ پھلوں کا نام اور قسم وغیرہ کا تعین کیا جا سکے، نیز {fruit}-quantity پیرامیٹر بھی ہوگا تاکہ درخواست میں پھلوں کی مقدار بھی بتائی جا سکے۔ اس صورت میں اےپی آئی کلائنٹ جسے 1 سیب، 5 کیلے اور 20 اسٹرابیری درکار ہو، کچھ اس طرز پر اپنی درخواست بھیج سکتا ہے: fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20

اعتراف نامہ

اےپی‌آئی کے ترقی دہندگان:

  • یوری استراخان (تخلیق کار، نمایاں ڈویلپر ستمبر 2006ء تا ستمبر 2007ء)
  • روان کاتو (نمایاں ڈویلپر ستمبر 2007ء تا 2009ء)
  • وکٹر واسیلیف
  • بریان ٹونگ مینھ
  • سام ریڈ
  • بریڈ یورش (نمایاں ڈویلپر 2013ء تا 2020ء)

براہ کرم اپنے تبصروں، تاثرات، تجاویز اور سوالات mediawiki-api@lists.wikimedia.org پر روانہ کریں یا https://phabricator.wikimedia.org/ پر نقص کی اطلاع دیں۔