API:Main page/uk


 * Це огляд «action» API. Див. рядок меню праворуч для отримання детальніших підтем та інших API.

MediaWiki action API є веб-службою, яка надає зручний доступ до вікі-функцій, даних і метаданих через HTTP, за URL-ом зазвичай на. Клієнти запитують конкретні «дії», які вказуються у параметрі, переважно   для отримання інформації. Вона була відома як єдина MediaWiki API, однак тепер є й інші веб-API, доступні для з'єднання з MediaWiki, як-от REST API і Служба запитів Вікіданих.

Вступ
MediaWiki action API може використовуватися для нагляду за MediaWiki-проектом чи створення боту для автоматичної його підтримки. Він забезпечує прямий, високорівневий доступ до даних, що містяться в базах даних MediaWiki. Клієнтські програми можуть автоматично входити до вікі, отримувати дані та публікувати зміни, роблячи HTTP-запити веб-службі. Підтримувані клієнти включають ботів, тонкі JavaScript веб-клієнти, як-от Navigation popups та LiveRC, користувацькі застосунки на кшталт Vandal Fighter й інші веб-сайти (утиліти [//tools.wmflabs.org Toolforge]).

На нових встановленнях MediaWiki веб-служба увімкнена за замовчуванням, але адміністратор може вимкнути її.

MediaWiki має інші два зовнішні інтерфейси:


 * Сторінка Special:Export, яка надає масовий експорт вмісту вікі в XML. Читайте для отримання додаткової інформації.
 * Стандартний веб-інтерфейс (який ви, скоріше за все, використовуєте просто зараз для перегляду цієї сторінки). Читайте для інформації з використання веб-інтерфейсу.

Простий приклад
Цей URL каже API веб-сервісу Англійської Вікіпедії надіслати вам вміст головної сторінки.

Використовуйте будь-яку мову програмування для HTTP GET-запитів для того URL (або просто відвідайте те посилання у своєму браузері), і ви отримаєте JSON-документ, який містить поточну вікі-розмітку для сторінки під назвою «Main Page». Заміна формату на  поверне «pretty-printed» HTML-результат, добрий для налагодження.

Давайте розберемо цей URL по частинах, аби показати, як він працює.

Кінцева точка
Це — «кінцева точка» (точка доступу, endpoint). Це як домашня сторінка API веб-сервісу MediaWiki. Цей URL є базовим URL для API Англійської Вікіпедії, просто як  є базовим URL для його веб-сайту.

Якщо ви пишете програму для використання Англійської Вікіпедії, кожен побудований URL починатиметься з цього базового URL. Якщо ви використовуєте іншу інсталяцію MediaWiki, вам необхідно знайти її кінцеву точку та використати її натомість. Всі вікі Вікімедіа мають кінцеві точки, що відповідають цьому шаблону:

Починаючи з, ми маємо RSD для кінцевої точки: шукайте  у коді HTML будь-якої сторінки та видобувайте   URL; актуальне посилання містить додаткову інформацію. Наприклад, на цій вікі це:

Інакше, це не є безпечним способом визначення кінцевої точки на будь-якій вікі. Якщо вам пощастить, то або повний шлях до index.php не буде прихований дивними правилами перезапису, то ж вам потрібно лише взяти посилання «редагувати» (чи історія) та замінити index.php (ін.) на api.php, або ви матимете змогу використати шлях сценаріїв за замовчуванням (як ).

Тепер перейдімо до параметрів у рядку запиту URL.

Формат
Це каже API, що ми хочемо повернення даних у форматі JSON. Ви також можете захотіти спробувати  для отримання HTML-версії результату, доброї для налагодження. API підтримує інші формати виведення, як-от XML і рідний PHP, але планується вилучити менш популярні формати (T95715), тому ви можете не захотіти використовувати їх.

Дія
API веб-служби MediaWiki реалізує дюжини дій, а розширень реалізовано набагато більше; динамічно згенерована довідка API документує всі доступні дії на вікі. У цьому випадку, ми використовуємо дію «query» для отримання деякої інформації. Дія «query» є однією з найважливіших дій API, і вона має вичерпну документацію. Наступне — це лише пояснення одного прикладу.

Параметри дій
The rest of the example URL contains parameters used by the "query" action. Here, we're telling the web service API that we want information about the Wiki page called "Main Page". (The %20 is a percent-encoded space.) If you need to query multiple pages, put them all in one request to optimize network and server resources:. See the query documentation for details.

You can request many kinds of information, or properties, about a page. This parameter tells the web service API that we want information about a particular revision of the page. Since we're not specifying any revision information, the API will give us information about the latest revision &mdash; the main page of Wikipedia as it stands right now.

Finally, this parameter tells the web service API that we want the content of the latest revision of the page. If we passed in  instead, we'd get the latest page content and the name of the user who made the most recent revision.

Again, this is just one example. Queries are explained in more detail here, and the API reference lists all the possible actions, all the possible values for, and so on.



Getting started
Before you start using the MediaWiki web service API, be sure to read these documents:


 * The FAQ.
 * The page about input and output formats
 * The page about errors and warnings
 * Any policies that apply to the wiki you want to access, such as Wikimedia Foundation wikis' terms of use, trademark policy. These terms apply to you when you access or edit using the API, just as they do when you use your web browser.

Beyond that point, what you need to read depends on what you want to do. The right-hand menu links to detailed, task-specific documentation, and some more general guidelines are given below.

Identifying your client
When you make HTTP requests to the MediaWiki web service API, be sure to specify a  header that properly identifies your client. Don't use the default  provided by your client library, but make up a custom header that identifies your script or service and provides some type of means of contacting you (e.g., an e-mail address).

An example User-Agent string might look like: MyCoolTool/1.1 (https://example.org/MyCoolTool/; MyCoolTool@example.org) BasedOnSuperLib/1.4

On Wikimedia wikis, if you don't supply a  header, or you supply an empty or generic one, your request will fail with an HTTP 403 error (cf. User-Agent policy). Other MediaWiki installations may have similar policies.

If you are calling the API from browser-based JavaScript, you won't be able to influence the  header: the browser will use its own. To work around this, use the  header:

In PHP, you can identify your user-agent with code such as this:

Or if you use cURL:

Logging in
Your client will probably need to log in to MediaWiki, possibly via its own user account. See the login manual page for details.

API etiquette
Please also read: API:Etiquette

If your requests obtain data that can be cached for a while, you should take steps to cache it, so you don't request the same data over and over again. More information about rate-limiting, concurrency, and general API etiquette can be found at API:Etiquette. Some clients may be able to cache data themselves, but for others (particularly JavaScript clients), this is not possible.

Per the HTTP specification, POST requests cannot be cached. Therefore, whenever you're reading data from the web service API, you should use GET requests, not POST.

Also note that a request cannot be served from cache unless the URL is exactly the same. If you make a request for, and cache the result, then a request for   will not go through the cache — even though MediaWiki returns the same data!

You should take care to normalize the URLs you send to the MediaWiki web service, so that slightly different user input won't cause you to waste time on unnecessary HTTP requests. You can normalize a list of page titles by removing duplicates and sorting the titles alphabetically. Similar techniques will work for other kinds of data.

Useful links
The menu bar on the right side of this page links to more detailed, task-specific documentation. Here are some links having to do with the API as a whole:


 * The API sandbox available on all Wikimedia wikis makes it easy to try out different actions interactively.
 * [//en.wikipedia.org/w/api.php The API reference] contains automatically-generated descriptions of all actions and parameters.
 * Hook into Wikipedia information using PHP and the MediaWiki API (IBM developerWorks article, 17 May 2011)
 * Hook into Wikipedia using Java and the MediaWiki API (6 April 2012)
 * Mailing list for notifications and questions: API mailing list
 * Low-traffic mailing list for announcements only (all posts to this list are posted to mediawiki-api as well): mediawiki-api-announce
 * View and report API bugs in the MediaWiki-API Phabricator project (When reporting new bugs, don't forget to add MediaWiki-API to Projects)
 * — The current MediaWiki database schema
 * — The current MediaWiki database schema

Archived links

 * 2006 API discussion