Wikibase/API

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Wikibase/API and the translation is 6% complete.

Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎español • ‎français • ‎português • ‎български • ‎русский • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
MediaWiki version: 1.9

What is the Wikibase API?

Wikibase provides a general mechanism to store 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.

A statement

The Wikibase API allows querying, adding, removing and editing information on Wikidata or any other Wikibase instance.

A API da Wikibase é fornecida por um conjunto de extensões que implementam os módulos da API do MediaWiki.

Para utilizá-la, deverá estar familiarizado com a API Operacional do MediaWiki: operações, consultas, etc., e inversamente, toda a sua experiência com parâmetros genéricos, tais como curtimestamp e requestid, etc., aplica-se à API da Wikibase.

How to use it

Send requests to the API through HTTP, the same way with the MediaWiki Action API. See API:Tutorial#How to use it for information on 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, e.g. action=wbgetentities tells the API to get the data for Wikibase entities. For meta and property submodules, use action=query&meta=yourmoduleand action=query&prop=modulename respectively.

There are some parameters that are nearly always available. Plural forms are used in those cases where a parameter can take several values. The parameters are:

  • id/ids: Identifies a specific entity or entities, most typical an item. Plural form is used in wbgetentities. Lists of ids should be separated by the pipe character
  • site ∩ title/sites ∩ titles: Identifies a single item or multiple items. Plural form is used in wbgetentities. Only one of sites and titles can have multiple values at the same time.
  • language/languages: The language is used as a filter mechanism to filter labels and descriptions in get actions or to identify a specific language for set 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 on shall the request be fulfilled.
  • baserevid: An id for the last known revision that must be passed on so the server can detect edit collisions.

A simple query

GET request

Get the item for page "Berlin" on English Wikipedia.

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

Source-generated documentation for the MediaWiki Action API including Wikibase 'wb' API modules is available at wikidata.org/w/api.php

Meta submodules

  • wikibase: Gets information about the Wikibase client and the associated Wikibase repository.
  • wbcontentlanguages: Returns information about the content languages Wikibase accepts in different contexts.

Property submodules

  • pageterms: Get the Wikidata terms (typically labels, descriptions and aliases) associated with a page via a sitelink.
  • wbentityusage: Returns all entity IDs used in the given pages.

API modules

Erros

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 internationalized (i18n) and localized (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 the code value as this will remain independent of localization.

Ver também