Chaves de API

Autentique o Bob para fluxos de trabalho de automação sem necessidade de login via browser. Disponível para usuários dos planos trial e pagos. Gerencie chaves individualmente ou como administrador em toda a sua instância.

Propriedade e administração

As chaves de API têm escopo tanto para o usuário quanto para a instância de assinatura. Usuários individuais podem criar, listar e revogar suas próprias chaves de API. Administradores da instância de assinatura podem listar e revogar chaves de API para todos os usuários da instância.

Página de gerenciamento de chaves de API

Tipos de chave de API

Você pode criar dois tipos de chaves de API:

TipoEscopo e uso
GeralCom escopo para a instância de assinatura e utilizável em múltiplos serviços. Para requisições de inferência, também é necessário incluir o header do ID de equipe.
InferênciaCom escopo para uma instância de assinatura e equipe específicas, limitada apenas a requisições de inferência. Não são necessários headers adicionais de instância ou equipe.

Quando usar chaves de API

Use chaves de API quando precisar:

  • Autenticar o Bob Shell em sessões não interativas
  • Executar o Bob em pipelines de CI/CD ou automações agendadas
  • Evitar login via browser para fluxos de trabalho com scripts
  • Autenticar requisições de inferência com uma chave de API geral ou de inferência

Criar uma chave de API

Acesse bob.ibm.com e faça login.

Abra sua instância de assinatura e navegue até a seção de gerenciamento de chaves de API.

Seção de gerenciamento de chaves de API sem nenhuma chave ainda

Crie uma nova chave de API e escolha o tipo que deseja criar.

Diálogo de criação de chave de API

Copie o valor da chave de API e armazene-o com segurança.

Aviso:

Não é possível visualizar o valor da chave de API novamente após a criação.

Gerenciar suas chaves de API

Você pode usar a seção de gerenciamento de chaves de API para:

  • Listar suas chaves de API
  • Pesquisar e filtrar chaves
  • Ver detalhes das chaves de API
  • Revogar chaves ativas
  • Exibir chaves revogadas junto com as chaves ativas e expiradas

Capacidades de administrador

Administradores da instância de assinatura podem gerenciar chaves de API em toda a instância. As capacidades de administrador incluem:

  • Listar chaves de API de todos os usuários na instância
  • Revogar chaves de API de qualquer usuário na instância
  • Visualizar chaves ativas, revogadas e expiradas

Usar uma chave de API com o Bob Shell

Para usar uma chave de API com o Bob Shell, veja Instalar e configurar o Bob Shell e Iniciar uma sessão não interativa.

Como está este tópico?