Wikibase/API/nl



Wat is de Wikibase API?
Wikibase biedt een algemeen mechanisme om statements op te slaan als gestructureerde data. De statements voor productie-items op de server wikidata.org. Lees Wikidata: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:


 * Een key  met een boolean waarde, die als integer gebruikt kan worden als het verzoek gelukt is. Als de integer nul is, dan kunnen de aanvullende waarden verkeerd zijn.
 * Een  key met een object van twee of drie keys, ,   en  , als de aanvraag mislukt is.
 * Informatie over de actie. De informatie wordt op het hoogste niveau doorgegeven of onder item als het een of meerdere items zijn. Bij meerdere items heeft elk item een eigen ID.

Lege objecten worden als JSON arrays teruggeven, dus niet als objecten, lege parameters verwijderen de actuele waarde van het 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. Het foutformaat komt overeen met dat van de MediaWiki Action API. Legacy formaat fouten en waarschuwingen.

Alle foutteksten van de Wikibase modules dienen internationaal (i18n) en lokaal gemaakt (l10n) te worden. De taal van de ingelogde gebruiker is de standaardtaal bij foutteksten, dit kan aangepast worden (override) door  toe te voegen aan de URL query string.



Aanvullende opmerkingen

 * Veel Wikimedia wiki's gebruiken de extensie Wikibase Client. Hiermee kunnen API clients op die wiki de  meta submodule gebruiken om de URL's van de volledige Wikibase repo te bepalen, en de   property submodule gebruiken voor het verkrijgen van Wikidata informatie over pagina's op de lokale wiki.
 * Op de Wikibase kunnen de Gregoriaanse kalender (Q1985727) en de Juliaanse kalender (Q1985786) worden gebruikt.
 * De API gebruikt de revisie-ID's om conflicterende bewerkingen te herkennen. Als er zo'n 'edit collision'' is, dan moet bij de aanvraag een nieuwere revisie aanvragen. Dit gaat dan over het verzoeken van  voor het gevraagde item, en dan het opslaan (en gebruiken) van de bijbehorende revisie.
 * Op elke MediaWiki installatie kan Wikibase worden uitgevoerd. Op het Wikimedia cluster zullen de meeste wiki's niet alle extensies van Wikibase gebruiken. Wikimedia Commons heeft een eigen Wikibase voor de eigenschappen van de bestanden op Commons.
 * Test de waarde van  op een bepaalde fout, gebruik de waarde , deze waarde wordt niet vertaald.



Zie ook

 * - De verkorte instructie voor de MediaWiki Action API.
 * - Veel gestelde vragen over de MediaWiki Action API.
 * - Een tutorial over hoe de MediaWiki Action API gebruikt moet worden.
 * Download Wikidata database dumps in JSON (recommended), XML en RDF formaten.