Gerenciando chaves de API REST da plataforma

Editar online

Crie chaves de API associadas à sua conta de usuário e, em seguida, use-as para se autenticar ao chamar as APIs REST da plataforma fornecidas por API Connect.

Sobre essa tarefa

É API Connect APIs REST da plataforma necessário autenticar-se para utilizar o serviço. Para chamar uma API de forma interativa, é possível efetuar login na CLI do kit de ferramentas com uma opção para gerar a chave de API. Para chamar uma API programaticamente, você pode gerar uma chave de API e, em seguida, trocá-la por um token API Connect de acesso. Este requisito se aplica apenas às APIs fornecidas por API Connect. Não é necessária a chave de API para chamar APIs que você importou ou criou. A chave API destina-se ao uso com o tipo de registro de usuários OIDC.
Lembre-se: por padrão, as chaves de API estão configuradas para serem usadas apenas uma vez No entanto, você pode personalizar a configuração e alterar a validade da API seguindo as etapas descritas no tóp ico "Configurando as definições da chave da API"

Procedimento

  1. Crie uma chave de API:
    1. Faça login no API Connect Enterprise as a Service.
    2. Clique no seu nome de usuário no banner para exibir seu perfil.
    3. Na página do seu perfil, clique em “Minhas chaves de API ”.
    4. Na página Chaves API , selecione Incluir.
    5. No campo “Criar uma chave de API d API Connect ”, insira um título para a chave e uma descrição. O título deve ser único na sua conta de usuário.
    6. Para definir um valor de tempo limite, selecione ou digite um número inteiro no campo “Tempo limite da chave da API” e, em seguida, escolha uma unidade de tempo (segundos, minutos ou horas) no campo “Unidade ”.
      Observação: O tempo limite padrão é de 5 minutos.
    7. Selecione “Ativar uso múltiplo” para permitir que os aplicativos troquem a chave da API por um token de acesso várias vezes.
    8. Clique em Criar.
      Observação: o botão “Criar” fica desativado até que você insira uma descrição.
  2. Gerenciar chaves de API:
    1. Faça login no API Connect Enterprise as a Service.
    2. Clique no seu nome de usuário no banner para exibir seu perfil.
    3. Na página do seu perfil, clique em “Minhas chaves de API ”.
      A lista de chaves de API associadas à sua conta de usuário exibe:
      • Para visualizar uma legenda, clique Ver a chave da API na mesma linha em que se encontra o título da legenda.
      • Para copiar uma chave, visualize-a e, em seguida, selecione Copie a chave da API no campo da chave da API.
      • Para excluir uma chave, clique Excluir a chave da API na mesma linha em que se encontra o título da chave e clique em Excluir quando for solicitado a confirmar a ação.