Wikibase/API/fr



Qu'est-ce que l'API Wikibase ?
Wikibase fournit un mécanisme général pour sauvegarder des déclarations en tant que données structurées. Les déclarations concernant les éléments se trouvent sur le serveur wikidata.org. Voir wikidata:Glossary pour plus d'explications sur Wikibase et d'autres concepts.



L'API Wikibase permet d'interroger, d'ajouter, de supprimer et de modifier les informations de Wikidata ou de tout autre instance de Wikibase.

Il est fourni via un ensemble d'extensions aux modules API MediaWiki. Donc, pour utiliser l'API Wikibase, vous devez avoir les connaissances de base concernant l'API MediaWiki Action : actions, requêtes, etc., ainsi que les paramètres génériques tels que  et.



Comment utiliser l'API Wikibase
Envoyer les requêtes à l'API avec le protocole HTTP, comme pour l'API Action de MediaWiki. Voir le tutoriel Comment utiliser l'APIpour toute information concernant l'utilisation de l'API Action de MediaWiki.



Format de la requête
Le point d'accès de l'API est https://wikidata.org/w/api.php.

Dans la chaîne de la requête, ajoutez le paramètre action qui indique à l'API l'action à réaliser. Par exemple  indique à l'API de récupérer les données pour les entités Wikibase. Pour les sous-modules de meta et des propriétés, utiliser respectivement  et.

Certains paramètres sont presque toujours disponibles. Les formes plurielles sont utilisées dans les cas où un paramètre peut prendre plusieurs valeurs. Les paramètres sont :



Une requête simple


Requête GET
Détail de chaque partie de l'URL :


 * est le point d'accès principal.
 * indique à l'API de récupérer les données pour les entités Wikibase.
 * indique qu'il faut obtenir les données de la Wikipedia anglophone.
 * indique le titre de la page pour laquelle on souhaite obtenir les données.
 * 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.
 * indique le format de sortie JSON, qui est le format de sortie recommandé.

Réponse
La réponse à la requête contient généralement :


 * Une clé  avec une conversion booléenne sous forme d'entier si la demande aboutit. Si l'entier est zéro, toute valeur supplémentaire peut être erronée.
 * Une clé  avec un objet de deux, éventuellement trois clés, ,   et  , si la demande échoue.
 * Informations sur l'action. Les informations sont soit transmises au niveau supérieur, soit sous « élément » s'il s'agit d'un seul élément ou « éléments » s'il en est plusieurs. S'il s'agit de plusieurs éléments, chacun se trouve sous une clé avec son propre identifiant d'élément.

Les objets vides sont retournés en tant que tableaux JSON et non en tant qu'objets, tandis que les paramètres vides « suppriment » l'entrée réelle de l'élément.



Documentation de l'API et modules de Wikibase


Sous-modules de Meta

 * wikibase:
 * wbcontentlanguages:



Sous-modules des propriétés

 * pageterms:
 * wbentityusage:



Modules de l'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:



Erreurs possibles
Des erreurs possibles pour n'importe quel module peuvent être trouvées en utilisant. Le format de l'erreur est celui de l'API Action de MediaWiki. Voir l'Ancien format des erreurs et avertissements de l'API.

Tous les messages d'erreur des modules Wikibase doivent être internationalisés (i18n) et localisés (l10n). La langue de l'utilisateur connecté sera la langue par défaut pour les messages d'erreur, mais vous pouvez la remplacer en ajoutant  à la chaîne de requête URL.



Notes supplémentaires

 * De nombreux wikis Wikimedia exécutent Wikibase Client extension. Cela permet aux clients API sur eux d'interroger le sous-module de méta  pour déterminer les URL pour le dépôt Wikibase complet, et le sous-module de propriété   pour obtenir des informations Wikidata sur les pages du wiki local.
 * Les modèles de calendriers pouvant être utilisés dans Wikibase sont le calendrier grégorien (Q1985727) et le calendrier Julien (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.
 * Toute installation MediaWiki peut exécuter Wikibase. Sur le cluster Wikimedia, la plupart des wikis n'utilisent pas l'ensemble complet d'extensions Wikibase. Wikimedia Commons possède sa propre Wikibase pour les propriétés des fichiers sur Commons.
 * Do not test the  value for a particular error, instead use the   value as this will remain independent of localization.



Voir aussi

 * - Le guide de démarrage rapide pour l'API Action de MediaWiki.
 * - Questions fréquentes à propos de l'API Action MediaWiki.
 * - Un tutoriel sur comment utiliser l'API Action de MediaWiki.
 * Download Wikidata database dumps in JSON (recommended), XML and RDF formats.