Gerenciando chaves de API

Uma chave de API é um identificador exclusivo usado para autenticação de um usuário, developer ou programa de chamada para uma API. As chaves de API geralmente são usadas para rastrear e controlar como a interface é usada, para evitar o abuso da API.

Visão geral de chaves de API

Por padrão, as chaves de API estão desabilitadas no Console de gerenciamento. Para habilitar as chaves de API, acesse a seçãoConfigurações. Um administrador de locatários pode revogar chaves de API Porém, para editar as configurações de chaves de API e para gerar ou excluir chaves de API, você deve ter a função Developer. Um administrador de locatários atribui a função Developer a um usuário. Se você for um administrador de locatários, poderá atribuir a função Developer a si mesmo.

A tabela de chaves de API mostra as seguintes informações sobre as chaves de API : nome, ID, proprietário, última atualização, data de criação, data de expiração e status. Use o campo de pesquisa para pesquisar nos três primeiros campos: Nome da chave, ID da chave e Proprietário.

Status das chaves de API

Chaves de API podem ter os seguintes status:

Ativa: a chave de API está em uso.
Expirada: a data de expiração foi atingida.
Revogada: a chave de API foi revogada e não pode mais ser usada.

Como administrador, você pode revisar as principais atividades de API registradas na seção Eventos do Console de gerenciamento. Se atividades suspeitas forem detectadas, como o uso extensivo de uma determinada chave de API, você pode revogar essa chave de API. Abra a lista detalhada clicando na seta na extrema direita da tabela e copie o ID da chave de API . Você pode procurar o ID na seção chaves de API para encontrar a chave de API a revogar.

Para revogar uma única chave de API, clique no botão ... na extrema direita e selecione Revogar. Você só pode revogar chaves com o status Ativa. Para revogar várias chaves, marque as caixas de seleção à esquerda das chaves a revogar e clique em Revogar no canto superior direito. A revogação é irreversível, uma chave de API revogada não pode ser reativada.

Além da revogação, há a opção de exclusão. É possível excluir uma chave de API do hub, mas não no Console de gerenciamento.

Habilitando chaves de API no locatário

A configuração Habilitar chaves de API é ativada na página Configurações do Console de gerenciamento. Por padrão, as chaves de API estão desabilitadas no Console de gerenciamento.

Propriedades para chaves de API
Propriedade	Descrição
Habilitar chaves de API keys	Esta opção habilita ou desabilita todas as chaves de API do locatário. Somente o administrador de locatários pode habilitar as chaves de API.
Alterar expiração máxima do token	Ao alterar o valor de expiração do token, todos os novos tokens terão o novo valor de expiração. As APIs já existentes não serão afetadas pela alteração e terão o mesmo valor de expiração de antes. Não há limite máximo para o valor.
Altere o máximo de API chaves por usuário	Essa configuração afeta apenas chaves de API. Se uma nova chave de API fizer com que o número total exceda o número máximo, a criação será negada. O limite máximo do valor é 1000.

Faça o seguinte:

No Console de gerenciamento, acesse a página Configurações.
Na seção Chaves de API, ative o botão Habilitar chaves de API.
Se aplicável, altere as configurações Alterar expiração máxima do token e Alterar máximo de chaves de API por usuário.

Gerando uma chave de API desde o hub

Você pode gerar chaves de API a partir do hub. Antes de começar, verifique se os três requisitos a seguir foram atendidos:

Você está usando uma licença. Uma licença é necessária para gerar uma chave de API.
A configuração Habilitar API chaves está ativada no Console de gerenciamento.
O administrador de locatários atribuiu a função de Developer a você.

Faça o seguinte:

Efetue o logon em seu locatário, por exemplo, https://<tenantname>.com.
Clique no seu perfil no canto superior direito e selecione Configurações do perfil.
Selecione chaves de API .
Clique em Gerar nova chave.
Insira uma descrição para a chave de API e selecione quando a chave de API deve expirar.
Clique em Gerar.

Uma chave de API é gerada.
Copie a chave de API e guarde-a em um local seguro.

Após a criação, você pode editar o nome da chave de API . Também pode excluí-la.

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo - um erro de digitação, uma etapa ausente ou um erro técnico - informe-nos como podemos melhorar!

Deixe seu feedback aqui