Como criar ou clonar uma chave de API privada
Você precisa ser Proprietário ou Administrador para criar, clonar ou excluir uma chave de API privada.
O que você vai aprender
Saiba como criar uma chave de API privada, que é um identificador exclusivo usado para chamadas de API, e também definir um escopo.
Tanto as chaves de API privadas quanto os escopos ajudam você a proteger os seus dados e os dados dos seus clientes ao limitar o que terceiros podem acessar.
Sobre chaves de API privadas e escopos
Quando você faz uma chamada de API, ela permite que um software se conecte a outro. Essa conexão permite que um software solicite, edite ou adicione informações ao outro.
Uma chave de API privada garante que essa solicitação tenha as permissões corretas (ou seja, que ela veio de um usuário, conta ou programa autorizado). Pense nisso como uma chave de casa: ela permite que você e sua família entrem, mas mantém todos os outros do lado de fora.
Incluir um escopo para uma chave de API privada adiciona outra camada de autorização, limitando quais elementos específicos um terceiro pode acessar. Os escopos são como a chave de um hotel, que só dá acesso a certas áreas (como seu quarto ou a academia) e não ao prédio inteiro.
Tipos de escopos
Ao criar uma chave de API privada, você precisa selecionar o escopo dela. Em outras palavras, você precisa decidir se quer que um terceiro:
- Não ter acesso a um ponto de extremidade da API.
- Ver todos os dados de um ponto de extremidade de API, mas não conseguir fazer alterações (também chamado de "somente leitura").
- Crie, exclua e faça outras alterações em qualquer item associado a esse ponto de extremidade (também chamado de “acesso total” ou “acesso de gravação”).
Por exemplo, digamos que você queira adicionar assinantes a uma lista da Klaviyo a partir de um software de terceiros. Nesse caso, você deve ter acesso total (de gravação) aos pontos de extremidade da API para listas, perfis e inscrição em massa de perfis. No entanto, o terceiro não precisa de acesso a nenhum outro ponto de extremidade.
Você pode saber mais sobre as APIs da Klaviyo e ver os escopos disponíveis para cada ponto de extremidade no portal do desenvolvedor.
Antes de começar
Observe o seguinte:
- Depois de criar uma chave de API privada, você não pode:
- Veja a chave de API privada novamente.
- Dica: salve com segurança as chaves de API privadas e anote para o que você quer usá-las, como em um gerenciador de senhas.
- Adicione ou edite seus escopos.
- Se você precisar mudar os escopos, a única opção é excluir a chave de API privada original e, em seguida, criar uma nova com o escopo correto.
- Veja a chave de API privada novamente.
- As chaves de API privadas têm acesso total por padrão.
Se você não tiver certeza de quais pontos de extremidade da API, escopos ou permissões precisa, entre em contato com um desenvolvedor ou fale com um parceiro da Klaviyo para receber ajuda.
Criar uma chave de API privada
Você não poderá visualizar uma chave de API privada depois de criá-la. Elas devem ser tratadas como senhas: compartilhe-as somente com pessoas confiáveis e guarde-as em um local seguro, como um cofre ou gerenciador de senhas.
- Clique no nome da sua organização no canto inferior esquerdo.
- Navegue até Configurações.
- Click chave de API.
- Clique em Criar chave de API privada.
- Dê um nome à chave de API.
- Escolha o escopo que você quer dar à chave de API:
- Somente leitura
- Completo
- Personalizado
- Selecione Criar.
Agora, quando você compartilhar uma chave de API privada, o terceiro só terá acesso às informações que você definiu no escopo.
Como usar consultas
As consultas são usadas em cenários avançados. Se você ainda não estiver familiarizado com consultas ou com como usá-las, recomendamos trabalhar com um desenvolvedor.
Incluir
Observe que, se você tentar usar a consulta include, será necessário alterar o formato em relação ao que está listado acima.
Por exemplo, o ponto de extremidade de perfis é /api/profiles.
No entanto, se você adicionar o parâmetro de consulta include (/api/profiles?include=list), você também precisará de list:read ou list:full access, dependendo do tipo de chamada de API que estiver fazendo.
Escopos
Usando o parâmetro scopes, você pode criar um parâmetro de URL para preencher automaticamente qual acesso de escopo você precisa para sua chave de API privada.
Na consulta de escopos, inclua uma lista dos escopos que você quer pré-selecionar, separados por vírgula.
Um exemplo de URL é:
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write
Acesse nosso portal do desenvolvedor para ver os escopos que você pode usar nesta consulta.
Clonar uma chave de API privada
Com chaves de API privadas, a clonagem permite criar uma nova chave que tem os mesmos escopos e permissões da chave original.
Observe que:
- A clonagem não gera a mesma chave que a chave de API privada original.
- Não é possível renomear uma chave de API clonada; ela tem o mesmo nome da chave original.
Para clonar uma chave de API privada:
- Navegue até a aba Chaves de API .
- Clique no menu de 3 pontos ao lado da chave que você quer clonar.
- Selecione Clonar > Clonar.
- Copie ou baixe a nova chave de API privada e armazene-a em um local seguro.
- Exclua sua chave antiga se ela não for mais necessária.
Recursos adicionais
- Guia de introdução às APIs da Klaviyo
Tenha uma compreensão básica das chamadas de API e de como as APIs do Klaviyo podem beneficiar sua empresa. Neste guia, você vai aprender sobre APIs REST, métodos HTTP e ferramentas de desenvolvedor para se preparar para testar as APIs do Klaviyo. Você pode fazer suas primeiras chamadas de API em apenas 10 minutos, do início ao fim. Se você já está familiarizado com chamadas de API e está pronto para testar nossas APIs, siga nosso guia sobre como usar nossas coleções do Postman.
- Como manter sua conta segura
Saiba como garantir que sua conta Klaviyo e seus dados estejam o mais seguros possível.
- documentos para desenvolvedores