Client API
SDK TypeScript ufficiale per Paragraph CMS. Collega le app con chiavi API per recuperare, elencare, creare e aggiornare contenuti tra pagine, raccolte e impostazioni locali.
Grzegorz
Il Client API è l'SDK TypeScript ufficiale per Paragraph CMS. Offre alle applicazioni esterne un modo pulito per lavorare con i contenuti archiviati nel CMS, che si tratti del frontend di un sito web, di un'integrazione lato server o di un'automazione interna.
È progettato per funzionare con le chiavi API ed è il ponte principale tra il lavoro editoriale all'interno di Paragraph CMS e le applicazioni che distribuiscono quei contenuti agli utenti finali.
A cosa lo usano i team
Il Client API è particolarmente utile quando un frontend o un servizio deve:
recuperare pagine per slug, raccolta o impostazione locale,
elencare contenuti per una sezione come un blog o un'area documentazione,
leggere raccolte, etichette, stati, modelli di dati, impostazioni locali o media,
oppure creare e aggiornare contenuti in modo programmatico.
Questo lo rende una scelta naturale per i progetti sviluppati con Next.js, Astro, React Router, Nuxt e SvelteKit.
Collegalo con una chiave API
La configurazione tipica è semplice: crea una chiave in Paragraph CMS, aggiungila alla tua applicazione e lascia che il client gestisca le richieste all'API pubblica.
In questo modo la superficie editoriale e quella di distribuzione rimangono separate. I team possono gestire i contenuti in Pagine, Raccolte e Modelli di dati, quindi usare il client nel codice della loro app per leggere o aggiornare quei contenuti dove necessario.
Vicino al flusso di lavoro editoriale
Paragraph CMS mostra anche esempi di codice all'interno del prodotto, rendendo più semplice passare dalla configurazione dei contenuti all'implementazione. Raccolte, pagine, etichette e stati possono alimentare direttamente il lavoro sul frontend o le automazioni basate sul client.
Questo è particolarmente utile quando lo stesso team gestisce sia la struttura del CMS sia il sito o l'app che lo utilizza.
Funziona bene con altri strumenti di distribuzione
Il Client API è anche il livello di base per il SEO Client, che genera file SEO a livello di sito come sitemap e feed dalla stessa fonte di contenuti.
Supporto per categorie e metadati AI
L'API pubblica v1 include anche operazioni sulle categorie per le raccolte e helper AI che generano metadati per pagine, hero e immagini. Questo offre alle integrazioni un modo per mantenere disponibili all'esterno dell'app gli stessi flussi di lavoro per contenuti strutturati e metadati.
