Resumo
As chaves de API permitem que seus aplicativos, scripts e serviços de backend acessem as APIs do Astra com segurança, sem a necessidade de o usuário fazer login pela interface web todas as vezes. Este artigo explica o que são as chaves de API, como criá-las e usá-las, e como gerenciar ou revogar chaves existentes.
Instruções
O que é uma chave de API?
Uma chave de API é uma credencial secreta que começa com sk_live_. Ela permite que seu aplicativo se autentique e faça solicitações às APIs do Astra de forma programática.
As chaves de API são comumente usadas quando você precisa de uma conexão entre sistemas que é executada automaticamente, sem interação do usuário.
Casos de uso recomendados
As chaves de API são ideais quando você deseja:
Sincronizar leads qualificados do Astra com seu CRM automaticamente.
Criar painéis personalizados extraindo dados de conversas e leads do Astra.
Acionar fluxos de trabalho de negócios quando um agente de IA capturar um novo lead.
Enviar dados de conversas para sistemas internos de análise ou relatórios.
Quando não usar chaves de API
As chaves de API não são recomendadas para aplicativos voltados ao público, onde cada usuário precisa conceder acesso à sua própria conta.
Nesses casos, use a autenticação OAuth.
Como criar uma chave de API
Para criar uma nova chave de API:
Faça login na sua conta Astra.
Vá para Configurações (Settings) > Chaves de API (API Keys).
Clique em Criar chave de API (Create API Key).
Insira um nome descritivo para a chave, como Sincronização CRM Produção.
Clique em Criar (Create).
Importante: salve sua chave de API imediatamente
Após a criação da chave, o Astra exibe a chave de API completa apenas uma vez.
Certifique-se de copiar e salvar a chave em um local seguro antes de fechar a notificação ou sair da página.
Posteriormente, o Astra exibirá apenas um prefixo abreviado da chave para fins de identificação. A chave completa não poderá ser visualizada novamente.
Como usar uma chave de API
Depois de criar uma chave de API, adicione-a ao seu aplicativo, script ou integração.
Ao fazer solicitações de API, inclua a chave no cabeçalho de autorização da solicitação, geralmente como um token Bearer.
Uma vez configurado, seu aplicativo poderá acessar as APIs do Astra com segurança, sem exigir que os usuários façam login por um navegador.
Gerenciar chaves de API existentes
A página Chaves de API (API Keys) exibe informações sobre todas as chaves ativas.
Coluna | Descrição |
Nome | O nome atribuído à chave de API durante a criação |
Prefixo da chave | Os primeiros caracteres da chave de API, usados para identificar a chave |
Criado | A data e a hora em que a chave foi criada |
Último uso | O momento mais recente em que a chave foi usada; permanece em branco se a chave nunca tiver sido usada |
Como revogar uma chave de API
Você pode precisar revogar uma chave de API se:
A chave foi exposta ou compartilhada involuntariamente
Uma integração não é mais necessária
Um membro da equipe com acesso à chave deixou a organização
Você está rotacionando credenciais como parte de um processo de segurança
Para revogar uma chave de API:
Localize a chave na lista de Chaves de API (API Keys).
Clique na opção Excluir (Delete).
Confirme a ação.
O que acontece após a revogação?
A chave de API torna-se inválida imediatamente.
Qualquer aplicativo, script ou integração que use essa chave não poderá mais acessar as APIs do Astra até que uma nova chave válida seja configurada.
Melhores práticas de segurança ao trabalhar com chaves de API
Siga estas recomendações para manter suas chaves de API seguras:
Nunca inclua chaves de API em códigos de frontend ou do lado do cliente.
Armazene as chaves de API em um gerenciador de segredos seguro ou em uma variável de ambiente.
Use chaves de API separadas para ambientes de teste e de produção.
Rotacione as chaves de API regularmente.
Revogue chaves não utilizadas ou obsoletas.
Se uma chave de API for comprometida, revogue-a imediatamente e crie uma nova.
Did this answer your question?