Wikibase/API/uk

Що таке Вікібаза API?
Wikibase забезпечує загальний механізм зберігання тверджень як структурованих даних. Твердження щодо елементів розміщуються на сервері за адресою wikidata.org. Докладнішу інформацію про Wikibase та інші поняття див. Вікідані:Глосарій.



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

Wikibase API надається через набір розширень для модулів API MediaWiki. Отже, щоб використовувати API Wikibase, ви повинні добре знати MediaWiki Action API: дії, запити тощо, а також загальні параметри, такі як  і.

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,  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.

Response
Відповідь на запит зазвичай міститиме:


 * Ключ  із зведенням boolean до цілого числа, якщо запит успішний. Якщо ціле число дорівнює нулю, будь-які додаткові значення можуть бути помилковими.
 * An  key with an object of two, optionally three keys, ,   and  , if the request is unsuccessful.
 * Інформація про дію. Інформація передається або на верхньому рівні, або в розділі item, якщо це один елемент, або items, якщо їх кілька. Якщо є декілька елементів, кожен знаходиться за ключем зі своїм ідентифікатором елемента.

Порожні об'єкти повертаються як масиви JSON, а не як об'єкти, тоді як порожні параметри видаляють фактичний запис із елемента.

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:

Можливі помилки
Можливі помилки для будь-якого модуля можна знайти за допомогою. 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  to the URL query string.

Additional notes
Wikimedia Commons has its own Wikibase for properties of the files on Commons.
 * Many Wikimedia wikis run the Wikibase Client extension. This lets API clients on them to query the  meta submodule to determine URLs for the full Wikibase repo, and the   property submodule to get some Wikidata information about pages on the local wiki.
 * The calender models that can be used with Wikibase are the Gregorian calendar(Q1985727) and the Julian calendar(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  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.
 * Do not test the  value for a particular error, instead use the   value as this will remain independent of localization.

Див. також

 * - The quick start guide for the MediaWiki Action API.
 * - Frequently asked questions about the MediaWiki Action API.
 * - A tutorial on how to use the MediaWiki Action API.
 * Download Wikidata database dumps in JSON (recommended), XML and RDF formats.