API:Etiquette/es

Esta página contiene las buenas prácticas que tendrías que seguir cuándo utilices el API.

Límite de petición
No hay un límite estricto y rápido para las solicitudes de lectura, pero sea considerado e intente no eliminar un sitio. La mayoría de los administradores de sistemas se reservan el derecho de bloquearlo sin ceremonias si pones en peligro la estabilidad de su sitio.

Haciendo tus solicitudes en serie en lugar de en paralelo, esperando a que finalice una solicitud antes de enviar una nueva solicitud, debería resultar en una tasa de solicitud segura. También es recomendado que solicites varios artículos en una sola solicitud:


 * Usar el carácter de canalización siempre que sea posible, por ejemplo , en lugar de hacer una nueva solicitud para cada título.
 * Utilizando un en vez de hacer una petición para cada resultado de otra petición.

Use la compresión GZip al realizar llamadas API configurando  para reducir el uso de ancho de banda.

Análisis de revisiones
Si bien es posible consultar los resultados de un número de revisión específico utilizando el parámetro, esta es una operación costosa para los servidores. Para recuperar una revisión específica, use el parámetro. Por ejemplo:

El parámetro maxlag
Si tu tarea no es interactiva, es decir, un usuario no está esperando el resultado, debes usar el parámetro. El valor del parámetro  debe ser un número entero de segundos. Por ejemplo:

Esto evitará que su tarea se ejecute cuando la carga en los servidores sea alta. Los valores más altos significan comportamiento más agresivo, los valores más bajos son mejores.

Ver para más detalles.

El encabezado User-Agent
Se recomienda establecer un encabezado de agente de usuario descriptivo. Para hacerlo, usa. Por ejemplo en PHP:

No simplemente copies el agente-de-usuario de un navegador web popular. Esto garantiza que si surge un problema, es fácil rastrear dónde se origina.

Si estás llamando a la API desde JavaScript basado en el navegador, es posible que no puedas influir en el encabezado de, dependiendo del navegador. Para evitar esto, usa el encabezamiento.

Consulta m:User-Agent_policy para más detalles.

Formatos de dato
Todos los nuevos usuarios de API. Ver para más detalles.

Rendimiento
Si estás obteniendo resultados más lentamente de lo que deseas, lee las $pautas para ayudarte a pensar en el rendimiento en general.

Si leer a través de la API en lugar de leer directamente desde bases de datos está obstaculizando el rendimiento de su cliente, considere si lo pone en el Toolforge de Wikimedia.

Ver también

 * - La guía de inicio rápida.