API Client
Oficiální TypeScript SDK pro Paragraph CMS. Připojte aplikace pomocí API klíčů k načítání, výpisu, vytváření a aktualizaci obsahu napříč stránkami, kolekcemi a jazyky.
Grzegorz
API Client je oficiální TypeScript SDK pro Paragraph CMS. Poskytuje externím aplikacím přehledný způsob práce s obsahem uloženým v CMS, ať už jde o frontend webu, serverovou integraci nebo interní automatizaci.
Je navržen pro práci s API Keys a představuje hlavní most mezi redakční prací uvnitř Paragraph CMS a aplikacemi, které tento obsah doručují koncovým uživatelům.
K čemu ho týmy používají
API Client je nejužitečnější, když frontend nebo služba potřebuje:
načítat stránky podle slugu, kolekce nebo jazyka,
vypisovat obsah pro sekci, jako je blog nebo oblast dokumentace,
číst kolekce, štítky, stavy, datové modely, jazyky nebo média,
nebo programově vytvářet a aktualizovat obsah.
Díky tomu se přirozeně hodí pro projekty postavené na Next.js, Astro, React Router, Nuxt a SvelteKit.
Propojte ho s API klíčem
Běžné nastavení je jednoduché: vytvořte klíč v Paragraph CMS, přidejte ho do své aplikace a nechte klienta zpracovávat požadavky na veřejné API.
Tím zůstává redakční vrstva a doručovací vrstva oddělená. Týmy mohou spravovat obsah v Pages, Collections a Data Models a poté použít klienta v kódu své aplikace ke čtení nebo aktualizaci tohoto obsahu tam, kde je potřeba.
Blízko redakčnímu workflow
Paragraph CMS také zobrazuje příklady kódu přímo v produktu, což usnadňuje přechod od nastavení obsahu k implementaci. Kolekce, stránky, štítky a stavy mohou všechny přímo podporovat frontend nebo automatizační práci poháněnou klientem.
To je obzvlášť užitečné, když stejný tým spravuje jak strukturu CMS, tak web nebo aplikaci, která ji využívá.
Dobře funguje s dalšími nástroji pro doručování obsahu
API Client je také základní vrstvou pro SEO Client, který ze stejného zdroje obsahu vytváří SEO soubory na úrovni webu, jako jsou sitemapy a feedy.
Podpora kategorií a AI metadat
Veřejné API v1 také zahrnuje operace s kategoriemi pro kolekce a AI pomocníky, kteří generují metadata stránek, hero sekcí a obrázků. To dává integracím možnost zachovat stejné workflow strukturovaného obsahu a metadat i mimo aplikaci.
