API:Tutorial/bn

এই টিউটোরিয়ালে, আপনি MediaWiki Action API সম্পর্কে শিখবেন, এটি কীভাবে ব্যবহার করবেন, অনুরোধ বিন্যাস, একটি সাধারণ প্রশ্ন, এবং Action API ব্যবহার করে প্রজেক্টের উদাহরণ।

Toolforge-এ ডেমো অ্যাপ ব্রাউজ করুন

মিডিয়াউইকি Action API-র ওভারভিউ
মিডিয়াউইকি Action API হল একটি RESTপূর্ণ web service যা ব্যবহারকারীদের কিছু উইকি-ক্রিয়া সম্পাদন করতে দেয় যেমন পৃষ্ঠা তৈরি, প্রমাণীকরণ, পার্সিং, অনুসন্ধান, ইত্যাদি API বোঝার জন্য একটি ভাল সূচনা পয়েন্ট।

আপনার প্রোগ্রাম উইকি বৈশিষ্ট্যগুলিতে অ্যাক্সেস পেতে API-কে অনুরোধ পাঠায়। উদাহরণস্বরূপ, একটি উইকিতে লগ ইন করুন, একটি পৃষ্ঠা তৈরি করুন এবং সম্পাদনা করুন, একটি শিরোনাম অনুসন্ধান করুন, বিষয়বস্তু পাঠ্য অনুসন্ধান করুন বা বিষয়বস্তু পার্স করুন। Action API তৃতীয় পক্ষের বিকাশকারী, উইকিমিডিয়া এক্সটেনশন বিকাশকারী এবং উইকি সাইট প্রশাসকদের জন্য উপলব্ধ।

এই পৃষ্ঠার ডান সাইডবারে, বিভাগ দ্বারা গোষ্ঠীবদ্ধ, API দ্বারা সমর্থিত অনেক বৈশিষ্ট্য রয়েছে। উইকি সার্ভারে অনুরোধ পাঠানোর আগে, প্রথমে ডেটা ফরম্যাট, ত্রুটি এবং সতর্কতা, এবং Action API FAQ-এর মতো ওভারভিউ পৃষ্ঠাগুলি পড়ুন।

কিভাবে মিডিয়াউইকি Action API ব্যবহার করবেন
আপনি HTTP-র মাধ্যমে ক্লায়েন্ট সাইড থেকে সার্ভারে ডেটার জন্য অনুরোধ করতে পারেন এবং একটি আদর্শ বিন্যাসে (সাধারণত JSON) প্রতিক্রিয়া পেতে পারেন। একটি অনুরোধ একটি শেষ পয়েন্ট এবং পরামিতিগুলির একটি সেট নিয়ে গঠিত। দুই ধরনের অনুরোধ করা যেতে পারে: GET এবং POST। একটি GET অনুরোধের জন্য, একটি প্যারামিটারে URL-এ একটি ক্যোয়ারী স্ট্রিং থাকবে। একটি POST অনুরোধের জন্য, প্যারামিটারগুলিকে JSON বিন্যাসে বিন্যাস করুন।

অনুরোধ বিন্যাস
All Wikimedia Wikis have endpoints in this format. To operate on the MediaWiki main site or English Wikipedia, use the related endpoint. For example, the English Wikipedia is at  For testing new accounts or test edits to pages, use the test wiki endpoint.

In the query string in the URL, add the  parameter. It tells the API which action to perform. The most popular action is  (the URL would contain ), which allows fetching data from a wiki. Following the  parameter, add another parameter to indicate which one of the three query module types you want to perform:


 * - get properties of pages
 * - get list of pages matching a certain criterion
 * - get meta information about the wiki and user

Finally, include the  parameter, which tells the API in which format to get the results. The recommended format is JSON. The API has supported other output formats in the past, but they are not generally recommended.

A simple query
Let’s take an example of a simple query to understand what a typical GET request and response would look like in the context of the Action API.

Let's search for a title in a wiki. We will use the  module documented on.

GET request
To search for page titles or content matching, the URL for the HTTP GET request would be: Explanation of each part of the URL:


 * is the main endpoint. In this case it is English Wikipedia.
 * means fetch data from wiki.
 * means get list of pages matching a criteria.
 * indicates the page title or content to search for. The  indicates a space character in a URL.
 * indicates JSON output, which is the recommended output format.

Response
The response is a JSON format document with a list of pages titles that match Craig Noone:

Examples of projects using Action API
Some example of projects in Wikimedia that use Action API:


 * Wikipedia iOS App, in which one of the features is to search for wiki pages near your location.
 * Bots that operate on a wiki. Pywikibot is a bot framework written in Python that interfaces with MediaWiki API which a lot of bot developers use.
 * API use in visualizing data obtained from a wiki. Such as this neat visualization that shows real time edits made on Wikipedia.

Additional notes

 * Several sites are using MediaWiki. They might all be running a different version of MediaWiki and in turn the API. Some module parameters supported in one version might be deprecated or removed in others. You could learn about that in each module's documentation via API help module.
 * If you want to make a lot of API calls, and perhaps run very busy and active bots, talk to wiki admins ahead of time, so they do not block you. See list of Administrators of Wikimedia projects. Read more about this topic on.
 * All data modifying actions such as logging, editing or moving a page, and watching or patrolling changes would require tokens. You would need to obtain tokens via to proceed further.

Resources

 * Use Special:APISandbox to experiment with the Action API. You can play around with supported actions, specify a value for parameters, and send requests to the API to see the results on the same page.
 * Wikimedia dumps so you can work with them locally.
 * Read through tutorials: An Introduction to API's and What is REST — A Simple Explanation for Beginners.
 * MediaWiki API help provides auto-generated API documentation of all supported modules.
 * provides an overview of the Action API.
 * Introduction to the MediaWiki API by User:Roan_Kattouw_(WMF) at the San Francisco Hackathon, 2012. This tutorial guide goes along with the video.
 * GitHub: MediaWiki API Demos