API Client
Officiële TypeScript SDK voor Paragraph CMS. Verbind apps met API-sleutels om content op te halen, te tonen, aan te maken en bij te werken over pagina's, collecties en landinstellingen heen.
Grzegorz
De API Client is de officiële TypeScript SDK voor Paragraph CMS. Het biedt externe apps een overzichtelijke manier om te werken met content die in de CMS is opgeslagen, of dat nu een website-frontend, een server-side integratie of een interne automatisering is.
Het is ontworpen om te werken met API-sleutels, en het vormt de belangrijkste brug tussen redactioneel werk binnen Paragraph CMS en de applicaties die die content aan eindgebruikers leveren.
Waar teams het voor gebruiken
De API Client is het meest nuttig wanneer een frontend of service het volgende nodig heeft:
pagina's ophalen op basis van slug, collectie of landinstelling,
content tonen voor een sectie zoals een blog of documentatiegedeelte,
collecties, labels, statussen, datamodellen, landinstellingen of media lezen,
of content programmatisch aanmaken en bijwerken.
Dat maakt het een natuurlijke keuze voor projecten die zijn gebouwd met Next.js, Astro, React Router, Nuxt en SvelteKit.
Koppel het met een API-sleutel
De gebruikelijke opzet is eenvoudig: maak een sleutel aan in Paragraph CMS, voeg deze toe aan je applicatie en laat de client verzoeken naar de publieke API afhandelen.
Zo blijven het redactionele oppervlak en het afleveroppervlak van elkaar gescheiden. Teams kunnen content beheren in Pagina's, Collecties en Datamodellen, en vervolgens de client in hun app-code gebruiken om die content te lezen of bij te werken waar die nodig is.
Dicht bij de redactionele workflow
Paragraph CMS toont ook codevoorbeelden binnen het product, waardoor het makkelijker wordt om van contentopzet naar implementatie te gaan. Collecties, pagina's, labels en statussen kunnen allemaal direct doorstromen naar frontend- of automatiseringswerk dat door de client wordt aangedreven.
Dit is vooral nuttig wanneer hetzelfde team zowel de CMS-structuur beheert als de site of app die daarvan gebruikmaakt.
Werkt goed met andere leveringstools
De API Client vormt ook de basislaag voor de SEO Client, die SEO-bestanden op siteniveau zoals sitemaps en feeds opbouwt vanuit dezelfde contentbron.
Ondersteuning voor categorieën en AI-metadata
De publieke v1 API bevat ook categoriehandelingen voor collecties en AI-hulpmiddelen die metadata genereren voor pagina's, hero's en afbeeldingen. Dit geeft integraties een manier om dezelfde gestructureerde content- en metadataworkflows ook buiten de app beschikbaar te houden.
