API Client

API Client to oficjalne SDK TypeScript dla Paragraph CMS. Daje 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 pracy z API Keys i stanowi główny pomost między pracą redakcyjną wewnątrz Paragraph CMS a aplikacjami, które dostarczają te treści użytkownikom końcowym.

Do czego używają go zespoły

API Client jest najbardziej przydatny, gdy frontend lub usługa musi:

• pobierać strony według slugu, kolekcji lub ustawień regionalnych,

• wyświetlać listy treści dla sekcji takiej jak blog lub obszar dokumentacji,

• odczytywać kolekcje, etykiety, statusy, modele danych, ustawienia regionalne lub media,

• albo programowo tworzyć i aktualizować treści.

Dzięki temu jest naturalnym wyborem dla projektów zbudowanych przy użyciu Next.js, Astro, React Router, Nuxt i SvelteKit.

Połącz go za pomocą klucza 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 oddzielić warstwę redakcyjną 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.

Okno dialogowe utworzonego klucza API w Paragraph CMS pokazujące jednorazową wartość klucza i przycisk kopiowania.

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 wdrożenia. 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 niego korzysta.

Okno dialogowe przykładów kodu w CMS Paragraph do korzystania z treści za pośrednictwem klienta API.

Dobrze współpracuje z innymi narzędziami do dostarczania treści

API Client jest także warstwą bazową dla SEO Client, który tworzy pliki SEO na poziomie witryny, takie jak mapy witryn i kanały, z tego samego źródła treści.

Obsługa kategorii i metadanych AI

Publiczne API v1 obejmuje także operacje na kategoriach dla kolekcji oraz pomocniki AI, które generują metadane strony, sekcji hero i obrazów. Daje to integracjom możliwość zachowania tych samych ustrukturyzowanych treści i przepływów pracy z metadanymi także poza aplikacją.

Powiązane

• API Keys

• SEO Client

• Collections

• SDK resources