API:Etiquette/fr

Lisez également le guide du démarrage rapide. Il répond à certaines questions non répondues ici et contient des liens vers d'autres pages utiles.

Aide

 * 1) Lisez cette FAQ.
 * 2) Essayez de trouver la réponse à votre question dans la documentation de l'API ici, dans le bac à sable de l'API ou sur la page d'accueil auto-documentée de l'API.
 * 3) Si vous ne pouvez pas trouver la réponse à votre question sur le web, vous pouvez poser votre question sur la liste de diffusion de l'API MediaWiki.

Demande de limite
Il n'existe pas de limites codées en dur et rapides pour les requêtes en lecture, mais nous vous demandons de faire bien attention à ne pas bloquer les sites par surcharge. La plupart des administrateurs système se réservent le droit de vous bloquer tout simplement, si vous portez atteinte à la stabilité de leur site.

Si vous faites vos requêtes en série plutôt qu'en parallèle, (c'est à dire que vous attendez qu'une requête se termine avant d'envoyer la suivante, si bien que vous ne faites jamais plus d'une requête à la fois), alors tout devrait définitivement bien se passer. Essayez aussi de regrouper les choses à l'intérieur d'une même requête. Par exemple: spécifiez des titres multiples séparés par '|' dans un paramètre  plutôt que de faire une nouvelle requête pour chaque titre; utilisez un « générateur » au lieu de faire une requête pour chacun des résultats d'une requête précédente.

Analyser les révisions
While it is possible to query for results from a specific revision number, this is an expensive operation for the servers. To retrieve a specific revision use the 'oldid' parameter, example:


 * [//en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759 en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759]
 * [//en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413 en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413]

Utilliser la paramètre maxlag
If your task is not interactive (i.e. a user is not waiting for the result) you should use the maxlag parameter. Ceci empêche votre tâche de s'exécuter quand la charge des serveurs est importante. Les valeurs hautes impliquent un comportement plus aggressif, les valeurs basses sont plus agréables.

Voir:

Entête de l'agent client
Use a descriptive  header that includes your application's name and potentially your email address if appropriate. Do not simply copy the user-agent of a popular web browser (Unless your API client is a JavaScript application running through said web browser via Ajax, in which case one cannot modify the user-agent). This ensures that if a problem does arise it is easy to track down where it originates. Voir m:User-Agent policy pour les détails.

Penser aux performances globales
If you are trying to figure out why you are getting results more slowly than you would like, try to help you think about performance generally. If you are finding that reading via the API rather than directly reading from databases is impeding your client's performance, consider whether to put it into Wikimedia's Toolforge.