API:Etiquette/pt-br

Leia também o guia de início rápido. Ele responde algumas perguntas e aponta para outras páginas úteis.

Ajuda
Tente encontrar a resposta na documentação da API, ou local de teste da API ou na página oficial da API.
 * 1) Perguntas frequentes.
 * 1) Se você não conseguiu encontrar a resposta, pode perguntar na lista de discussão mediawiki-api mailing list.

Limite de solicitações
Não há limite rígido para as solicitações de leitura, mas pedimos que você seja atencioso para não desativar um site. A maioria dos administradores de sistema bloqueia sem cerimônia podendo colocar em risco a estabilidade do site.

Se fizer solicitações em série, ao invés de em paralelo (ou seja, aguardar a conclusão de uma solicitação antes de enviar uma nova, para não fazer solicitações ao mesmo tempo), você definitivamente está bem. Além disso, tente combinar tudo em um único pedido. Por exemplo: use vários separados de títulos "|" em, ao invés de fazer um novo pedido para cada título; use um "generator" ao invés de fazer uma solicitação para cada resultado.

Análise de revisão
Embora seja possível consultar os resultados de um número de revisão específico, essa é uma operação dispendiosa para os servidores. Para recuperar uma revisão específica, use o parâmetro 'oldid', exemplo:


 * [//en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759 en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759]
 * [//en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413 en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413]

O parâmetro maxlag
Se a tarefa não for interativa (um usuário não aguarda um resultado), você deve usar o parâmetro maxlag. Isso impedirá que sua tarefa seja executada quando a carga nos servidores for alta. Valores altos significam comportamento agressivo, valores menores são mais agradáveis.

Veja:

Cabeçalho do Agente do Usuário
Use um cabeçalho  descritivo que inclua o nome do seu aplicativo e o endereço de e-mail. Não copie simplesmente o agente de usuário de um navegador da web (a menos que o seu cliente API seja um aplicativo JavaScript em execução no navegador web com uso do Ajax, caso em que não é possível modificar o agente de usuário). Isso garante que ao surgir um problema, será fácil rastrear o local de origem. Veja API:Identificando o cliente e m:Política do agente de usuário para mais detalhes.

Sobre performance geral
Se está tentando descobrir por que está obtendo resultados lentamente, tente para ajudá-lo sobre o desempenho em geral. Se está achando que a leitura através da API, em vez de ler diretamente os bancos de dados, está diminuindo o desempenho do seu cliente, considere adicionar na Toolforge da Wikimedia.