APIs do administrador: Importação e exportação de blueprint

Você pode exportar um blueprint para fazer backup dele ou exportar e importar um blueprint para movê-lo de um CPQ para outro.

. CPQ As APIs de administração de blueprints fornecem as chamadas de API de importação e exportação para trabalhar com blueprints. Os casos de uso comuns incluem migrar blueprints entre CPQ e backup de blueprints. Para exibir o. CPQ APIs do administrador de blueprint, consulte:

CPQ APIs do administrador de blueprint

Para obter uma lista abrangente de todos CPQ APIs, consulte CPQ Referência de API:

https://api-docs.logik.io/#introduction

Você também pode exibir o. CPQ Documentação da API de código aberto no Github:

https://github.com/logikioopensource/API-Documentation

Para saber como configurar chaves de API de administrador para chamar APIs de blueprint, consulte:

Introdução às chaves de API do administrador

APIs de exportação de blueprint

Para exportar um blueprint por meio das APIs, a chamada Exportar blueprint passa o nome da variável do blueprint para iniciar o trabalho de exportação. Em resposta, a chamada recebe um ID de trabalho que pode ser consultado para recuperar o status e baixar o blueprint como um arquivo ZIP.

A sequência de chamadas de API para exportar e baixar um blueprint é:

1. Exporte o blueprint

   Use a variável de blueprint na carga para iniciar a exportação. O ID do trabalho pode ser pesquisado para saber o status da exportação.

2. Verifique o status do trabalho

   Para verificar o status, use o ID do trabalho retornado após a chamada de exportação. Quando o status for CONCLUÍDO, prossiga para a etapa 3.

3. Baixe a exportação

   Use o mesmo ID de trabalho para baixar um arquivo ZIP que contém o blueprint.

Para exibir o código-fonte da chamada Exportar blueprint, consulte:

Exportar chamada de plano gráfico

APIs de importação de blueprint

Para importar um blueprint, a chamada Importar blueprint passa um arquivo ZIP do blueprint para iniciar um trabalho de importação.

A sequência de chamadas de API para importar um blueprint é:

1. Importe o blueprint

   Selecione o arquivo ZIP que inclui o blueprint. O ID do trabalho pode ser pesquisado para saber o status da importação.

2. Verifique o status do trabalho

   Para verificar o status, use o ID do trabalho retornado após a chamada de importação. Quando o status for SUCESSO, o trabalho será Concluído.

Para exibir o código-fonte da chamada Importar blueprint, consulte:

Importar chamada de blueprint