Richtlinien der Wikimedia Foundation zur API-Nutzung
Diese Richtlinie oder dieses Verfahren wird von der Wikimedia-Stiftung verwaltet. Bitte beachte, dass im Falle von Unterschieden in der Bedeutung oder Interpretation zwischen der englischen Originalversion dieses Inhalts und einer Übersetzung die englische Originalversion Vorrang hat. |
Version 1.0
Datum: 26. August 2024
API
Die Wikimedia Foundation limitiert die Nutzung bestimmter APIs durch Operator:innen, etwa der MediaWiki-Action-API, der MediaWiki-REST-API und der RESTBase-API. Einige dieser Begrenzungen werden unterhalb beschrieben. Die Begrenzungen aus dieser Richtlinie dienen dazu, die Leistung und Stabilität unserer APIs zu erhalten, die faire Verteilung der Server-Ressourcen zu fördern und um sicherzustellen, dass Community-Mitglieder die APIs nutzen können, um die Bewegung für freies Wissen voranzubringen. Du kannst dir die häufig gestellten Fragen (FAQs) über diese Richtlinie im Meta-Wiki durchlesen.
Für diese Richtlinie sind „Operator:innen“ als Personen definiert, die Software einsetzen, die unsere APIs aufruft. Anders gesagt kontrollieren Operator:innen, wie oft die APIs aufgerufen werden. Dies umfasst beispielsweise Personen, die „Helferlein“ (Gadgets) onwiki anbieten (auch wenn sie diese nicht selbst ausführen), und Personen, die Bots betreiben (auch wenn sie diese nicht geschrieben haben). Wenn du das hier liest und nützliche Hinweise zur Nutzung der Wikimedia-APIs suchst, bist du das wahrscheinlich. Wenn die Begrenzungen auf die Nutzung durch Operator:innen zutreffen, dürfen diese sie nicht umgehen. Beispielsweise müssen Operator:innen alle Anleitungen zur Verlangsamung oder Reduzierung der zukünftigen Anfragenrate befolgen, die sie als Antwort von einer API erhalten. Die genauen Werte der Begrenzungen können sich an jedem Endpunkt regelmäßig ändern (beispielsweise weil sich die aktuelle und die voraussichtliche zukünftige Last ändern).
Bei der Nutzung von Wikimedia-APIs müssen Operator:innen:
- Die User-Agent-Richtlinie befolgen und User-Agents korrekt benennen;
- etwaigen Aufforderungen zur Reduzierung der Anfragenrate (bspw. Drosselungsbenachrichtigungen) nachkommen;
- die Anforderungen der Inhaltslizenzen bei der Wiederveröffentlichung von heruntergeladenen oder gecachten Daten befolgen.
Bei der Nutzung von Wikimedia-APIs dürfen Operator:innen nicht:
- Über mehrere gleichzeitige Verbindungen auf Wikimedia-APIs zugreifen, was zu einer Verschlechterung der Dienste für andere führt oder die Stabilität der Website bedroht;
- umfangreichen Datenanfragen weit jenseits üblicher Anwendungsfälle stellen, etwa in Ausschlägen oder auf eine Weise, um diese Richtlinie gezielt zu umgehen;
- Wikimedia-API-Anfragen auf mehrere User-Agents verteilen, um übermäßige Nutzung durch einzelne Operator:innen zu verschleiern;
- erhöhte Zugriffszahlen, die aus einer einzelnen Quelle stammen oder auf ein einzelnes Wiki / eine einzelne Ressource abzielen, generieren, sodass andere daran gehindert werden, diese Ressource zu nutzen oder darauf zuzugreifen.
Operator:innen sollten unsere APIs im Rahmen der hier beschriebenen Richtlinien und der zusätzlichen technischen Dokumentation jeder API verwenden. Zur Verdeutlichung: Diese Richtlinie verlangt nicht, dass Mitglieder der Wikimedia-Community zur Nutzung der APIs in Übereinstimmung mit der Richtlinie eine vorherige Genehmigung der Wikimedia Foundation einholen. Vielmehr möchten wir, dass allen mögliche Nutzungen bewusst sind, die ihre API-Nutzung stören könnten, sodass Operator:innen wissen, wie sie die gemeinsamen Ressourcen von Wikimedia sinnvoll nutzen können.
Wenn dein Anwendungsfall möglicherweise nicht in den Rahmen der hier beschriebenen Richtlinie fällt und du gerne eine Ausnahmegenehmigung oder weitere Erklärungen möchtest, stelle bitte eine Anfrage an legal wikimedia.org.
In Situationen, in denen eine Begrenzung die Nutzung durch Operator:innen beeinflusst, kann die Foundation betroffene Operator:innen kontaktieren, um die Art der Begrenzungen und eventuell benötigte Ausnahmen zu besprechen. Das ist nur möglich, wenn die Skripte der Operator:innen sich an die User-Agent-Richtlinie halten und aktuelle Kontaktinformationen enthalten.
Die Foundation hat das Recht, diese Richtlinie durch Sperrung des API-Zugangs, Deaktivierung eines Programms oder ähnliche Maßnahmen durchzusetzen. Die Entscheidung, in einer bestimmten Situation eine solche Durchsetzungsmaßnahme zu ergreifen oder darauf zu verzichten, lässt keinen Rückschluss auf zukünftige Durchsetzungen dieser Richtlinie zu. Wenn diese Richtlinie durchgesetzt wird, können ergriffene Maßnahmen nach freiem Ermessen der Foundation aufgehoben werden, wenn die interessierte Partei den Schaden oder die entstandene Unfairness aktiv reduziert. Zum Beispiel:
- Reduzierung der API-Aufrufrate;
- Einsatz eines exponentiellen Backoffs, bei dem Operator:innen eine Drosselungsbenachrichtigung erhalten, woraufhin sie die Aufrufrate automatisch verlangsamen;
- Befolgung der Vorgaben zur Benennung von User-Agents, wie in der User-Agent-Richtlinie vorgesehen, sodass du kontaktiert werden kannst, wenn deine Nutzung ein Problem wird.
Unterlizenzierung
Operator:innen (oder deren Vertreter:innen) dürfen die Verfügbarkeit oder Funktionalität einer von der Wikimedia Foundation bereitgestellten API nicht an Dritte unterlizenzieren, vermieten oder garantieren. Es ist nicht zulässig, unter eigenem Namen einen API-Client bereitzustellen, der die Identität des tatsächlichen Dienstanbieters (der Wikimedia Foundation) verschleiert. Zur Verdeutlichung: Diese Vorschriften schränken die Nutzung und Weiterveröffentlichung von Wikimedia-Inhalten gemäß den Vorgaben der freien Lizenzen, unter denen die Inhalte stehen, in keiner Weise ein.
Auslaufende APIs
Die Foundation kann APIs auslaufen lassen oder verändern. Operator:innen, die APIs über das angekündigte Auslaufdatum hinaus nutzen, sollten davon ausgehen, dass die API ohne weitere Vorwarnung unzugänglich werden oder deutliche Leistungseinbußen erleben kann. Es wird erwartet, dass Operator:innen vor dem Auslaufdatum Aktualisierungen vornehmen und auf geeignete Alternativen umsteigen. Die Foundation kann Benachrichtigungen zu Aktualisierungen und zukünftigen Abschaltungen von APIs an die Kontaktinformationen gemäß den Vorgaben für User-Agents bereitstellen.
Änderungen an dieser Richtlinie
Diese Richtlinie ist eine öffentliche Zusammenfassung einiger aktueller Begrenzungen, die die Wikimedia Foundation gegenüber Operator:innen, die Wikimedia-APIs nutzen, handhabt. In diesem Sinne kann die Wikimedia Foundation die Richtlinie nach freiem Ermessen ändern, um bestehende Begrenzungen besser zu beschreiben oder zukünftige Änderungen einzubeziehen.
Siehe auch
- Die Diskussion auf Meta (August-September 2023)