Pular para o conteúdo

Criar e revogar chaves de API

Uma chave de API é uma senha que permite a um sistema falar com a Provei em nome da sua loja. Você cria e revoga chaves em Conta › Desenvolvedor. Cada chave aparece uma única vez, logo depois de criada.

  • Importar produtos por link ou planilha. Sem uma chave ativa, a importação mostra Para importar por link ou planilha, sua loja precisa de uma chave de acesso. Crie uma em Desenvolvedor. Veja Adicionar por link e Adicionar por planilha.
  • Integrações próprias. O sistema da sua loja pode chamar a API da Provei. Cada prova feita pela API usa créditos do plano. Para os detalhes técnicos, veja Desenvolvedores.

Não vê Desenvolvedor no menu? Esse recurso é ativado pela Provei. Fale com o suporte para ativar.

  1. Em Conta › Desenvolvedor, clique em Criar chave.

  2. Em Nome (opcional), escreva onde a chave vai ser usada, por exemplo “Servidor da loja”. Isso ajuda a saber onde cada chave está em uso.

  3. Clique em Criar chave.

  4. Na janela Copie sua chave agora, clique em Copiar chave e guarde em um lugar seguro, como o cofre de senhas da sua equipe.

  5. Clique em Pronto.

Por segurança, a chave não aparece de novo. Se você perder a chave, crie outra.

A lista mostra, para cada chave, o nome, o começo da chave seguido de ••••, a Situação (Ativa ou Revogada), quando foi Criada e o Último uso.

Tela Desenvolvedor com a lista de chaves de API (chave oculta), Situação, Criada, Último uso e o botão Revogar

Chaves revogadas ficam escondidas. Clique em Mostrar N chaves revogadas para ver.

  1. Na linha da chave, clique em Revogar.

  2. Confirme em Revogar chave.

Os sistemas que usam essa chave param de funcionar na hora. Isso não pode ser desfeito.

Troque a chave quando alguém que a conhecia sair da equipe, quando ela puder ter vazado ou de tempos em tempos.

  1. Crie uma chave nova.

  2. Troque a chave antiga pela nova em cada sistema que a usa.

  3. Confira se os sistemas funcionam com a nova chave. O Último uso da chave nova passa a ser atualizado.

  4. Revogue a chave antiga.

Veja mais cuidados em Boas práticas com chaves.

Perguntas frequentes

Perdi minha chave. Consigo ver de novo?

Não. Por segurança, a chave só aparece uma vez, logo depois de criada. Crie uma chave nova, troque nos sistemas que usavam a antiga e revogue a antiga.

Preciso de chave para importar produtos?

Sim. Para importar por link ou planilha, sua loja precisa de uma chave ativa. Crie uma em Conta › Desenvolvedor.

Posso usar a chave no código do site?

Não. A chave é uma senha da sua conta e deve ficar só no servidor. O código de instalação do provador não precisa de chave.