API d’administration : importation et exportation de plans
Vous pouvez exporter un plan pour le sauvegarder ou exporter et importer un plan pour le déplacer d’un CPQ environnement à un autre.
Les CPQ API de l’administrateur de plan fournissent les appels d’API d’importation et d’exportation pour l’utilisation des plans. Les cas d’utilisation courants incluent la migration des plans entre les CPQ environnements et la sauvegarde des plans. Pour afficher les API d’administration de CPQ plan, consultez :
CPQ API de l’administrateur de plan
Pour obtenir une liste complète de toutes les CPQ API, consultez la référence de l’API CPQ :
https://api-docs.logik.io/#introduction
Vous pouvez également consulter la documentation de l’API CPQ open source sur GitHub :
https://github.com/logikioopensource/API-Documentation
Pour en savoir plus sur la configuration des clés API d’administration pour l’appel d’API de plan, consultez :
Présentation des clés API d’administration
API d’exportation de plan
Pour exporter un plan via les API, l’appel Export blueprint transmet le nom de variable du plan pour démarrer la tâche d’exportation. En réponse, l’appel reçoit un ID de tâche qui peut être interrogé pour récupérer l’état et télécharger le plan sous forme de fichier ZIP.
La séquence d’appels d’API pour exporter et télécharger un plan est la suivante :
- Exporter le plan
Utilisez la variable de plan dans la charge utile pour lancer l’exportation. L’ID de la tâche peut être interrogé pour connaître l’état de l’exportation.
- Vérifier l’état de la tâche
Pour vérifier l’état, utilisez l’ID de tâche renvoyé après l’appel d’exportation. Lorsque l’état est TERMINÉ, passez à l’étape 3.
- Télécharger l’exportation
Utilisez le même ID de tâche pour télécharger un fichier ZIP contenant le plan.
Pour afficher le code source de l’appel de plan d’exportation, consultez :
API d’importation de plan
Pour importer un plan, l’appel Import Blueprint transmet un fichier ZIP du plan pour démarrer une tâche d’importation.
La séquence d’appels d’API pour importer un plan est la suivante :
- Importer le plan
Sélectionnez le fichier ZIP qui inclut le plan. L’ID de la tâche peut être interrogé pour connaître l’état de l’importation.
- Vérifier l’état de la tâche
Pour vérifier l’état, utilisez l’ID de tâche renvoyé après l’appel d’importation. Lorsque l’état est RÉUSSITE, la tâche est terminée.
Pour afficher le code source de l’appel Import blueprint, consultez :