API je rozhraní, přes které si jiná aplikace může sáhnout na obsah vašeho webu — přečíst články, produkty, kategorie, případně obsah zakládat.
Kdy ho budete potřebovat
- Máte mobilní aplikaci, která má zobrazovat vaše články.
- Chcete obsah spravovat tady, ale zobrazovat na webu postaveném jinou technologií (headless režim).
- Napojujete externí systém — sklad, účetnictví, srovnávač.
- Chcete obsah zakládat automaticky z jiného nástroje.
Když nic z toho neplatí, API nepotřebujete a nemusíte se jím zabývat.
Předpoklady
- Tarif musí API povolovat. Zda ho váš tarif má, uvidíte na nástěnce v dlaždici Tarif webu.
- Modul API v CMS musí být zapnutý, viz CMS moduly: co zapnout v menu administrace.
- Musíte mít API klíč, viz API klíče: vytvoření a správa.
Adresa API
Všechny endpointy začínají /api/v1/. Například seznam článků je na /api/v1/articles.
Kdo to bude nastavovat
API se nastavuje v administraci (klíč, oprávnění), ale používá ho vývojář na druhé straně. Vaším úkolem je vytvořit klíč se správnými oprávněními a předat ho bezpečně — ne e-mailem.
