Wikibase/API
Está página faz parte da documentação da API de Ação do MediaWiki. |
Versão MediaWiki: | ≥ 1.9 |
What is the Wikibase API?
Wikibase provides a general mechanism for storing statements as structured data. The statements about items live on the server at wikidata.org. See Wikidata:Glossary for more information on Wikibase and other concepts.
The Wikibase API allows querying, adding, removing and editing information on Wikidata or any other Wikibase instance.
Ele é 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 API MediaWiki Action: operações, consultas, etc., bem como com parâmetros genéricos como curtimestamp
e requestid
.
How to use the Wikibase api
Send requests to the API through HTTP, the same as with the MediaWiki Action API. See API:Tutorial#How to use it for information about how to use the MediaWiki Action API.
Request Format
The endpoint for the API is https://wikidata.org/w/api.php.
In the query string, add the action parameter, which tells the API which action to perform. For example, action=wbgetentities
tells the API to get the data for Wikibase entities. For meta and property submodules, use action=query&meta=yourmodule
and action=query&prop=modulename
respectively.
Some parameters are nearly always available. Plural forms are used in those cases in which a parameter can take several values. The parameters are:
id/ids
: Identifies a specific entity or entities, typically an item. The plural form is used in wbgetentities. Lists of ids should be separated by the pipe charactersite ∩ title/sites ∩ titles
: Identifies a single item or multiple items. The plural form is used in wbgetentities. Only one of sites and titles can have multiple values at the same time.language/languages
: The language parameter filters labels and descriptions in get actions or identifies a specific language for a set of actions.format
: Should always be set to json (or jsonfm for debugging), or xml (or xmlfm for debugging). No other form is supported.summary
: Adds a user-specified summary in addition to the system-generated one.token
: An encrypted string the requester must pass for the request to be fulfilled.baserevid
: An id for the last known revision that must be passed so that the server can detect edit collisions.
A simple query
GET request
Explanation of each part of the URL:
http://www.wikidata.org/w/api.php
is the main endpoint.action=wbgetentities
tells the API to get the data for Wikibase entities.sites=enwiki
means get the data from English Wikipedia.titles=Berlin
indicates the title of the page to get data from.props=descriptions
indicates properties to get from the entities, in this case the property is the descriptions of the entities.languages=en
means filter the results down to the English language.format=json
indicates JSON output, which is the recommended output format.
Response
{
"entities": {
"Q64": {
"type": "item",
"id": "Q64",
"descriptions": {
"en": {
"language": "en",
"value": "capital and largest city of Germany"
}
}
}
},
"success": 1
}
The response of a request will usually contain:
- A
success
key with a boolean cast as an integer if the request is successful. If the integer is zero, any additional values might be wrong. - An
error
key with an object of two, optionally three keys,code
,info
and*
, if the request is unsuccessful. - Information about the action. The information is either passed on the top level or under item if it is one single item or items if it is several. If it is several items, each is found under a key with its own item id.
Empty objects are returned as JSON arrays and not as objects, while empty parameters remove the actual entry from the item.
API documentation and Wikibase modules
Meta submodules
- wikibase: ⧼Apihelp-query+wikibase-description⧽
- wbcontentlanguages: Devolve informação sobre as línguas de conteúdo que a extensão Wikibase aceita em diferentes contextos.
Property submodules
- pageterms: ⧼Apihelp-query+pageterms-description⧽
- wbentityusage: ⧼Apihelp-query+wbentityusage-description⧽
API modules
- wbgetentities: ⧼Apihelp-wbgetentities-description⧽
- wbavailablebadges: ⧼Apihelp-wbavailablebadges-description⧽
- wbcreateclaim: ⧼Apihelp-wbcreateclaim-description⧽
- wbcreateredirect: ⧼Apihelp-wbcreateredirect-description⧽
- wbeditentity: ⧼Apihelp-wbeditentity-description⧽
- wbformatvalue: ⧼Apihelp-wbformatvalue-description⧽
- wbgetclaims: ⧼Apihelp-wbgetclaims-description⧽
- wblinktitles: ⧼Apihelp-wblinktitles-description⧽
- wbmergeitems: ⧼Apihelp-wbmergeitems-description⧽
- wbparsevalue: ⧼Apihelp-wbparsevalue-description⧽
- wbremoveclaims: ⧼Apihelp-wbremoveclaims-description⧽
- wbremovequalifiers: ⧼Apihelp-wbremovequalifiers-description⧽
- wbremovereferences: ⧼Apihelp-wbremovereferences-description⧽
- wbsearchentities: Pesquisa entidades que usam rótulos e nomes alternativos.
- wbsetaliases: ⧼Apihelp-wbsetaliases-description⧽
- wbsetclaim: ⧼Apihelp-wbsetclaim-description⧽
- wbsetclaimvalue: ⧼Apihelp-wbsetclaimvalue-description⧽
- wbsetdescription: ⧼Apihelp-wbsetdescription-description⧽
- wbsetlabel: ⧼Apihelp-wbsetlabel-description⧽
- wbsetqualifier: ⧼Apihelp-wbsetqualifier-description⧽
- wbsetreference: ⧼Apihelp-wbsetreference-description⧽
- wbsetsitelink: ⧼Apihelp-wbsetsitelink-description⧽
- wbsgetsuggestions: ⧼Apihelp-wbsgetsuggestions-description⧽
- wbcheckconstraints: ⧼Apihelp-wbcheckconstraints-description⧽
- wbcheckconstraintparameters: Verifica os parâmetros de restrição das declarações de restrições.
Erros possíveis
Possible errors for any module can be found using action=paraminfo&modules=modulename
.
The error format corresponds to that of the MediaWiki Action API. See API:Errors and warnings#Legacy format.
All error messages from the Wikibase modules should be internationalised (i18n) and localised (l10n). The user language for the logged-in user will be the default for error messages, but you can override this by adding uselang=languageCode
to the URL query string.
Error type | Code | Info |
---|---|---|
An internationalized error message that isn't localized. | no-such-item | <wikibase-api-no-such-item> |
A correctly localized error message. | no-such-item | There are no such item to be found |
A localized variant.(Norwegian) | no-such-item | Det finnes ingen slik item |
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
wikibase
para determinar os URLs para o repositório completo da Wikibase consulte a ajuda da respetiva API - consultem o submódulo da propriedade
pageterms
para obter alguma informação da Wikidata sobre páginas da wiki local
- The calender models that can be used with Wikibase are the Gregorian calendar(d:Q1985727) and the Julian calendar(d:Q1985786).
- The API uses revision ids for edit collision detection. If there is an edit collision, the requester must acquire a newer revision id to be able to continue. This typically involves requesting
wbgetentities
for the item in question, and then storing (and using) the revision from the entry.
- Any MediaWiki installation can run Wikibase. On the Wikimedia cluster, most wikis do not run the full set of Wikibase extensions.
Wikimedia Commons has its own Wikibase for properties of the files on Commons.
- Do not test the
info
value for a particular error, instead use thecode
value as this will remain independent of localisation.
Ver também
- API:Página principal - The quick start guide for the MediaWiki Action API.
- API:PERGUNTAS MAIS FREQUENTES - Frequently asked questions about the MediaWiki Action API.
- API:Tutorial - A tutorial on how to use the MediaWiki Action API.
- Download Wikidata database dumps in JSON (recommended), XML and RDF formats.