Saltar para o conteúdo
Verificado

Boas práticas para chaves de API

Acesso total versus personalizado, revogar e substituir uma chave e detetar uma que ninguém está a usar.

Uma chave de API age na sua conta sem si: de qualquer lugar, até ser revogada. A Autenticação explica como uma chave é criada e enviada numa chamada; esta página trata de manter honestas as que já tem.

Dê a uma chave apenas o que ela precisa

Cada chave é de Acesso total ou de Acesso personalizado, escolhido quando é criada e alterável mais tarde no mesmo formulário.

  • Acesso total alcança todos os métodos que a sua conta pode chamar, incluindo os adicionados depois de a chave ser criada. Nada marcado como privado é alguma vez incluído, qualquer que seja o modo de acesso de uma chave.
  • Acesso personalizado alcança apenas os métodos que marcou explicitamente, agrupados por microsserviço com os parâmetros de cada método mostrados ao lado. Um método adicionado mais tarde não fica coberto até voltar e marcá-lo.
Prefira o acesso personalizado para tudo o que seja automatizado

Uma chave ligada a um script, a uma tarefa de CI ou a um servidor só precisa dos poucos métodos que essa tarefa realmente chama. O acesso personalizado impede que uma chave divulgada possa fazer mais do que o trabalho para que foi criada.

Criar, revelar e copiar

Criar uma chave exige que a sua conta esteja verificada ao nível 2; veja Verificação. O botão Criar chave explica isto e liga diretamente ao próximo passo por concluir, se ainda não lá chegou. O valor de uma chave acabada de criar é mostrado uma vez no painel Cópia rápida no topo da lista; depois disso, cada linha mantém-no oculto, e o botão de revelar da própria linha mostra-o de novo durante 20 segundos antes de voltar a ocultá-lo sozinho.

Uma chave é um segredo, não uma etiqueta

O valor nunca é escrito num registo, numa notificação nem na barra de endereço, apenas na sua área de transferência. Trate-o exatamente como uma palavra-passe. Quem o tiver pode agir como a sua conta.

Substituir, revogar e detetar uma que não está a ser usada

Não existe uma ação separada de rotação, porque o valor de uma chave é o seu próprio identificador. Substituir cria uma nova chave com o mesmo nome e acesso, revoga a antiga e mostra o novo valor uma vez, para o poder copiar antes de fechar a caixa de diálogo. Revogar remove uma chave de vez e pede-lhe que a confirme primeiro pelo nome, uma vez que não pode ser anulado.

A linha de cada chave mostra quando foi usada pela última vez, com base nos últimos 7 dias de atividade; uma chave sem essa linha simplesmente não fez nenhuma chamada nesse período. Essa é a linha que merece uma segunda olhadela.

Substitua uma chave que possa ter sido divulgada

Abra a chave, carregue em Substituir e copie o novo valor assim que aparecer. O valor antigo deixa de funcionar no instante em que a substituição termina.

Revogue uma chave de que já não precisa

Carregue em Revogar na sua linha e confirme pelo nome. Uma chave revogada sai da lista de ativas; não há forma de a recuperar.

Verifique se há alguma que ninguém usa

Percorra a lista à procura de uma linha sem "Última utilização", sobretudo entre as chaves de Acesso total, e revogue-a se não conseguir justificá-la.