API:Main page/pt-br


 * Esta é uma apresentação do API "ação". Observe a barra de menu à direita para subtópicos mais detalhados e outros APIs.

A API action do MediaWiki é um pt:Web service que fornece um acesso simplificado as ferramentas wiki, dados e meta-dados através do HTTP, via uma URL. Clientes solicitam "ações" particulares ao especificar um parâmetro, principalmente   para obter informação. Era conhecida como  a  MediaWiki API, mas agora existem outro web APIs disponíveis que se conectam ao MediaWiki, tais como RESTBase e o Wikidata serviço de consulta.

Introdução
Se você está procurando por uma "API interna" ou "PHP API", veja a 'extensão de interface, que possibilita desenvolvedores PHP à adicionarem novas funcionalidades a uma instalação MediaWiki.

A API action do MediaWiki pode ser usado para monitorar uma instalação do MediaWiki, ou para criar um robô e mantê-lo autônomo. Fornece um acesso direto e de alto nível aos dados contidos nos bases de dados do MediaWiki. Programas de cliente podem fazer logon um wiki, obter dados e postar as alterações automaticamente, fazendo solicitações HTTP para o serviço da web. Clientes suportados incluem bots, fina na web JavaScript clientes tais como Popups de navegação e LiveRC, aplicativos de usuário final, como Vandal Fighter e outros sites da web ([//tools.wmflabs.org ferramenta Labs]' Utilitários).

Nas novas instalações do MediaWiki, o serviço da web é habilitado por padrão, mas um administrador pode desativá-lo.

O MediaWiki tem duas outras interfaces externas:


 * A página Special:Export, que permite a exportação em bloco do conteúdo de uma wiki no formato XML. Consulte para mais informações.
 * O padrão interface baseada na web  (que você provavelmente está usando agora para ver esta página). Leia para obter informações sobre como usar a interface web-based.

Um exemplo simples
This URL tells English Wikipedia's web service API to send you the content of the main page:

Use any programming language to make an HTTP GET request for that URL (or just visit that link in your browser), and you'll get a JSON document which includes the current wiki markup for the page titled "Main Page". Changing the format to  will return a "pretty-printed" HTML result good for debugging.

Let's pick that URL apart to show how it works.

The endpoint
This is the endpoint. It's like the home page of the MediaWiki web service API. This URL is the base URL for English Wikipedia's API, just as  is the base URL for its web site.

If you're writing a program to use English Wikipedia, every URL you construct will begin with this base URL. If you're using a different MediaWiki installation, you'll need to find its endpoint and use that instead. All Wikimedia wikis have endpoints that follow this pattern:

Since, we have RSD discovery for the endpoint: look for the  in the HTML source of any page and extract the   URL; the actual link contains additional info. For instance, on this wiki it's:

Otherwise, there's no safe way to locate the endpoint on any wiki. If you're lucky, either the full path to index.php will not be hidden under strange rewrite rules so that you'll only have to take the "edit" (or history) link and replace index.php (etc.) with api.php, or you'll be able to use the default script path (like ).

Now let's move on to the parameters in the query string of the URL.

The format
This tells the API that we want data to be returned in JSON format. You might also want to try  to get an HTML version of the result that is good for debugging. The API supports other output formats such as XML and native PHP, but there are plans to remove less popular formats (T95715), so you might not want to use them.

The action
The MediaWiki web service API implements dozens of actions and extensions implement many more; the dynamically generated API help documents all available actions on a wiki. In this case, we're using the "query" action to get some information. The "query" action is one of the API's most important actions, and it has extensive documentation of its own. What follows is just an explanation of a single example.

Action-specific parameters
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 comes from percent-encoding a 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.

Links úteis
Barra de menu no lado direito desta página contém links para documentação mais detalhada, tarefas específicas. Aqui estão alguns links que tenha a ver com a API como um todo:


 * A sandbox API disponível em Wikimedia todas wikis facilita a experimentar diferentes ações interativamente
 * [//en.wikipedia.org/w/api.php de API o árbitros] contém descrições gerados automaticamente de todas as ações e parâmetros.
 * gancho em informações de Wikipédia usando PHP e a API de MediaWiki (Artigo de IBM developerWorks, 17 de maio de 2011)
 * gancho na Wikipédia usando Java e a API do MediaWiki (6 de abril de 2012)
 * Lista de discussão para notificações e perguntas: Lista de discussão de API
 * Lista de discussão de baixo tráfego para anúncios apenas (todas as mensagens para esta lista são postadas para mediawiki-api também): mediawiki-api-announce
 * Exibir e relatar erros de API no  MediaWiki-API  Phabricator projeto ('quando reportar novos bugs, não se esqueça de adicionar o MediaWiki-API para projetos')
 * — O esquema de banco de dados atual do MediaWiki
 * — O esquema de banco de dados atual do MediaWiki

Links arquivados

 * Discussão da API em 2006