Dokumentace API redakčního systému

V této části najdete technickou dokumentaci k REST API redakčního systému. Je rozdělená na tři části: základy s přihlášením a oprávněními, endpointy pro obsah a headless provoz, kdy se obsah spravuje v administraci a vykresluje jinde. Hodí se kodérům a vývojářům, kteří potřebují obsah načítat nebo zapisovat z jiné aplikace, a provozovatelům více webů, kteří chtějí publikování zautomatizovat. Texty popisují konkrétní požadavky, odpovědi a chybové stavy, aby se dalo napojení postavit bez hádání.

API se hodí ve chvíli, kdy obsah nevzniká jen ručně v administraci. Typicky se řeší přenos článků z jiného systému, plnění katalogu z podnikového skladu nebo web, jehož vzhled si někdo staví po svém. Než začnete psát první požadavek, projděte si text API: k čemu slouží a kdy ho potřebujete. Popisuje situace, ve kterých se napojení vyplatí, i ty, kdy vystačí běžná práce v administraci a programátora vůbec nepotřebujete.

Technický popis adres, hlaviček, formátů odpovědí a chybových kódů je v REST API specifikaci v1. To je dokument pro programátora, který napojení staví. Přehled toho, co je vůbec možné číst a zapisovat, tedy články, stránky, kategorie, štítky a média, najdete v článku API: co všechno jde přečíst a zapsat.

Chcete obsah spravovat v administraci a zobrazení si postavit vlastními silami? Pak začněte u headless režimu, který vysvětluje dělení odpovědnosti mezi systém a vaši aplikaci.

Časté otázky

Musím být programátor, abych mohl publikovat? Ne. Články, stránky i katalog se dají odvést celé v administraci, API je nadstavba pro automatizaci a napojení.

Potřebuju API na pravidelný export dat? Pro strojové výstupy do porovnávačů a dalších služeb je jednodušší nastavit datové feedy.

Jak se API chová u více webů pod jednou licencí? Přístup se váže na konkrétní web a na oprávnění uživatele, takže jedny přístupové údaje nemusí vidět všechny weby v účtu. Podrobnosti jsou v části o základech a autentizaci.

Kde získám pomoc při napojení? Konkrétní dotazy k požadavkům a odpovědím řešte přes podporu, popis funkcí a tarifů najdete v ceníku.