Aplicativo de chaves API

Use as chaves de API para ativar uma integração de entrada de máquina a máquina para um cliente externo. As chaves API podem ser usadas pelas APIs OSLC e REST e também podem ser usadas como parte do framework de integração Gerenciar .

Em uma integração máquina-a-máquina, uma máquina externa interage com os dados Gerenciar no sistema Gerenciar sem o uso de um navegador. As chaves de API são uma forma nativa de autenticação que não requer um repositório externo para o armazenamento da senha.

Por padrão, todas as chaves de API são criptografadas no armazenamento. Esta configuração é controlada pela propriedade mxe.secureapikey.

Incluindo chaves de API para APIs de REST

Quando uma chave API é designada para o cliente externo, o cliente externo pode acessar e interagir com dados no sistema Gerenciar usando a chave API como um parâmetro de consulta apikey ou um cabeçalho de solicitação apikey em chamadas de REST API. As chamadas da API de REST que usam uma chave de API não criam uma conexão persistente com o servidor e a chave de API deve ser parte de todas as solicitações da API de REST feitas pelo cliente.

Para usar uma chave API, acesse Integração > Aplicativo de chaves API no menu.

Usando chaves de API criadas externamente

É possível usar as chaves de API criadas externamente como uma chave de API no Maximo® Manage.Crie esse tipo de chave de API usando a API de REST do MXAPIAPIKEY e fornecendo sua chave de API gerada usando a propriedade json "apikey", conforme mostrado no código a seguir:

POST /oslc/os/mxapiapikey
{
 "apikey":"<outside generated apikey>",
 "expiration":-1
}

Acesso de segurança

Conforme o administrador do sistema, você deve sincronizar os usuários Gerenciar para os clientes externos antes que as chaves da API sejam criadas para esses clientes. As permissões associadas à chave de API são determinadas pelas permissões para o usuário associado. É possível criar e configurar chaves API do aplicativo Chaves API em Integração.

Também é possível especificar a segurança que permite que somente o usuário com login efetuado crie uma chave de API. Para limitar a criação de chaves de API para o usuário com login efetuado, acesse o aplicativo Propriedades de Sistema e filtre para a propriedade mxe.apikeyforloggedinuser. No campo Valor global, especifique 1 e salve o registro. Selecione Atualização em tempo real para aplicar o valor imediatamente.

Para desativar o acesso ao sistema Gerenciar para um cliente externo, você pode excluir a chave API associada, mas o cliente externo ainda pode acessar o sistema Gerenciar usando outro sistema de autenticação configurado. Se uma chave de API estiver comprometida, exclua-a e crie outra chave para esse usuário.