Policy:Wikimedia Foundation API Usage Guidelines/zh
维基媒体政策 |
---|
维基媒体项目 |
基金会理事会与成员 |
其他 |
版本 1.0
日期:2024 年 8 月 26 日
API
維基媒體基金會對操作者使用某些 API 實作限制,包括但不限於 MediaWiki Action API、MediaWiki REST API 和 RESTBase API。其中一些限制如下所述。這些限制的存在是為了維護 API 的效能和穩定性,促進伺服器資源的公平分配,並確保社群成員可以使用 API 進一步推動自由知識運動。您可以在下面「常見問題與解答」部份閱讀有關此政策的常見問題。
就本政策而言,「操作者」的定義是為部署軟件導致我們的 API 被調用的任何人士。換句話說,操作者控制使用 API 的頻率。舉個例子,這包括在維基專案上編寫「小工具」的人士(即使他們並不操作這些小工具),以及運行機器人的人士(即使他們並不編寫機器人程式)。如果您正在閱讀本文,並在尋找如何使用維基媒體API的實用技巧,那麽這可能就是「您」。如果對操作者的使用施加限制,他們不得規避這些限制。例如,操作員必須遵循所有說明,以延遲或降低他們在 API 回應中收到的進一步請求速率。任何端點的具體數值限制可能會不時變化(例如,當前和預測的未來負載變化)。
使用維基媒體 API 時,操作者必須:
- 遵循用戶代理媒介政策並以其他方式正確標記用戶代理媒介;
- 遵循您可能收到的速率限制請求(如限制通知);和
- 重新發佈下載或快取的資料時,請遵循內容許可的要求。
使用維基媒體 API 時,操作者不得:
- 透過並發連接向維基媒體 APIs 發送流量,導致其他人的服務品質下降或危及網站的穩定性;
- 以遠遠超出常見用例的高速率請求數據,例如以峰值請求或故意規避此政策的方式;
- 將維基媒體 API 請求分散到多個用戶代理媒介,以隱藏單一操作者的過度使用;或者
- 發送來自單一來源或針對特定維基/資源的極高用量請求,最終阻止其他人使用或存取該資源。
操作者應按照本政策和每個 API 的其他技術文件中描述的指南使用我們的 API。為避免疑義,本政策的存在並不要求維基媒體社群成員在以符合本政策的方式使用 API 之前獲得維基媒體基金會的事先許可。相反,我們希望人們意識到可能會導致其 API 使用中斷的用途,以便操作者知道如何正確使用維基媒體的共享資源。
如果您的使用案例可能超出此處所述的政策範圍,並且您希望收到例外許可或澄清,請向 legalwikimedia.org 提交請求。
在有關限制可能影響操作者使用的情況下,維基媒體基金會可能會與操作者聯系,討論限制的性質以及可能需要的例外情況。這只適用於在操作者的腳本遵守用戶代理媒介政策並包含最新聯系信息的情況下。
維基媒體基金會保留透過阻止 API 存取、停用程式或任何類似操作來執行此政策的權利。在特定情況下選擇採取或不採取執行行動,並不表示放棄今後根據本政策採取的任何行動。在執行本政策的情況下,如果請求方採取行動減少所造成的傷害或不公平,維基媒體基金會可酌情決定取消所採取的任何行動。例如:
- 降低發送 API 請求的速率;
- 實施指數回退,即向操作者發送節流通知,操作員者會自動降低請求速度以作為回應;或
- 依照用戶代理媒介政策的要求,遵循用戶代理媒介命名約定,以便在使用出現問題時可以聯絡您
子許可
操作者(或代表操作者行事的人士)不得向任何第三方再授權、租賃、轉讓或保證維基媒體基金會管理的 API 的可用性或功能。不允許以掩蓋 API 最終服務提供者(維基媒體基金會)身分的方式實作白標籤 API 用戶端。為避免疑義,該術語不會限制維基媒體內容根據內容許可的自由許可的使用和重新發佈。
停用 APIs
維基媒體基金會可能會停用或修改 API。在宣佈的服務終止日期之後使用 API 的操作者應該預計 API 將在沒有進一步警告的情況下不可使用,或者效能會顯著下降。預計操作者會在服務終止日期之前更新以使用適當的替代方案。維基媒體基金會可能會根據用戶代理媒介要求提供的聯絡資訊提供有關 API 更新和停用的通知。
有關本政策的修改
本政策是維基媒體基金會目前對操作者使用維基媒體 API 施加的一些限制的公開總結。因此,維基媒體基金會可以酌情修改該政策,以更全面地描述當前限制或反映未來的變化。
另见
- The discussion on Meta-Wiki (August-September 2023)