API Client
Oficiální TypeScript SDK pro Paragraph CMS. Propojte aplikace pomocí API klíčů a načítejte, vypisujte, vytvářejte a aktualizujte obsah napříč stránkami, kolekcemi a lokalizacemi.
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 tak, aby fungoval s API Keys, a je hlavním mostem 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 lokalizace,
vypisovat obsah pro sekci, jako je blog nebo oblast dokumentace,
číst kolekce, štítky, stavy, datové modely, lokalizace 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 pomocí API klíče
Obvyklé 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ůstane redakční vrstva a doručovací vrstva oddělená. Týmy mohou spravovat obsah v Pages, Collections a Data Models, a pak 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 ukázky kódu přímo v produktu, což usnadňuje přechod od nastavení obsahu k implementaci. Kolekce, stránky, štítky a stavy mohou přímo podporovat práci na frontendu nebo automatizaci poháněnou klientem.
To je obzvlášť užitečné, když stejný tým spravuje jak strukturu CMS, tak web nebo aplikaci, která z něj čerpá obsah.
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.
