Gerenciador de transações: Usando chamadas de API de tempo de execução
Veja uma lista das APIs usadas na experiência do usuário final em tempo de execução, junto com suas finalidades e respostas.
CPQ As APIs são divididas em duas categorias: APIs de tempo de execução e APIs de administrador. Este artigo lista as APIs de tempo de execução do Gerenciador de transações.
As APIs de tempo de execução são as mesmas APIs usadas na experiência do usuário final de tempo de execução e incluem as seguintes ações-chave.
- Inicialize uma sessão
- Objetivo: Inicializa uma sessão para estabelecer um contexto para executar eventos de transação, gerenciar estado e processar chamadas de API subsequentes. Pode inicializar para uma transação existente. Se uma transação não for especificada, uma nova transação será criada.
- Resposta: Retorna um ID de sessão, um ID de transação e informações de transação.
- Exclua uma sessão
- Objetivo: Exclui uma sessão para atividade do usuário final com segurança, limpar dados específicos da sessão e liberar recursos do sistema.
- Resposta: A sessão foi excluída. Nenhuma informação é retornada.
- Crie uma transação
- Objetivo: Cria uma transação, fornecendo o objeto para gerenciar o ciclo de vida da transação, configurar e adicionar produtos e determinar preços.
- Resposta: Retorna um ID de transação e informações de transação.
- Executar eventos em uma transação (sistema e personalizado)
- Objetivo: Aciona um evento especificado em uma transação para executar lógica ou fluxos de trabalho predefinidos, como editar valores de campo, iniciar aprovações, transações de controle de versão e validar configurações.
- Resposta: Varia de acordo com o evento.
- Adicionar produtos a transações (upsert)
- Objetivo: Adiciona um produto ou produtos a uma transação, permitindo a configuração dinâmica e atualizações de preços com base nos atributos do produto.
- Resposta: Retorna dados de transação atualizados com o produto adicional.
- Obtenha uma lista de transações
- Objetivo: Recupera uma lista de transações, permitindo que os usuários exibam, gerenciem ou executem ações nas transações existentes.
- Resposta: Uma lista de transações com IDs de transação e outros metadados.
- Obter detalhes de uma transação
- Objetivo: Recupera as informações do cabeçalho de uma transação, fornecendo detalhes importantes, como fase, conta e os dados de nível resumido necessários para exibição ou processamento.
- Resposta: Todos os dados do campo de cabeçalho da transação.
- Obtenha as linhas de uma transação
- Objetivo: Recupera os detalhes do item de linha de uma transação, retornando dados no nível do produto, como quantidades, preços e atributos personalizados para cada item na cotação.
- Resposta: Todos os dados do campo no nível de linha da transação.
- Obtenha estatísticas de transações
- Objetivo: Recupera métricas em transações. As métricas incluem exibições por usuário, tempo da sessão por usuário e tempo da fase.
- Resposta: Métricas resumidas dos últimos 30 dias ou para um intervalo de datas especificado.
Para obter mais detalhes sobre a API de métricas do Gerenciador de transações, consulte Gerenciador de transações: API de métricas de transação.