API:Etiquette/fr

This page contains the best practices that should be followed when using the API.

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.

Making your requests in series rather than in parallel, by waiting for one request to finish before sending a new request, should result in a safe request rate. It is also recommended that you ask for multiple items in one request by:


 * Using the pipe character whenever possible e.g , instead of making a new request for each title.
 * Using a instead of making a request for each result from another request.

Use GZip compression when making API calls by setting  to reduce bandwidth usage.

Analyser les révisions
Alors qu'il est possible d'obtenir des résultats pour un numéro de révision spécifique, ceci reste une opération coûteuse pour les serveurs. Pour récupérer une révision spécifique utilisez le paramètre 'oldid', exemple :

Utilliser la paramètre maxlag
Si votre tâche n'est pas interactive (c'est à dire que l'utilisateur n'attend pas le résultat) vous devez utiliser le paramètre maxlag. The value of the  parameter should be an integer number of seconds. For example:

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.

See for more details.

Entête de l'agent utilisateur
It is best practice to set a descriptive User Agent header. To do so, use. For example in PHP:

Ne copiez pas simplement l'agent utilisateur d'un navigateur web populaire (à moins que votre client de l'API soit une application JavaScript qui s'exécute au travers du navigateur via Ajax, dans quel cas il est impossible de modifier l'agent utilisateur). Cela assure que si un problème apparait réellement, il est facile de tracer son origine.

If you are calling the API from browser-based JavaScript, you may not be able to influence the  header, depending on the browser. To work around this, use the  header.

Voir m:User-Agent policy pour les détails.

Data formats
All new API users. See for more details.

Performance
Si vous essayez d'imaginer pourquoi vous obtenez les résultats plus lentement que vous ne l'espériez, essayez pour vous aider à penser généralement aux performances.

Si vous pensez que la lecture via l'API plutôt que directement dans la base de données plombe les performances de votre client, considérez s'il ne vaut pas mieux la mettre dans la Toolforge de Wikimedia.