APIs de configuração adicionais

. CPQ As APIs de configuração permitem recuperar ou excluir uma configuração existente. Elas complementam as APIs de tempo de execução e são úteis para exibir detalhes completos da configuração e para remover configurações que não são mais necessárias. Use-as junto com as APIs padrão de criação, atualização, reconfiguração e BOM para oferecer suporte a fluxos de trabalho de configuração de ponta a ponta.

Este artigo é um acompanhamento de APIs de tempo de execução. Para obter mais informações sobre autenticação e configuração, consulte esse artigo.

Estes endpoints de API para obter uma configuração e excluir uma configuração CPQ estão incluídos para conclusão.

Obter configuração

CPQ as configurações podem ser recuperadas do CPQ Enviando uma solicitação GET, que retornará toda a configuração na resposta. Se você precisar apenas dos dados do produto das saídas, considere usar uma das chamadas da API OBTER BOM.

Nota:

Isso não carrega uma configuração no CPQ mecanismo de regras para atualizações de campos e reexecução de regras. Se você precisar fazer atualizações em uma configuração existente, use a chamada de API de reconfiguração.

Tabela 1. A solicitação GET

Método HTTP	GET
URL	https://<tenant>.<sector>.logik.io/api/<uuid>
Parâmetros de caminho	<uuid>	32 caractere CPQ UUID de configuração	obrigatório
Parâmetros de consulta	N/D

URL de amostra:

https://dev1.test.logik.io/api/71e62fe7-e59b-4a91-94af-64718e0d4eae

Resposta de amostra:

{
"fields": [<ARRAY OF FIELD OBJECTS>],
"uuid": "08176434-9b1e-4fc8-b2c4-8aba2c35fda3", "revision": 0,
"relatedChanges": [
{
"key": "products",
"type": "PRODUCT"
}
],
"valid": true, "messages": [], "productChange": true,
"products": [<ARRAY OF PRODUCTS IN CONFIGURATION>],
"total": 30,
"layouts": [<ARRAY OF LAYOUTS>]
}

Excluir configuração

CPQ as configurações podem ser excluídas, mas normalmente não são necessárias. Esta API exclui a configuração de CPQ E não estarão disponíveis para recuperação futura da configuração, BOM ou atualizações da configuração.

Nota:

Esta API excluirá somente a configuração do CPQ servidores. Se a configuração persistir em outra aplicação (ou seja, cotações foram criadas no Salesforce, pedidos foram feitos no comércio eletrônico), nenhuma mudança será feita nesses dados.

Tabela 2. A solicitação DE EXCLUSÃO

Método HTTP	DELETE
URL	https://<tenant>.<sector>.logik.io/api/<uuid>
Parâmetros de caminho	<uuid>	32 caractere CPQ UUID de configuração	obrigatório
Parâmetros de consulta	N/D

URL de amostra:

https://dev1.test.logik.io/api/71e62fe7-e59b-4a91-94af-64718e0d4eae

Resposta de amostra:

{}

Amostras de casos de uso

Um novo cliente acessa um site, configura um produto e faz o check-out.

1. Iniciar uma nova configuração → Criar nova chamada de API de configuração
2. Faça atualizações na chamada de API de configuração → Atualizar configuração
3. Salve a configuração final de volta para CPQ→ Salvar chamada de API de configuração

Um cliente retorna e deseja fazer um pedido de um produto semelhante a um que ele comprou antes.

1. Execute uma reconfiguração, usando um existente CPQ ID de configuração → Reconfigure a chamada de API
2. Voltar para CPQ→ Salvar chamada de API de configuração

Um pedido de um produto fabricado complexo é feito, e a equipe de engenharia precisa saber quais peças precisam e quais submontagens devem ser construídas.

Recupere a lista de materiais "Fabricação" para uma configuração existente → Obter chamada da API da BOM.