Introdução às chaves de API do administrador

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 2 min. de leitura

    • Você pode usar chamadas de API de administrador para acessar a funcionalidade de administrador sem usar a interface de IU de administrador e um navegador.

    CPQ Fornece chaves de API de administrador que você pode usar para acessar a funcionalidade de administrador por meio de chamadas de API em vez de usar um navegador e o. CPQ Interface do administrador.

    Para obter uma introdução ao CPQ Chaves de API do administrador, assista ao seguinte vídeo:

    Chaves de API do administrador

    Página Chaves de API do administrador

    Para acessar a página Chaves de API do administrador em CPQ, Clique na seta para expandir a seção Utilitários em CPQ Admin A guia Chaves de API do administrador aparece no menu.

    Chaves de administrador

    Adicione uma nova chave de API de administrador

    Para adicionar uma nova chave de API de administrador, clique em Novo na parte superior da tela.

    Adicionar chave de administrador

    Todos os parâmetros são obrigatórios.

    1. Nome: O nome da chave de API do administrador
    2. ID do usuário
    3. Data de expiração: A data de expiração da chave
    4. Permissões: As permissões atribuídas à chave

    Escolha as permissões que se ajustam ao seu caso de uso antes de clicar em Salvar .

    Permissões de chave de API do administrador

    Permissões de chave de API

    1. Leitura (obrigatório, padrão): Acesso somente leitura, normalmente para solicitações GET
    2. Editar: Crie, leia, atualize e exclua o acesso para a maioria dos objetos, incluindo campos e regras
    3. Implantação: Permite a implantação de blueprints e acesso ao histórico de implantação
    4. Em massa: Permite importar e exportar dados, como tabelas gerenciadas, de e para CPQ
    5. Administrador: Permissões totais para todas as funcionalidades do administrador
    6. Dados do usuário final: Acesso às APIs de dados do usuário final

    Quando terminar de atribuir permissões, clique em Salvar . A caixa de diálogo é atualizada para mostrar a nova chave de API do administrador.

    Adicione chave de API

    1. Exiba a chave de API do administrador
    2. Copie a chave para a área de transferência
    3. Feche a caixa de diálogo
    Importante:
    Você pode copiar uma chave de API de administrador somente quando ela for criada. Certifique-se de copiar e armazenar a chave.

    Acessando APIs de administrador usando chaves de API

    Para usar uma chave de API do administrador em solicitações de API, use a chave de API com autenticação de token do portador.

    • Cabeçalho: Cabeçalho de autorização
    • Chave: Autorização
    • Valor: Portador > chave de API do administrador>

    Cabeçalho de exemplo:

    Autorização: Portador QDA_UdoiYipb15Le11En8axEuN71FA6Vt_cw

    Ao usar uma chave de API de administrador, você usa endpoints diferentes para acessar as APIs de administrador.

    • Para endpoints gerais do administrador ( /A/Admin/... ) o endpoint a ser usado é ( /api/administrador/... ).

      Por exemplo (recuperando uma lista de regras):

      • Chamada de API na IU do administrador: /A/ADMIN/v3/rules?page: 0&size: 100&sort: Modified%2CDESC
      • Chamada de API usando chaves de administrador: /api/admin/v3/rules?page: 0&size: 100&sort: Modified%2CDESC
    • Para endpoints de tabela gerenciada ( /a/managed_tables/... ) O endpoint a ser usado ao acessar com uma chave de API é ( /api/managedTables/... )

      Por exemplo (recuperando o esquema de uma tabela gerenciada):

      • Chamada de API na IU do administrador: /A/managed_tables/v1/managedTables/
      • Chamada de API usando chaves de administrador: /api/managedTables/v1/managedTables/