Pokyny pro používání API Wikimedia Foundation
 | Toto pravidlo nebo postup spravuje nadace Wikimedia. Uvědomte si prosím, že v případě jakéhokoli rozdílu ve významu nebo výkladu mezi původní anglickou verzí tohoto obsahu a překladem má přednost původní anglická verze. |
Verze 1.0
Datum: 26. srpna 2024
API
Wikimedia Foundation prosazuje omezení provozovatelů na používání určitých API, včetně, ale bez omezení na MediaWiki Action API, MediaWiki REST API a RESTBase API. Některé z těchto limitů jsou popsány níže. Omezení v těchto zásadách slouží k udržení výkonu a stability našich rozhraní API, k podpoře spravedlivého přidělování serverových zdrojů a k zajištění toho, aby členové komunity mohli používat rozhraní API k podpoře volného pohybu znalostí. Můžete si přečíst časté dotazy (FAQ) o těchto zásadách na Meta-Wiki.
V těchto zásadách je "operátor" definován jako jakákoli osoba, která nasazuje software, který způsobuje volání našich rozhraní API. Jinými slovy, operátor řídí, jak často budou API volána. Patří sem například lidé, kteří na wiki píší "gadgety" (i když je nespouštějí), a lidé, kteří provozují roboty (i když je nenapsali). Pokud toto čtete a hledáte užitečné tipy, jak používat API Wikimedia, pak jste to pravděpodobně vy. Jsou-li pro použití operátorem stanoveny limity, nesmí se tyto limity obcházet. Operátoři jsou například povinni dodržovat všechny pokyny, aby oddálili nebo snížili počet dalších požadavků, které obdrží v odpovědi z API. Konkrétní numerické limity pro jakýkoli koncový bod se mohou čas od času měnit (například jak se mění aktuální a předpokládaná budoucí zátěž).
Při používání rozhraní API Wikimedia musí operátor:
- Dodržovat zásady User-Agent a jinak správně označovat uživatelské agenty;
- Řídit se požadavky na omezení rychlosti (např. oznámení o omezení), které může obdržet a
- Při opětovném publikování stažených dat nebo dat uložených v mezipaměti dodržovat požadavky licencí obsahu.
Při používání rozhraní API Wikimedia operátor nesmí:
- Odesílat provoz prostřednictvím souběžných připojení k API Wikimedia, což má za následek zhoršení služeb ostatním nebo ohrožení stability webu;
- Požadovat data ve vysoké míře, daleko za hranicemi běžných případů použití, například ve špičkách nebo způsobem záměrně určeným k obcházení těchto zásad;
- Rozložit požadavky Wikimedia API na více uživatelských agentů, abyste skryli nadměrné používání jediným operátorem nebo
- Odesílat vysoký provoz pocházející z jednoho zdroje nebo zacílený na konkrétní wiki/zdroj, který nakonec zablokuje ostatní v používání nebo přístupu k tomuto zdroji.
Operátoři by měli naše rozhraní API používat v souladu s pokyny popsanými v těchto zásadách a další technické dokumentaci pro každé rozhraní API. Aby se předešlo pochybnostem, existence těchto zásad nevyžaduje, aby členové komunity Wikimedie získali předchozí povolení od Wikimedia Foundation před použitím API způsobem, který je v souladu s těmito pravidly. Spíše chceme, aby si lidé byli vědomi použití, která by mohla vést k narušení jejich používání API, aby operátoři věděli, jak správně používat sdílené zdroje Wikimedie.
Pokud by váš případ použití mohl spadat mimo meze zde popsané zásady a chtěli byste obdržet výjimku nebo vysvětlení, odešlete žádost na legal
wikimedia.org.
V situacích, kdy limit může ovlivnit použití operátora, může nadace kontaktovat operátora, aby projednal povahu limitů a případné výjimky. To je možné pouze v případě, že skripty operátora dodržují zásady User-Agent a obsahují aktuální kontaktní údaje.
Nadace si vyhrazuje právo prosazovat tuto politiku blokováním přístupu k API, deaktivací programu nebo jakoukoli podobnou akcí. Jakákoli volba, zda v dané situaci podniknout nebo nepodniknout vynucovací opatření, neznamená zřeknutí se jakéhokoli budoucího opatření podle těchto zásad. V situacích, kdy je tato politika prosazována, mohou být jakákoli přijatá opatření zrušena podle uvážení nadace, pokud žádající strana přijme opatření ke snížení způsobené škody nebo nespravedlnosti. Například:
- Snížení rychlosti odesílání požadavků API;
- Implementace exponenciálního ústupu, kdy je operátorovi zasláno oznámení o omezení a v reakci na to automaticky zpomalí rychlost svých požadavků nebo
- Dodržování konvence pojmenování User-Agentem, jak je požadováno v Zásadách User-Agenta, takže vás můžete kontaktovat, pokud se používání stane problematickým.
Sublicencování
Provozovatelé (nebo ti, kteří jednají jejich jménem) nesmějí udělovat sublicence, pronajímat, postoupit nebo zaručit dostupnost nebo funkčnost API spravovaného nadací Wikimedia Foundation žádné třetí straně. Není přípustné implementovat klienta API, který označí bílou barvou způsobem, který zakryje identitu konečného poskytovatele služeb API (Wikimedia Foundation). Aby se předešlo pochybnostem, tento termín nijak neomezuje používání a publikování obsahu Wikimedie v souladu s bezplatnými licencemi, na základě kterých je obsah licencován.
Ukončení podpory rozhraní API
Nadace může vyřadit nebo upravit rozhraní API. Operátoři, kteří používají rozhraní API po oznámeném datu ukončení služby, by měli očekávat, že rozhraní API bude nedostupné bez dalšího varování nebo že dojde k výraznému snížení výkonu. Očekává se, že operátoři budou aktualizovat, aby používali vhodné alternativy před datem ukončení služby. Nadace může poskytnout upozornění týkající se aktualizací a ukončení podpory rozhraní API na kontaktní informace, které jsou poskytovány v souladu s požadavky na User Agenta.
Úpravy těchto zásad
Tyto zásady jsou veřejným shrnutím některých současných omezení, která nadace Wikimedia Foundation ukládá provozovatelům ohledně jejich používání API Wikimedia. Jako taková může Wikimedia Foundation upravit zásady podle svého uvážení tak, aby přesněji popisovaly současné limity nebo odrážely budoucí změny.
Související
- diskuse na Meta-Wiki (srpen–září 2023)