API:FAQ/ru

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

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

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

 * 1) Read this FAQ
 * 2) Try to find the answer to your question in the API documentation here or on the self-documenting API home page
 * 3) If you can't find the answer to your question on the web,
 * 4) * you can ask your question on the mediawiki-api mailing list.
 * 5) * Create a Wikimedia account (if you don't have one already) and add a new topic on the API discussion page.
 * 6) * Ask on IRC in the channel on the Freenode network.

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

вызвать API?
Send HTTP requests to api.php. For example, on the English Wikipedia, the URL is http://en.wikipedia.org/w/api.php. Most wikis have api.php at a similar URL: just use api.php in place of index.php in page actions. From 1.17 onwards, MediaWiki supports Really Simple Discovery; the HTML source of every page has an RSD link pointing to an RSD descriptor which indicates where to find the API. If you can't figure out the URL of api.php on a third-party (non-Wikimedia-operated) wiki, contact its owner. The wiki may not enable the MediaWiki API, see.

To play with the API


 * use Special:ApiSandbox
 * enable your browser's developer console and watch net requests to api.php as you interact with the wiki

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

check if an API module is available?
You can use  to request information about the API modules and submodules (such as  ) that you want to invoke. The  array in the response must contain a   key for each module and submodule, anything missing is not available.

If an API module isn't available and you know which extension implements it, you can check if that extension is loaded by querying the siteinfo meta information for  and look for its name in the returned list.

Even if a module appears to be available, you must always handle API errors.

обнаружить ошибки?
See Errors and warnings.

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

получить содержимое страницы (wikitext)?
Если вы просто хотите чистый викитекст без какой-либо другой информации, лучше всего использовать режим action=raw index.php вместо API: http://en.wikipedia.org/w/index.php?action=raw&title=Main_Page. Обратите внимание, что это выведет необработанный викитекст без какого-либо форматирования. См. также документацию action=raw.

To get more information about the page and its latest version, use the API: http://en.wikipedia.org/w/api.php?action=query&prop=revisions&titles=Main_Page. See also the documentation for the prop=revisions module.

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

получить содержимое страницы (HTML)?
If you just want the HTML, it's best to use index.php's  mode instead of the API: https://en.wikipedia.org/wiki/Main_Page?action=render. See the action=render documentation.

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. 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. https://en.wikipedia.org/w/api.php?action=parse&page=Main_Page.

я получаю 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)?
У вас или нет прав исполнить запрошенное вами действие, и ли у вас проблемы с тем, чтобы оставаться залогинившимися.

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)