Cliente API
SDK oficial de TypeScript para o Paragraph CMS. Conecte apps com chaves de API para buscar, listar, criar e atualizar conteúdo em páginas, coleções e localidades.
Grzegorz
O Cliente API é o SDK oficial de TypeScript para o Paragraph CMS. Ele oferece aos aplicativos externos uma forma clara 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 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 programaticamente.
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 usual é 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 a superfície editorial e a superfície de entrega separadas. As equipes podem gerenciar conteúdo em Páginas, Coleções e Modelos de Dados, e depois usar o cliente no código do app 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 transição 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 app que a consome.
Funciona bem com outras ferramentas de entrega
O Cliente API também é a camada base do Cliente SEO, que cria arquivos de SEO no nível do site, como sitemaps e feeds, a partir da mesma fonte de conteúdo.
