Klient API
Oficjalne SDK TypeScript dla Paragraph CMS. Łącz aplikacje za pomocą kluczy API, aby pobierać, listować, tworzyć i aktualizować treści na stronach, w kolekcjach i ustawieniach regionalnych.
Grzegorz
Klient API to oficjalne SDK TypeScript dla Paragraph CMS. Zapewnia zewnętrznym aplikacjom przejrzysty sposób pracy z treściami przechowywanymi w CMS-ie, niezależnie od tego, czy chodzi o frontend strony internetowej, integrację po stronie serwera, czy wewnętrzną automatyzację.
Został zaprojektowany do współpracy z kluczami API i stanowi główny pomost między pracą redakcyjną wewnątrz Paragraph CMS a aplikacjami dostarczającymi te treści użytkownikom końcowym.
Do czego używają go zespoły
Klient API jest najbardziej przydatny, gdy frontend lub usługa musi:
pobierać strony według sluga, kolekcji lub ustawień regionalnych,
wyświetlać listę treści dla sekcji takiej jak blog lub dokumentacja,
odczytywać kolekcje, etykiety, statusy, modele danych, ustawienia regionalne lub media,
albo programowo tworzyć i aktualizować treści.
Dzięki temu świetnie pasuje do projektów zbudowanych z użyciem Next.js, Astro, React Router, Nuxt i SvelteKit.
Połącz go z kluczem API
Typowa konfiguracja jest prosta: utwórz klucz w Paragraph CMS, dodaj go do swojej aplikacji i pozwól klientowi obsługiwać żądania do publicznego API.
Pozwala to zachować rozdzielenie warstwy redakcyjnej od warstwy dostarczania treści. Zespoły mogą zarządzać treściami w Pages, Collections i Data Models, a następnie używać klienta w kodzie aplikacji do odczytywania lub aktualizowania tych treści tam, gdzie są potrzebne.
Blisko procesu redakcyjnego
Paragraph CMS udostępnia także przykłady kodu wewnątrz produktu, co ułatwia przejście od konfiguracji treści do implementacji. Kolekcje, strony, etykiety i statusy mogą bezpośrednio zasilać frontend lub automatyzacje oparte na kliencie.
Jest to szczególnie przydatne, gdy ten sam zespół odpowiada zarówno za strukturę CMS-a, jak i za stronę lub aplikację, która z niej korzysta.
Dobrze współpracuje z innymi narzędziami do dostarczania treści
Klient API stanowi także warstwę bazową dla SEO Client, który buduje pliki SEO na poziomie witryny, takie jak mapy witryny i kanały, z tego samego źródła treści.
