Wikibase/API/pt-br



O que é a API Wikibase
Wikibase fornece um mecanismo para armazenar declarações, como dados estruturados. As declarações sobre os itens estão no servidor do wikidata.org. Veja Wikidata:Glossary para mais informações sobre Wikibase e outros conceitos.



A API do Wikibase permite consultar, adicionar, remover e editar informações no Wikidata ou em qualquer outra instância do Wikibase.

Este é fornecido por meio de um conjunto de extensões para os módulos da API do MediaWiki. Portanto, para usar a API Wikibase, você deve ter uma familiaridade básica com a MediaWiki Action API: ações, consultas, etc., bem como com parâmetros genéricos como  e.



Como usar
Envie solicitações para a API por meio de HTTP, da mesma forma que com a MediaWiki Action API. Veja API:Tutorial#Como usar para obter informações sobre como usar o MediaWiki Action API.



Formato da solicitação
O endpoint da API é https://wikidata.org/w/api.php.

Na consulta, adicione o parâmetro action, que informa à API qual ação executar. Por exemplo,  informa à API para obter os dados das entidades da Wikibase. Para submódulos meta e de propriedade, use  e , respectivamente.

Alguns parâmetros estão quase sempre disponíveis. As formas plurais são usadas nos casos em que um parâmetro pode assumir vários valores. Os parâmetros são:



Pesquisa simples


Solicitações GET
Explicação de cada parte da URL:


 * é o endpoint principal.
 * Por exemplo,  informa à API para obter os dados das entidades da Wikibase.
 * significa obter os dados da Wikipedia em inglês.
 * indica o título da página da qual obter dados.
 * indica as propriedades a serem obtidas das entidades, neste caso a propriedade são as descrições das entidades.
 * filtra os resultados para o idioma inglês.
 * indica a saída JSON (formato de saída recomendado).

Resposta
A resposta de uma solicitação geralmente conterá:


 * Uma chave  com uma conversão booleana como um número inteiro se a solicitação for bem-sucedida. Se o número inteiro for zero, quaisquer valores adicionais podem estar errados.
 * Uma chave  com um objeto de duas, opcionalmente três chaves, ,   e  , se a solicitação não for bem-sucedida.
 * Informações sobre a action. A informação é passada no nível superior ou sob item se for um único item, ou items se forem vários. Se forem vários itens, cada um será encontrado em uma chave com seu próprio ID de item.

Objetos vazios são retornados como arrays JSON e não como objetos, enquanto parâmetros vazios removem a entrada real do item.



Meta submodules

 * wikibase:
 * wbcontentlanguages:

Property submodules

 * pageterms:
 * wbentityusage:

API modules

 * wbgetentities:
 * wbavailablebadges:
 * wbcreateclaim:
 * wbcreateredirect:
 * wbeditentity:
 * wbformatvalue:
 * wbgetclaims:
 * wblinktitles:
 * wbmergeitems:
 * wbparsevalue:
 * wbremoveclaims:
 * wbremovequalifiers:
 * wbremovereferences:
 * wbsearchentities:
 * wbsetaliases:
 * wbsetclaim:
 * wbsetclaimvalue:
 * wbsetdescription:
 * wbsetlabel:
 * wbsetqualifier:
 * wbsetreference:
 * wbsetsitelink:
 * wbsgetsuggestions:
 * wbcheckconstraints:
 * wbcheckconstraintparameters:



Possíveis erros
Possíveis erros para qualquer módulo pode ser encontrado usando. The error format corresponds to that of the MediaWiki Action API. See API:Errors and warnings#Legacy format.

Todas as mensagens de erro dos módulos Wikibase devem ser internacionalizadas (i18n) e localizadas (l10n). O idioma do usuário conectado será o padrão para as mensagens de erro, mas você pode substituí-lo adicionando  à string de consulta da URL.

Additional notes
Muitas wikis da Wikimedia funcionam com a extensão de Cliente da Wikibase. Isto permite que os clientes da API nas mesmas
 * consultem o submódulo meta  para determinar os URLs para o repositório completo da Wikibase consulte a ajuda da respetiva API
 * consultem o submódulo da propriedade  para obter alguma informação da Wikidata sobre páginas da wiki local
 * Os módulos de calendário que podem ser usados com Wikibase são o calendário gregoriano (Q1985727) e o calendário juliano (Q1985786).
 * A API usa IDs de revisão para detecção de colisão de edição. Se houver uma colisão de edição, o solicitante deve adquirir um ID de revisão mais recente para poder continuar. Isso normalmente envolve solicitar  para o item em questão e, em seguida, armazenar (e usar) a revisão da entrada.
 * Qualquer instalação do MediaWiki pode executar o Wikibase. No cluster Wikimedia, a maioria dos wikis não executa o conjunto completo de extensões Wikibase. Wikimedia Commons has its own Wikibase for properties of the files on Commons.
 * Do not test the  value for a particular error, instead use the   value as this will remain independent of localization.