API Client
Offizielles TypeScript-SDK für Paragraph CMS. Verbinden Sie Apps mit API-Schlüsseln, um Inhalte über Seiten, Sammlungen und Gebietsschemas hinweg abzurufen, aufzulisten, zu erstellen und zu aktualisieren.
Grzegorz
Der API Client ist das offizielle TypeScript-SDK für Paragraph CMS. Er bietet externen Apps eine klare Möglichkeit, mit im CMS gespeicherten Inhalten zu arbeiten, sei es für ein Website-Frontend, eine serverseitige Integration oder eine interne Automatisierung.
Er ist für die Arbeit mit API-Schlüsseln konzipiert und bildet die wichtigste Brücke zwischen der redaktionellen Arbeit innerhalb von Paragraph CMS und den Anwendungen, die diese Inhalte an Endnutzer ausliefern.
Wofür Teams ihn verwenden
Der API Client ist besonders nützlich, wenn ein Frontend oder Dienst Folgendes benötigt:
Seiten nach Slug, Sammlung oder Gebietsschema abzurufen,
Inhalte für einen Bereich wie einen Blog oder eine Dokumentationssektion aufzulisten,
Sammlungen, Labels, Status, Datenmodelle, Gebietsschemata oder Medien zu lesen,
oder Inhalte programmgesteuert zu erstellen und zu aktualisieren.
Das macht ihn zu einer naheliegenden Wahl für Projekte, die mit Next.js, Astro, React Router, Nuxt und SvelteKit erstellt wurden.
Mit einem API-Schlüssel verbinden
Die übliche Einrichtung ist einfach: Erstellen Sie einen Schlüssel in Paragraph CMS, fügen Sie ihn Ihrer Anwendung hinzu und lassen Sie den Client Anfragen an die öffentliche API verarbeiten.
Dadurch bleiben die redaktionelle Oberfläche und die Auslieferungsoberfläche getrennt. Teams können Inhalte in Pages, Collections und Data Models verwalten und dann den Client in ihrem App-Code verwenden, um diese Inhalte dort zu lesen oder zu aktualisieren, wo sie benötigt werden.
Nah am redaktionellen Workflow
Paragraph CMS stellt auch Codebeispiele innerhalb des Produkts bereit, was den Wechsel von der Inhaltseinrichtung zur Implementierung erleichtert. Sammlungen, Seiten, Labels und Status können alle direkt in Frontend- oder Automatisierungsarbeit einfließen, die vom Client unterstützt wird.
Das ist besonders nützlich, wenn dasselbe Team sowohl die CMS-Struktur als auch die Website oder App besitzt, die sie nutzt.
Funktioniert gut mit anderen Auslieferungstools
Der API Client ist auch die Basisschicht für den SEO Client, der SEO-Dateien auf Website-Ebene wie Sitemaps und Feeds aus derselben Inhaltsquelle erstellt.
