API:Tutorial/pt-br

Neste tutorial, você aprenderá sobre a função Action API do MediaWiki, como usá-la, formato de solicitação, uma consulta simples e exemplos de projetos usando Action API.

Procure aplicativos de demonstração no Toolforge

Overview of the MediaWiki Action API
A API é uma REST completa, web service que permite aos usuários realizar certas ações wiki como criação de página, autenticação, análise, pesquisa, etc. é um bom ponto de partida para entender a API.

Seu programa envia solicitações à API para obter acesso aos recursos da wiki. Por exemplo, efetua autenticação/login em uma wiki, cria uma página, edita, pesquisa um título, pesquisa um texto de conteúdo, analise o conteúdo. A API de ação está disponível para desenvolvedores terceirizados, desenvolvedores de extensões Wikimedia e administradores de sites wiki.

On the right sidebar of this page, there are many features that are supported by the API, grouped by category. Antes de enviar solicitações para um servidor wiki, primeiro leia as páginas de visão geral, como formatos de dados, erros e avisos e as Perguntas frequentes da API.



Como usar a API
Como usuário você pode solicitar dados ao servidor noformato HTTP e obter a resposta no formato padrão (normalmente JSON). Uma solicitação consiste em um endpoint e um conjunto de parâmetros. Existem dois tipos de solicitação que podem ser feitas:GET and POST. Para uma solicitação GET, um parâmetro conteria uma string de consulta na URL. Para uma solicitação POST, os parâmetros precisam estar no formato JSON.



Formato da solicitação
Todos as wikis da Wikimedia têm endpoints neste formato. Para operar no site principal do MediaWiki ou na Wikipedia em inglês, use o endpoint relacionado. Por exemplo, a Wikipédia em inglês é. Para testar novas contas ou testar edições em páginas, use o endpoint do wiki de teste.

Na string de consulta no URL, adicione o parâmetro. Ele informa para a API qual ação executar. A ação mais popular é  (o URL conteria ), que permite buscar dados de uma wiki. Após o parâmetro, adicione outro parâmetro para indicar qual dos três tipos de módulo de consulta você deseja executar:


 * - Obter as propriedades da página
 * - Lista de páginas que correspondem a um critério.
 * - Obter meta informações sobre a wiki e o usuário

Por fim, inclua o parâmetro, que informa à API em qual formato obter os resultados. O formato recomendado é o JSON (a API suportou outros formatos de saída no passado, mas não são recomendados).



Uma pesquisa simples
Vamos dar um exemplo de uma pesquisa simples (em inglês: query) para entender como seria uma solicitação GET e sua resposta típica no contexto da Action API.

Vamos pesquisar um título em uma wiki, usaremos o módulo  documentado em.



Solicitações GET
Para pesquisar títulos de páginas ou um conteúdo correspondente a, o formato da URL para fazer uma solicitação HTTP GET seria:Explicação de cada parte da URL:


 * é o ponto final principal. Neste caso, é a Wikipédia em inglês.
 * é para pesquisar dados do wiki.
 * é para obter uma lista de páginas que correspondem a um critério.
 * 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