API Client
Officiële TypeScript SDK voor Paragraph CMS. Verbind apps met API-sleutels om content op te halen, weer te geven, 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 duidelijke manier om te werken met content die in het 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 Keys, 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 nuttigst wanneer een frontend of service het volgende moet doen:
pagina's ophalen op slug, collectie of landinstelling,
content weergeven voor een sectie zoals een blog of documentatiegedeelte,
collecties, labels, statussen, datamodellen, landinstellingen of media lezen,
of content programmatisch aanmaken en bijwerken.
Daardoor past het uitstekend bij projecten die zijn gebouwd met Next.js, Astro, React Router, Nuxt en SvelteKit.
Verbind het met een API-sleutel
De gebruikelijke opzet is eenvoudig: maak een sleutel aan in Paragraph CMS, voeg die toe aan je applicatie en laat de client verzoeken aan de openbare API afhandelen.
Zo blijven het redactionele oppervlak en het leveringsoppervlak gescheiden. Teams kunnen content beheren in Pages, Collections en Data Models, 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, wat het eenvoudiger maakt 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 handig wanneer hetzelfde team zowel de CMS-structuur als de site of app beheert die daar gebruik van maakt.
Werkt goed met andere leveringstools
De API Client is ook de basislaag voor de SEO Client, die SEO-bestanden op siteniveau zoals sitemaps en feeds opbouwt vanuit dezelfde contentbron.
