Chaves de API

Gerencie as chaves de API do Paragraph CMS por organização para conectar apps, sites e automações. Crie, renomeie, pesquise e exclua chaves com segurança.

GrzegorzGrzegorz
Chaves de API

As Chaves de API permitem que aplicações externas se conectem ao Paragraph CMS sem usar o painel diretamente. Elas são gerenciadas por organização e funcionam como o ponto de passagem entre as operações de conteúdo e o código de entrega.

Este é o recurso que as equipes usam quando querem conectar um site, app, automação ou SDK, como o API Client ou o SEO Client.

Crie chaves para integrações reais

A visualização de Chaves de API fica na área de configurações do desenvolvedor e foi projetada para permanecer simples:

  • criar uma nova chave,

  • pesquisar chaves existentes,

  • renomear uma chave,

  • e excluir uma chave que não é mais necessária.

A tabela mostra o nome da chave, quando ela foi criada e seu limite de taxa, o que facilita manter as integrações organizadas à medida que um workspace cresce.

Captura de tela a adicionar: /screenshots/features/api-keys-settings-table.png
Mostrar a página de configurações de Chaves de API com o nome da chave, data de criação, limite de taxa e ações de editar ou excluir.
Alt: Tabela de configurações de Chaves de API do Paragraph CMS mostrando nomes de chaves, datas de criação e limites de taxa.
Legenda: As chaves de API são gerenciadas por organização na área de configurações do desenvolvedor.

Mostrada uma vez após a criação

Depois que uma chave é criada, o Paragraph CMS mostra o valor bruto em um diálogo dedicado com um botão de copiar. Essa é a única vez em que o segredo completo é exibido, então as equipes devem salvá-lo imediatamente onde sua aplicação possa usá-lo.

Atualmente, novas chaves começam sem expiração e usam um limite de taxa padrão de 5 req/s, o que é um ponto de partida sensato para a maioria das integrações.

Diálogo de chave de API criada do Paragraph CMS com valor da chave exibido uma única vez e botão de copiar.
Diálogo de chave de API criada do Paragraph CMS com valor da chave exibido uma única vez e botão de copiar.

O ponto de conexão para entrega

As Chaves de API são o que conectam o trabalho editorial dentro do Paragraph CMS à entrega em produção fora dele. As equipes gerenciam conteúdo no CMS e depois passam uma chave de API para a aplicação que precisa de acesso a esse conteúdo.

Isso faz das Chaves de API um recurso pequeno com importância desproporcional, especialmente quando combinado com o API Client, o SEO Client e guias de frameworks como Next.js Quickstart.

Relacionado

Veja o Paragraph CMS em ação

Explore o Paragraph CMS ao vivo e descubra como ajuda a criar, gerir e publicar conteúdo mais depressa.