Wikibase/API/ru



Что такое Wikibase API?
Wikibase предоставляет общий механизм хранения утверждений в виде структурированных данных. Утверждения об элементах находятся на сервере wikidata.org. Смотрите Wikidata:Glossary для объяснения этих терминов.



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

Он предоставляется через набор расширений для модулей MediaWiki API. Так что чтобы использовать его, вам следует быть несколько осведомлёнными на тему сетевого API MediaWiki: действия, query-запросы и так далее, а также с общими параметрами, такими как  и.



Как пользоваться 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.



Запрос формата
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,  tells the API to get the data for Wikibase entities. For meta and property submodules, use  and   respectively.

Некоторые параметры доступны практически всегда. Формы множественного числа используются в случаях, когда параметр может принимать список из нескольких значений.

GET request
Explanation of each part of the URL:


 * is the main endpoint.
 * tells the API to get the data for Wikibase entities.
 * means get the data from English Wikipedia.
 * indicates the title of the page to get data from.
 * indicates properties to get from the entities, in this case the property is the descriptions of the entities.
 * means filter the results down to the English language.
 * indicates JSON output, which is the recommended output format.

Ответ
Ответ на запрос обычно состоит из:


 * A  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  key with an object of two, optionally three keys, ,   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.


 * Обратите внимание, что пустые объекты возвращаются как массивы JSON, а не как объекты JSON.
 * Обратите внимание, что при указании пустых параметров содержимое самого свойства объекта удаляется.



Meta submodules

 * wikibase:
 * wbcontentlanguages:

Property submodules

 * pageterms:
 * wbentityusage:



Модули API

 * 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:



Возможные ошибки
Возможные ошибки для всех модулей можно найти, используя. The error format corresponds to that of the MediaWiki Action API. See API:Errors and warnings#Legacy format.

Все сообщения об ошибках в модулях Wikibase должны быть интернационализованы (i18n) и локализованы (l10n). Язык текущего вошедшего в учётную запись пользователя будет использоваться по умолчанию в сообщениях об ошибках, но вы можете переопределить язык, добавив  в URL-строке запроса.



Дополнительная информация

 * Многие вики Wikimedia задействуют расширение Wikibase Client. Это позволяет клиентам API запрашивать мета подмодуль, чтобы определить ссылку на полный репо Wikibase, а подмодуль свойства   - возвращать информацию Wikidata о страницах в локальной вики.
 * С Wikibase могут использоваться Григорианская(Q1985727) и Юлианская(Q1985786) модели календарей.
 * API использует идентификаторы версий для обнаружения конфликтов редактирования. Если конфликт редактирования уже обнаружен, запрашивающий должен получить идентификатор более новой версии, чтобы получить возможность продолжить. Для этого обычно запрашивается  для соответствующей записи, а из ответа считывается (и используется) идентификатор версии.
 * Wikibase может использоваться в каждой системе MediaWiki. На кластере Викимедиа, большинство вики не выполняют весь набор расширений Wikibase. Викисклад обладает собственным Wikibase для свойств файлов.
 * Не тестируйте значение  на определенную ошибку, используйте вместо этого значение , так как оно останется неизменным вне зависимости от локализации.



См. также

 * - Руководство для быстрого начала работы с MediaWiki Action API.
 * - Часто задаваемые вопросы о MediaWiki Action API.
 * - Самоучитель о том, как использовать MediaWiki Action API.
 * Скачать дампы базы Викиданных в форматах JSON (рекомендуется), XML и RDF.