Criando uma chave API

Para permitir que os aplicativos se comuniquem diretamente com serviços de plataforma como o IBM® X-Force® Exchange, deve-se fornecer uma chave de API.

Sobre esta tarefa

A chave de API é uma sequência de duas partes, consistindo em um identificador exclusivo e um token secreto, que é usado para autenticação para o terminal de API. O Identificador Único é comparável a um ID de usuário e possui um conjunto de direitos de acesso específicos a uma identidade associada a ele. O token secreto, comparável a uma senha, é um código que é utilizado juntamente com o Identificador Único para verificar a identidade do processo de chamada para a API.

Importante:

Para manter a chave segura, exclua-a após 90 dias e crie uma nova.

Procedimento

  1. Na página inicial, clique no ícone Menu .
  2. Em Configurações gerais, clique em Chaves de API. e, em seguida clique em Criar chave de API
  3. No campo Nome da chave API , insira um nome exclusivo e significativo que identifique a chave para você.
  4. Clique em Gerar.

Resultados

Quando sua chave é criada, a área de janela Criar chave API fornece os detalhes da Chave API: um identificador exclusivo e um token secreto são designados.

Importante: Depois de clicar em Concluído, não é possível recuperar o token secreto. Para armazenar os detalhes da chave em um local seguro, copie o código da chave e o token secreto ou faça o download deles em um arquivo de texto (.txt).

Visualizando uma chave de API

É possível visualizar uma lista de existentes na página Chaves de API .

Procedimento

  1. Na página inicial, clique no ícone Menu .
  2. Em Definições geraisclique em Chaves API.
  3. Na página Chaves API , você pode ver detalhes para as chaves existentes que você criou. A linha de valores para cada chave contém o nome fornecido e o identificador exclusivo designado. Última modificação contém a data de criação ou a data mais recente quando você modificou o nome da chave.

Como excluir uma chave API

É possível excluir facilmente uma chave de API que não é mais necessária.

Procedimento

  1. Na página inicial, clique no ícone Menu .
  2. Em Definições geraisclique em Chaves API.
  3. Passe o mouse sobre a linha que contém a chave que você deseja excluir.
  4. Clique no ícone de exclusão.
  5. Clique em Excluir.