Jump to content

Wikimedia Foundation API Usage Guidelines

From Wikimedia Foundation Governance Wiki
This page is a translated version of the page Policy:API usage guidelines and the translation is 86% complete.
Outdated translations are marked like this.

Versión 1.0

Fecha: 26 de agosto, 2024

API

La Fundación Wikimedia establece límites al uso de ciertas API por parte de operadores. Esto incluye, sin limitarse, a la API de MediaWiki Action, a la API MediaWiki REST, y a la API RESTBase. Más adelante, describiremos algunos de estos límites. Los límites que establece esta política existen para mantener el rendimiento y la estabilidad de nuestras APIs, para promover justa distribución de recursos del servidor, y para asegurar que los miembros de la comunidad puedan usar las API para expandir el avance del movimiento del conocimiento libre. Más adelante, encontrará una sección de Preguntas más Frecuentes sobre esta política.

Nuestra política define a un "operador" como cualquier persona que despliegue algún software que provoque una respuesta de nuestras API. En otras palabras, el operador controla la frecuencia de llamadas a nuestras APIs. Esto incluye, por ejemplo, a las personas que crean "gadgets" en la wiki (aunque no se ejecuten), y a las personas que despliegan bots (aún si no los han creado ellos mismos). Si al leer estas líneas busca consejos útiles para utilizar las APIs de Wikimedia, probablemente usted se cuente entre estas personas. Si se imponen límites al uso de algún operador, este no podrá eludirlos. Por ejemplo, se requiere que los operadores obedezcan toda instrucción de diferir o reducir la cantidad de solicitudes adicionales que reciben como parte de una respuesta de una API. Los límites numéricos específicos en cualquier endpoint podrían cambiar de tanto en tanto (por ejemplo, a medida que cambian las cargas actuales y las que se prevén en el futuro).

Al usar las APIs de Wikimedia, todo operador debe:

  1. Cumplir la política de Agente de Usuario y etiquetar correctamente a los agentes de usuario;
  2. Cumplir las solicitudes de limitación de frecuencia (es decir, notificaciones de limitación de datos) que pueda recibir; y
  3. Cumplir los requisitos de licencias de contenido, al volver a publicar datos descargados o almacenados en la caché.

Al usar las APIs de Wikimedia, los operadores no deben:

  1. Enviar tráfico mediante conexiones concurrentes a las API de Wikimedia, que resulten en la degradación del servicio para otros, o que pongan en peligro la estabilidad del dominio;
  2. Solicitar datos en gran cantidad, muy por encima de casos regulares de uso, ya sea en picos de uso, o de una manera intencionada que busque evadir esta política;
  3. Distribuir solicitudes a las API de Wikimedia desde múltiples usuarios de agente para enmascarar el uso excesivo de un solo operador; o
  4. Enviar tráfico elevado que se origine de una sola fuente, o esté dirigido a una wiki o un recurso en específico, y que termine impidiendo que otros usen o accedan a dicho recurso.

Los operadores deberán utilizar nuestras APIs respetando las directrices descritas en esta política, y en la documentación técnica de cada API. Para despejar dudas, se aclara que la existencia de esta política no implica que los miembros de la comunidad Wikimedia deban obtener permiso previo de la Fundación Wikimedia para usar las APIs de manera consistente con la misma. Por el contrario, queremos que las personas conozcan los tipos de uso que podrían interrumpir su uso de la API, para que los operadores sepan cómo usar correctamente los recursos compartidos de Wikimedia.

Si su caso de uso estuviera fuera de los límites de la política descrita aquí, y quiere obtener una excepción o una aclaración, por favor envíe una solicitud a legal@wikimedia.org.

En caso de que un límite afectará al uso de un operador, la Fundación podrá ponerse en contacto con el operador para conversar sobre la naturaleza del límite impuesto, y cualquier excepción que pueda resultar necesaria. Esto solo es posible si el código del operador cumple con la política de Agente de Usuario e incluye información de contacto actualizada.

La Fundación se reserva el derecho de hacer cumplir esta política, bloqueando el acceso a la API, deshabilitando algún programa, u otra acción similar. La decisión de realizar, o no, una acción ejecutiva en una situación dada, no significará renuncia a cualquier acción futura bajo esta política. En situaciones en las que se aplique la política, cualquier medida puede ser levantada a discreción de la Fundación, si la parte solicitante toma medidas para reducir el daño o la injusticia causada, como por ejemplo:

  • Reducir la frecuencia de envío de solicitudes API;
  • Implementar un retroceso exponencial, para que al enviarse una notificación de limitación al operador, en respuesta éste reduzca automáticamente la frecuencia de sus solicitudes; o
  • Seguir las convenciones para los nombres de Agente de Usuario, como se requiere en la política de Agente de Usuario, para poder contactar a quien haga uso problemático.

Sub-licenciamiento

Los operadores (o quienes actúan en su nombre) no pueden sublicenciar, arrendar, asignar o garantizar la disponibilidad o funcionamiento de alguna API gestionada por la Fundación Wikimedia a favor de cualquier tercero. No se permite implementar un cliente API que disimule la identidad del proveedor final de las APIs (la Fundación Wikimedia). Para despejar dudas, se aclara que esta condición no limita el uso ni la republicación de contenidos de Wikimedia, en cumplimiento de las licencias libres bajo las cuales se ha licenciado su contenido.

Retiro de las APIs

La Fundación podrá retirar o modificar las APIs. Los operadores que utilicen APIs más allá de la fecha de finalización del servicio anunciada, deberían esperarse que la API deje de tener acceso sin advertencia, o que experimente una fuerte degradación en su rendimiento. Se espera una actualización en los operadores, que les lleve a utilizar alternativas apropiadas antes de la fecha de conclusión de servicio. La Fundación podrá notificar sobre actualizaciones y degradación de las APIs, utilizando la información de contacto provista, de acuerdo a los requisitos del Agente de Usuario.

Modificaciones a esta política

Esta política es un listado público de algunas de las limitaciones actuales que la Fundación Wikimedia impone a los operadores, en relación a su uso de las APIs Wikimedia. En ese sentido, la Fundación Wikimedia puede modificar a discreción la política, para describir más a cabalidad los límites actuales, o reflejar cambios futuros.

Véase también