Wikibase/API

This page is a translated version of the page Wikibase/API and the translation is 51% complete.
Outdated translations are marked like this.
Versión de MediaWiki:
1.9

Qué es el API Wikibase?

Wikibase proporciona un mecanismo general para almacenar declaraciones como datos estructurados. Las declaraciones sobre elementos viven en el servidor en wikidata.org Véase Wikidata:Glosario para más información en Wikibase y otros conceptos..

 
A statement

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

Se proporciona a través de un conjunto de extensiones de los módulos API de MediaWiki. Por lo tanto, para utilizar la API de Wikibase, debes tener una familiaridad básica con la API de acción de MediaWiki: acciones, consultas, etc., así como con parámetros genéricos como sello de tiempo Y Solicitude de identidad.

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.

Algunos parámetros están casi siempre disponibles. Las formas plurales se utilizan en los casos en que un parámetro puede tomar varios valores. Los parámetros son:

  • id/ids: Identifica una entidad o unas entidades específicas, generalmente un elemento. La forma plural se utiliza en wbgetentities. Las listas de identificadores deberían ser separadas por el carácter pipe
  • site ∩ title/sites ∩ titles: Identifica uno o varios elementos. La forma plural se usa en wbgetentities. Solo se permite que o bien sites o bien titles tenga valores múltiples, pero no ambos.
  • language/languages: El idioma se usa como mecanismo de filtro para filtrar etiquetas y descripciones en acciones de lectura o para identificar un idioma específico en acciones de escritura.
  • format: Debe estar siempre en json (o jsonfm para depuración) o xml (o xmlfm para depuración). No se admiten otros formatos.
  • summary: Añade un resumen personalizado además de generado por el sistema.
  • token: Una cadena cifrada que el solicitante debe enviar en caso de que se cumplimente la petición.
  • baserevid: Un identificador para la última revisión conocida que se debe enviar para que el servidor pueda detectar conflictos de edición.

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
}

La respuesta de un pedido por lo general tendrán:

  • Una clave success con un booleano casteado a entero si la request es exitosa. Si el entero es 0, cualquier valor adicional podría ser erróneo.
  • Una clave error con un objeto de dos, opcionalmente 3 llaves, code, info, *, si la request no se resolvió exitosamente.
  • Información sobre la acción. La informacion es pasada en el nivel superior o, si es de un solo item en "item" o en "items" si son varios. Si son varios items, cada uno se encuentra debajo de una clave con su propio item id.

Los objetos vacíos se devuelven como arrays JSON y no como objetos, mientras que los parámetros vacíos "eliminan" la entrada del elemento.

Documentación API y módulos Wikibase

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

Meta submodules

  • wikibase: Obtener información acerca del cliente Wikibase y el repositorio Wikibase asociado.
  • wbcontentlanguages: Returns information about the content languages Wikibase accepts in different contexts.

Property submodules

  • pageterms: Obtener los términos de Wikidata (normalmente, etiquetas, descripciones y alias) asociados con una página mediante un enlace de sitio.
  • wbentityusage: Devuelve todos los identificadores de entidad utilizados en las páginas dadas.

API modules

  • wbgetentities: Obtiene los datos de múltiples entidades de Wikibase.
  • wbavailablebadges: Consulta los elementos de insignias disponibles.
  • wbcreateclaim: Crea afirmaciones de Wikibase.
  • wbcreateredirect: Crea redirecciones de entidad.
  • wbeditentity: Crea una entidad Wikibase nueva y única, y la modifica con información serializada.
  • wbformatvalue: Formats DataValues.
  • wbgetclaims: Gets Wikibase claims.
  • wblinktitles: Asocia dos páginas en dos wikis distintos con un elemento de Wikibase.
  • wbmergeitems: Fusiona varios elementos.
  • wbparsevalue: Analiza los valores mediante un ValueParser (analizador de valores).
  • wbremoveclaims: Quita afirmaciones de Wikibase.
  • wbremovequalifiers: Quita un calificativo de una declaración.
  • wbremovereferences: Quita una o más referencias de la misma declaración.
  • wbsearchentities: Searches for entities using labels and aliases.
  • wbsetaliases: Establece los alias de una entidad de Wikibase.
  • wbsetclaim: Crea o actualiza toda una Declaración o Reclamación.
  • wbsetclaimvalue: Establece el valor de una afirmación de Wikibase.
  • wbsetdescription: Establece una descripción para una sola entidad de Wikibase.
  • wbsetlabel: Establece una etiqueta para una única entidad de Wikibase.
  • wbsetqualifier: Crea un calificativo o establece el valor de uno ya existente.
  • wbsetreference: Crea una referencia o establece el valor de una referencia existente.
  • wbsetsitelink: Asocia una página de una wiki con un elemento de Wikibase o borra una asociación de este tipo ya realizada.
  • wbsgetsuggestions: Módulo API para obtener sugerencias de propiedades adicionales para agregar a un Wikibase entidad. El módulo API está destinado principalmente para su uso por el suggester widget cuando los usuarios están editando Wikibase entidades.
  • wbcheckconstraints: Realiza comprobaciones de restricciones en cualquier entidad y devuelve el resultado.
  • wbcheckconstraintparameters: Verifica los parámetros de restricción de las declaraciones de restricción.

Posibles errores

Se pueden encontrar posibles errores para cualquier módulos usando action=paraminfo&modules=modulename. The error format corresponds to that of the MediaWiki Action API. See API:Errors and warnings#Legacy format.

Todos los mensajes de error de los módulos de Wikibase deberían estar internationalizados (i18n) y localizados (l10n), pero ten en cuenta que los mensajes de error del sistema base de la API pueden no estar localizados. El idioma que tenga definido el usuario conectado (generalmente el mismo que en la interfaz web) será el predeterminado para mensajes de error. Sin embargo, puedes especificar otro idioma añadiendo uselang=languageCode a la cadena de la consulta en la URL

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

Muchos wikis de Wikimedia incorporan la extensión Cliente Wikibase. Esto permite a los clientes de la API instalados en ellos

  • consultar el submódulo meta wikibase para determinar las URL para el repositorio de Wikibase ver la página de ayuda de la API
  • consultar el submódulo de propiedades pageterms para obtener información de Wikidata sobre páginas del wiki local
  • Los modelos de calendario que pueden ser utilizados con Wikibase son el calendario gregoriano(d:Q1985727) y el calendario juliano(d:Q1985786).

La API utiliza identificadores de revisión para detectar conflictos de ediciones. Si se conoce el identificador de revisión de una respuesta, carga de página o acción similar anterior en el tiempo, entonces pasa el identificador a la edición. Sin el identificador, no es posible detectar conflictos de ediciones con fiabilidad. En caso de conflicto de ediciones, el solicitante debe obtener un identificador de revisión más reciente para poder continuar. Esto suele conllevar la necesidad de pedir wbgetentities para el elemento en cuestión y luego almacenar (y usar) la revisión de la entrada. En el clúster de Wikimedia, la mayoría de los wikis no ejecutan el conjunto completo de extensiones de Wikibase. Wikimedia Commons tiene su propia Wikibase para las propiedades de los archivos en Commons.

  • No pruebes el valor de info para detectar un error en particular, en su lugar usa el valor de code, ya que seguirá siendo independiente de la localización.

Véase también