API:REST API/cs

MediaWiki Core REST API vám umožňuje komunikovat s MediaWiki odesíláním požadavků HTTP na  adresy URL. Rozhraní API můžete použít k vytváření aplikací a skriptů, které vyhledávají a zobrazují stránky wiki, získávají mediální soubory a prozkoumávají historii stránek.



Rychlý start
$ curl



Formát dat
Koncové body REST API vracejí data ve formátu JSON nebo HTML. Typ obsahu podporovaný každým koncovým bodem najdete v odkazu na rozhraní API.

Metody
Rozhraní API podporuje standardní metody požadavků HTTP.



Struktura URL
Koncové body API sdílejí konzistentní strukturu URL, která zahrnuje základní URL wiki, cestu skriptu wiki a verzi API.

Verzování
MediaWiki REST API, navržené tak, aby poskytovalo vývojářům dlouhodobou stabilitu, je verzováno pomocí globálního čísla verze v cestě API (například: ). Podle principů sémantického verzování se verze zvýší, když se koncový bod změní zpětně nekompatibilním způsobem, jako je odstranění vlastnosti odezvy nebo přidání požadovaného parametru. V rámci hlavní verze se API může změnit zpětně kompatibilními způsoby, jako je přidání vlastnosti odezvy nebo volitelného parametru požadavku.



Oprávnění a autorizace
REST API je navrženo pro použití s rozšířením pro ověřování a autorizaci uživatelů. Bez ohledu na metodu ověřování však API reaguje na přítomnost přihlášeného uživatele a vrací obsah odpovídající oprávněním tohoto uživatele.



Přístup k projektům Wikimedie pomocí REST API
REST API můžete použít pro přístup k Wikipedii, Wikislovníku a dalším projektům Wikimedie ve více jazycích. Úplný seznam adres URL projektů Wikimedie naleznete v matici stránek Meta-Wiki.



Limit požadavku
Neexistuje žádný pevný limit pro požadavky na API, ale váš klient může být zablokován, pokud ohrozíte stabilitu webu. Chcete-li zůstat v bezpečné míře požadavků, počkejte na dokončení každého požadavku, než odešlete další požadavek.



Identifikace klienta
Stránky Wikimediea vyžadují HTTP hlavičku User-Agent pro všechny požadavky API. To pomáhá identifikovat vaši aplikaci a zajišťuje, že vás v případě problému mohou kontaktovat správci systému. Klienti, kteří zadávají požadavky bez hlavičky User-Agent, mohou být bez upozornění blokováni IP adresou.

Záhlaví User-Agent může obsahovat uživatelskou stránku na místní wiki, uživatelskou stránku na související wiki používající syntaxi propojení interwiki, URL pro relevantní externí web nebo e-mailovou adresu.

Pokud voláte API z JavaScriptu založeného na prohlížeči, možná nebudete moci, v závislosti na prohlížeči, ovlivnit hlavičku User-Agent. Chcete-li to obejít, použijte hlavičku. Další informace naleznete v zásadách uživatelského agenta Meta-Wiki.

Autorizace
Chcete-li své aplikaci udělit oprávnění jednat jménem uživatele, postupujte podle příručky pro vývojáře OAuth, zaregistrujte svou aplikaci a odešlete požadavky pomocí tokenů OAuth.



Licence a ochranné známky
Obsah Wikimedia lze znovu použít v rámci podmínek stanovených příslušnou licencí. Licence se mohou v jednotlivých projektech lišit, takže informace o licencích a opětovném použití obsahu naleznete u jednotlivých projektů. Například anglický text Wikipedie lze použít za podmínek Creative Commons Attribution Share-Alike licence, zatímco mediální soubory na Wikimedia Commons jsou licencovány jednotlivě, jak je uvedeno na informační stránce souboru. Další informace o licencování a používání ochranných známek naleznete v pokynech pro vývojáře aplikací Meta-Wiki.



Omezení Wikidat
Zatímco REST API je k dispozici na projektech Wikimedie, není plně podporováno Wikidaty. V době psaní mohou některé koncové body vracet neočekávané chyby.



Koncové body rozšíření
Rozšíření MediaWiki mohou zobrazovat koncové body API specifické pro rozšíření pomocí rozhraní REST API. Chcete-li začít, přečtěte si dokumenty rozšíření rozhraní REST API. Dokumentaci pro koncové body REST API poskytované rozšířeními naleznete v dokumentech rozšíření. Rozhraní rozšíření REST API je standardně dostupné na přes  a na  a novější.



Srovnání API


O těchto dokumentech
Tyto dokumenty jsou napsány ručně na základě. Opravy a doplnění jsou vítány To share a tutorial or app that uses the MediaWiki REST API, add a link to the REST API template.