Wikibase/API/nl



Wat is de Wikibase API?
Wikibase biedt een algemeen mechanisme om statements op te slaan als gestructureerde data. De statements over productie-items op de server voor wikidata.org. Lees Wikidatum:Glossary voor meer informatie over Wikibase en andere concepten.



De Wikibase API is voor het opvragen, toevoegen, verwijderen en bewerken van informatie op Wikidata of een andere Wikibase instantie.

Het wordt verkregen met een aantal extensies voor MediaWiki API-modules. Om de API Wikibase te gebruiken moet u dus redelijk bekend zijn met de MediaWiki Action API: o.a. acties en opvragingen, als ook de generieke parameters zoals  en.



Hoe de Wikibase API te gebruiken?
Stuur verzoeken naar de API via HTTP, gelijk als bij de MediaWiki Action API. In deze Tutorial staat hoe de MediaWiki Action API te gebruiken is.



Formaat verzoeken
Het eindpunt voor de API is https://wikidata.org/w/api.php.

Voeg in de query string de parameter action toe, die geeft de API aan welke actie er uitgevoerd moet worden. Voorbeeld: met  wordt aangegeven dat de API de gegevens voor de Wikibase entiteiten moet ophalen. Voor 'meta' en 'property' submodules, gebruik dan  resp. .

Enkele parameters zijn bijna altijd beschikbaar. 'Plural forms' worden gebruikt in gevallen waar een parameter meerdere waarden kan hebben. De parameters zijn:



GET request
Uitleg van de delen van de URL:


 * is het 'main endpoint', het uitvoerende programma.
 * geeft aan dat de API de gegevens voor de Wikibase entiteiten moet ophalen.
 * geeft aan dat de gegevens uit de Engelse Wikipedia moeten komen.
 * is de titel van de pagina waar de gegevens staan.
 * geeft de attributen (properties) van de entiteiten aan die opgehaald moeten worden, in dit geval de beschrijvingen (descriptions) van de entiteiten.
 * geeft aan dat de resultaten gefilterd moeten worden op de taal Engels.
 * geeft het uitvoerformaat aan, in dit geval het aanbevolen formaat JSON.

Antwoord
Het antwoord zal doorgaans bevatten:


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

Empty objects are returned as JSON arrays and not as objects, while empty parameters remove the actual entry from the item.



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:



Mogelijke fouten
Om eventuele fouten te vinden, gebruik de module. 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.



Zie ook

 * - De verkorte instructie voor de 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 en RDF formaten.