Como gerenciar as chaves de API da sua conta
Proprietários, admins e gerentes podem acessar a aba de chaves de API.
Como acessar e gerenciar as chaves de API da sua conta Klaviyo.
Se você quiser saber como criar ou clonar uma chave de API privada, leia como criar chaves de API privadas.
Diferença entre chaves de API públicas e privadas
A chave de API pública é conhecida como ID do site. Ela é formada por um valor alfanumérico curto. Esta chave pública é um identificador exclusivo da sua conta Klaviyo, e há apenas 1 por conta. Você pode incluir sua chave pública de API no código do site. Isso não concede permissão para ler dados privados da conta.
As chaves de API privadas permitem que aplicativos leiam ou alterem dados na sua conta Klaviyo, como listas, de acordo com as permissões (escopos) que você selecionar. Trate as chaves de API privadas como senhas: mantenha-as em um local seguro e nunca as exponha ao público. Uma conta Klaviyo pode gerar quantas chaves de API privadas forem necessárias.
O que fazer se sua chave de API for exposta
Sua chave de API pública deve ser usada em código de sites públicos. Ela não permite que alguém leia dados privados da conta, mas pode ser usada para enviar dados por meio de APIs do cliente, como eventos e atualizações de perfil.
Mantenha as chaves de API privadas em sigilo. Alguém com uma chave privada pode usar as permissões dela para visualizar ou editar dados do cliente.
Se uma chave de API privada for exposta, exclua-a imediatamente e, em seguida, crie uma nova chave de API privada. Atualize cada aplicativo que usou a chave exposta para usar a nova chave. Conceda à chave de substituição apenas as permissões de que o aplicativo precisa e use uma chave de API privada diferente para cada aplicativo.
Encontre suas chaves de API
Copie ou faça o download de uma chave de API privada quando você a criar, antes de sair da página de confirmação. Você não poderá ver a chave completa novamente mais tarde. Armazene-a com segurança, como em um cofre ou gerenciador de senhas, e compartilhe-a apenas com pessoas ou organizações em que você confia. Se você não salvou a chave, crie uma nova chave ou clone a existente.
- Clique no nome da sua conta no canto inferior esquerdo.
- Clique em Configurações.
- Selecione a aba chaves de API .
- Visualize sua chave de API pública (ID do site).
- Em Chaves de API privadas, revise os nomes das chaves e os níveis de acesso. Você pode identificar uma chave pelos 4 últimos caracteres, mas não pode ver nem copiar a chave completa aqui.
Se uma chave não estiver na guia Com atividade, verifique Sem atividade ou Desativado se essas guias aparecerem.
Como clonar chaves de API privadas
Quando você clona chaves de API privadas existentes, a chave clonada:
- Seja uma chave totalmente diferente da original.
- Use o mesmo nome do original.
- Ter os mesmos escopos do original, exceto pelos escopos obsoletos que não são mais compatíveis.
A clonagem mantém a chave original no lugar. Copie ou baixe a chave clonada e armazene-a com segurança. Para usá-la em um aplicativo, atualize as configurações desse aplicativo com a nova chave. Exclua a chave original quando ela não for mais necessária.
Excluir uma chave de API privada
Excluir uma chave de API privada não pode ser desfeito. As solicitações de API que a utilizam deixarão de funcionar. Se você estiver substituindo uma chave que não foi exposta, atualize e teste os aplicativos que a utilizam antes de excluí-la. Se a chave estiver exposta, exclua-a imediatamente.
- Abra a guia chaves de API usando as etapas acima. Em Chaves de API privadas, encontre a chave que você quer excluir.
- Abra o menu de três pontos ao lado da chave e selecione Excluir.
- Clique em Excluir na caixa de diálogo de confirmação.
Recursos adicionais
- How to create or clone a private API key
Learn how to create a private API key, which is a unique identifier used for API calls, as well as define a scope.
- Understanding how information is exchanged between Klaviyo and apps
Learn about how information syncs between Klaviyo and your third-party apps via an application programming interface (API). Most data exchanged via a Klaviyo integration is one-way: data is pulled into your Klaviyo account so you can leverage a broad scope of your customer's data.
- Klaviyo's API reference guide