Endpointy pro obsah: články, stránky, kategorie a štítky

Tato část dokumentace popisuje jednotlivé adresy API, přes které se pracuje s obsahem webu. Najdete tu, jak se čtou a zapisují články a stránky, jak se k nim přiřazují kategorie, štítky a autoři a jak se pracuje s obrázky a vlastními poli. Popis je psaný pro programátora, který napojení staví, i pro správce webu, který potřebuje vědět, co je vůbec možné zadat. U každé operace je uvedeno, jaká data odcházejí a co se vrací zpět.

Endpointy kopírují to, jak systém pracuje s obsahem uvnitř. Máte tři základní typy položek: stránky, články a katalog produktů. Ke každé se váže titulek, obsah, metadata pro vyhledávače, obrázky, autor a stav publikace. Souhrnný seznam operací je v článku API: co všechno jde přečíst a zapsat, přesné tvary požadavků a odpovědí pak v REST API specifikaci v1.

Při zápisu se často zapomíná na dvě věci. První je struktura, do které obsah patří. Kategorie a navigace mají svoje pravidla a je dobré si je přečíst v části navigace a kategorie, protože článek zapsaný bez zařazení se na webu nemusí objevit tam, kde ho čekáte. Druhá je stav položky. Zápis přes API nemusí znamenat okamžité zveřejnění, obsah může zůstat v přípravě nebo mít naplánované datum.

Co se ptáte nejčastěji

Jde přes API zakládat i upravovat, nebo jen číst? Podporované je čtení i zápis, včetně úprav existujících položek. Co konkrétně smíte, závisí na oprávnění přístupu, které rozebírá text API: přihlášení a oprávnění.

Můžu si posílat vlastní údaje, které v systému standardně nejsou? Na to slouží parametry a vlastní pole. Nejdřív pole nastavte v administraci, potom je plňte přes API.

Jak poznám, že zápis prošel? Odpověď obsahuje identifikátor položky a její stav. Když něco chybí nebo je ve špatném tvaru, vrací se chybový kód s popisem pole, kterého se to týká.

Kde se dá zkontrolovat výsledek? Nejrychlejší je otevřít výpis v sekci články a podívat se na položku tak, jak ji vidí redaktor.