API:FAQ/ru

Внимание: эта страница находится в стадии разработки

Также прочтите краткое руководство пользователя. Оно отвечает на некоторые вопросы, на которые здесь не ответили, и направляет на другие полезные страницы.

получить помощь?

 * 1) Прочтите этот FAQ
 * 2) Попробуйте найти ответ на свой вопрос в документации по API здесь или на самодокументируемой странице по API
 * 3) Если Вы не можете найти ответ на свой вопрос в интернете,
 * 4) * Вы можете задать свой вопрос на mediawiki api почтовый список рассылки.
 * 5) * Создайте учётную запись Викимедиа (если у вас её ещё нет) и добавьте новую тему на страницу обсуждения API.
 * 6) Задайте вопрос в IRC на канале  в сети Freenode.

отправить отчёт об ошибке или запрос на введение возможности?
Если вы нашли ошибку в API или хотите запросить введение новой возможности, вы можете сообщить об этом на Phabricator. Сначала произведите поиск по существующим ошибкам (пожалуйста, не отправляйте дублирующие сообщения об ошибках), выберите продукт  MediaWiki-API, когда сообщаете об ошибке в API. Если функция, которую вы запрашиваете, или об ошибке в которой вы пишете сообщение, введена расширением (например, AbuseFilter, FlaggedRevs), добавьте проект того расширения, например, «MediaWiki-extensions-AbuseFilter».

определить, какое действие или подмодуль вызвать?
API движка MediaWiki большой, и расширения увеличивают его ещё сильнее. Некоторые предложения:


 * Если вы пытаетесь получить информацию о странице, возможно, вам понадобится использовать подмодуль  prop=. Другие подмодули query возвращают списки и метаинформацию о вики. [ Просмотреть] генерируемую справку по API для всех подмодулей query.
 * Если вы видите, что страница выполняет интересное действие после её изначальной загрузки, она, должно быть, делает запрос к API.
 * Откройте консоль разработчика в вашем браузере и поищите в ней запросы к.
 * Весь код, выполняющийся на вики Викимедиа, открыт, так что вы можете просмотреть исходный код, выполняя запросы к API. Один способ обнаружить исходный код — вставить в конец URL страницы, чтобы увидеть ключи сообщений около области, в которой представляются результаты API, потом искать эти ключи в локализованных файлах сообщений i18n/en.json ядра и расширений.
 * Вы можете просмотреть всю раскрытую генерируемую справку по API на одной странице, добавив в конец запроса, [ вот, собственно, и она].

Ссылки на генерируемую справку по API, указанные выше, ведут на английскую Википедию. Вам следует просмотреть генерируемую справку по API на той вики, где вы будете делать запросы к API, поскольку разные вики имеют разные настройки и наборы расширений.

вызвать API?
Посылайте HTTP-запросы к api.php. Например, на английской Википедии URL — https://en.wikipedia.org/w/api.php. На большинстве других вики api.php расположен с похожим URL: просто используйте api.php, где у URL действия со страницей index.php. Начиная с 1.17, MediaWiki поддерживает Really Simple Discovery; исходный код HTML каждой страницы содержит RSD-ссылку, указывающую на RSD-дескриптор, сообщающий, где найти API. Если вы не можете найти URL api.php на вики, принадлежащей третьим лицам (не Викимедиа), обратитесь к её владельцу. На вики может быть отключён API, см. .

Чтобы поэкспериментировать с API


 * используйте Special:ApiSandbox
 * включите консоль разработчика в вашем браузере и просматривайте сетевые запросы к api.php, в то время как вы взаимодействуете с вики

контролировать выходной формат?
Передайте  в строке запроса. См. список форматов вывода для большей информации. Обратите внимание, что в процессе удаление всех форматов, кроме JSON, так что старайтесь использовать JSON всегда, когда это возможно.

проверить, доступен ли модуль API?
Можно использовать, чтобы запросить информацию о модулях и подмодулях API (например,  ), которые вы хотите вызвать. Массив  в ответе должен содержать ключ   для каждого модуля и подмодуля, все отсутствующие данные означают недоступность модулей.

Если модуль API недоступен, при этом вам известно, какое расширение его реализует, вы можете проверить, загружено ли это расширение, отправив запрос на метаинформацию siteinfo с параметром  и посмотрев, содержится ли название расширения в возвращённом списке.

Даже если похоже, что модуль доступен, обрабатывать ошибки API всегда необходимо.

обнаружить ошибки?
См. Ошибки и предупреждения.

An error response from the API will set the  HTTP header and return an   structure. For an example error response, visit https://en.wikipedia.org/w/api.php?action=blah.

получить содержимое страницы (wikitext)?
If you just want the raw wikitext without any other information whatsoever, it's best to use index.php's action=raw mode instead of the API: https://en.wikipedia.org/w/index.php?action=raw&title=Main_Page. Note that this will output plain wikitext without any formatting. See also the action=raw documentation

Чтобы получить больше информации о странице и о последней версии, используйте API: https://en.wikipedia.org/w/api.php?action=query&prop=revisions&titles=Main_Page. См. также документацию к модулю prop=revisions.

Вы можете получить до 50 страниц за запрос к API: https://en.wikipedia.org/w/api.php?action=query&prop=revisions&rvprop=content&titles=Main_Page|Articles. Это работает также с генераторами.

получить содержимое страницы (HTML)?
Если вы хотите только HTML, лучше использовать режим  index.php вместо API: https://en.wikipedia.org/wiki/Main_Page?action=render. См. также документацию action=render.

With the advent of RESTBase, on Wikimedia wikis you can instead request the cached HTML of a page, for example https://rest.wikimedia.org/en.wikipedia.org/v1/page/html/Main_Page (for performance this is also available at https://en.wikipedia.org/api/rest_v1/page/html/Main_Page to reuse an existing network connection to the wiki). Unlike  this returns a complete HTML document (i.e.    various metadata  ...  ); you could use an HTML parsing library to get the inner HTML of the   tag (see the documentation).

To get more information distilled from the wikitext at parse time (links, categories, sections, etc.), you can:


 * Query the property submodules that provide the information you need (links, categories, etc.).
 * Use the  API module:

deal with 2015's API changes?
The default continuation behavior changed in MediaWiki 1.26. If you request additional data based on continue information from an API response, you must update your code. Either
 * add  to your API requests to continue to get the confusing old query-continue behavior
 * or add  to your API requests and update to the cleaner continue processing that has been available since MediaWiki 1.21.

Also, since MediaWiki 1.25 an improved output structure for JSON and PHP formats has been available if you add   to your requests. As of July 2015, this is still considered experimental because a few API modules may get further improvements in this mode. If you're willing to risk needing to make future changes to adapt, it's much nicer to process API results with.

я получаю HTTP 403 ошибки?
Это может означать, что вы не указываете заголовок HTTP, или что ваш   пуст или внесён в чёрный список (User-Agent policy). См. справку для большей информации. Также это может означать, что вы указываете  в строке GET-запроса: Викимедиа блокирует все такие запросы, используйте для них POST.

я получаю readapidenied ошибку?
Вики, к которой вы обращаетесь, содержит необщедоступное содержимое и требует, чтобы участники вошли в учётную запись, чтобы они могли читать все страницы. Это означает, что клиенту требуется войти в учётную запись, чтобы запросить какую-либо информацию через API. Для большей информации см. руководство по быстрому старту.

я получаю badtoken ошибки?
This is usually because you're either not passing a token at all (read about tokens in the documentation of the module you're using) or because you're having trouble staying logged in. It's also possible you're reusing a type of token that can't be reused (see module documentation for details) or that you're using a token that's associated with an expired session. In general, when using cached tokens, refetch the token (see API:Tokens) and try again before giving up.

я получаю предупреждения вместо токенов (Action 'edit' is not allowed for the current user)?
У вас или нет прав исполнить запрошенное вами действие, и ли у вас проблемы с тем, чтобы оставаться залогинившимися.

do I get mustposttoken error?
The action you're attempting must be requested using HTTP POST. You probably clicked on  URL in a browser or modified an existing URL in the browser's location field, but that results in an HTTP GET request. You have to use a library (such as the mediawiki.api ResourceLoader module) or utility that can make POST requests; usually you also have to provide it your session cookies and an API:token so MediaWiki can verify that you are the logged-in user with rights to perform the action. As a hack, you might be able to use the cURL command-line utility, providing it each API parameter with  and the necessary browser cookies with. The Network panel of the browser developer tools window (Ctrl+Shift+I) in Firefox and chromium has a "Copy as cURL" menu item that can help, but it's still fiddly.

Depending on what you want to do it's easier to learn how to use a bot or library that handles the details of login, cookies, and tokens for you.

X не доступно через API?
Не все возможности, доступные в пользовательском интерфейсе, доступны в API. Такие возможности не были реализованы, поскольку либо никто не добрался до этого, либо никто этого не запрашивал. Для информации об отправке запросов на введение возможностей, см. выше.

мой вызов API на вики Викимедиа просто возвращает ошибку HTML?
If you use API calls with POST requests make sure that these requests don't use Content-Type: multipart/form-data. This happens for instance if you use CURL to access the API and you pass your POST parameters as an array. The Squid proxy servers which are used at frontend servers at the Wikimedia wiki farm don't handle that correctly, thus an error is returned.

Instead, use the "value1=key1&value2=key2..." notation to pass the parameters as a string, similar to GET requests.

On other wikis which you access directly it doesn't make a difference.

In addition, some software (such as cURL) send an  header for longer POST requests (>1024 bytes). The wikimedia wikis that go through Squid servers can't cope with this. If you are still getting HTML errors with post requests, and are not logged in, try setting a blank Expect header (e.g. using cURL on the command line, use the option ).

do really long API urls not work?
There is a maximum limit of the url size that can be used with the API when making GET requests. This limit varies depending on the website. Wikimedia's limit is roughly around 8100 characters. To get around this limit use POST requests instead (you may also need to set the Expect header, as described above)