Cliente da API
SDK oficial TypeScript para o Paragraph CMS. Conecte aplicativos com chaves de API para buscar, listar, criar e atualizar conteúdo em páginas, coleções e localidades.
Grzegorz
O Cliente da API é o SDK oficial TypeScript do Paragraph CMS. Ele oferece aos aplicativos externos uma forma simples de trabalhar com o conteúdo armazenado no CMS, seja isso um frontend de site, uma integração do lado do servidor ou uma automação interna.
Ele foi projetado para funcionar com chaves de API e é a principal ponte entre o trabalho editorial dentro do Paragraph CMS e os aplicativos que entregam esse conteúdo aos usuários finais.
Para que as equipes o usam
O Cliente da API é mais útil quando um frontend ou serviço precisa:
buscar páginas por slug, coleção ou localidade,
listar conteúdo para uma seção como um blog ou área de documentação,
ler coleções, rótulos, status, modelos de dados, localidades ou mídia,
ou criar e atualizar conteúdo de forma programática.
Isso o torna uma escolha natural para projetos criados com Next.js, Astro, React Router, Nuxt e SvelteKit.
Conecte-o com uma chave de API
A configuração habitual é simples: crie uma chave no Paragraph CMS, adicione-a ao seu aplicativo e deixe o cliente lidar com as solicitações para a API pública.
Isso mantém separadas a superfície editorial e a superfície de entrega. As equipes podem gerenciar conteúdo em Pages, Collections e Data Models e, em seguida, usar o cliente no código do aplicativo para ler ou atualizar esse conteúdo onde ele for necessário.
Próximo ao fluxo de trabalho editorial
O Paragraph CMS também exibe exemplos de código dentro do produto, o que facilita a passagem da configuração do conteúdo para a implementação. Coleções, páginas, rótulos e status podem alimentar diretamente o trabalho de frontend ou automação com tecnologia do cliente.
Isso é especialmente útil quando a mesma equipe é responsável tanto pela estrutura do CMS quanto pelo site ou aplicativo que a consome.
Funciona bem com outras ferramentas de entrega
O Cliente da API também é a camada base do SEO Client, que gera arquivos de SEO em nível de site, como sitemaps e feeds, a partir da mesma fonte de conteúdo.
Suporte para categorias e metadados de IA
A API pública v1 também inclui operações de categoria para coleções e auxiliares de IA que geram metadados de página, hero e imagem. Isso oferece às integrações uma forma de manter os mesmos fluxos de trabalho de conteúdo estruturado e metadados disponíveis fora do aplicativo.
