API de configuration supplémentaires
Ces CPQ API de configuration vous permettent de récupérer ou de supprimer une configuration existante. Elles complètent les API d’exécution et sont utiles pour visualiser les détails complets de la configuration et pour supprimer les configurations qui ne sont plus nécessaires. Utilisez-les avec les API standard créer, mettre à jour, reconfigurer et BOM pour prendre en charge les workflows de configuration de bout en bout.
Cet article fait suite à API d’exécution. Pour en savoir plus sur l’authentification et la configuration, consultez cet article.
Ces points de terminaison d’API pour obtenir une configuration et supprimer une configuration à partir de sont inclus par souci d’exhaustivité CPQ .
Obtenir la configuration
CPQ Les configurations peuvent être récupérées à partir des CPQ serveurs en envoyant une requête GET, qui renvoie l’intégralité de la configuration dans la réponse. Si vous avez besoin uniquement des données produit des sorties, envisagez d’utiliser l’un des appels d’API GET BOM.
| Méthode HTTP | GET | ||
|---|---|---|---|
| URL | https://<locataire>.<secteur>.logik.io/api/<uuid> | ||
| Paramètres de chemin d'accès | <uuid> | UUID de configuration à 32 caractères CPQ | obligatoire |
| Paramètres de requête | N/A | ||
Exemple d’URL :
https://dev1.test.logik.io/api/71e62fe7-e59b-4a91-94af-64718e0d4eae
Exemple de réponse :
{
"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>]
}
Supprimer la configuration
CPQ Les configurations peuvent être supprimées, mais ce n’est généralement pas nécessaire. Cette API supprime la configuration CPQ et n’est pas disponible pour une récupération ultérieure de la configuration, de la nomenclature ou des mises à jour de la configuration.
| Méthode HTTP | DELETE | ||
|---|---|---|---|
| URL | https://<locataire>.<secteur>.logik.io/api/<uuid> | ||
| Paramètres de chemin d'accès | <uuid> | UUID de configuration à 32 caractères CPQ | obligatoire |
| Paramètres de requête | N/A | ||
Exemple d’URL :
https://dev1.test.logik.io/api/71e62fe7-e59b-4a91-94af-64718e0d4eae
Exemple de réponse :
{}
Exemples de cas d’utilisation
Un nouveau client accède à un site web, configure un produit et effectue le paiement.
- Démarrer une nouvelle configuration → Créer un appel d’API de configuration
- Effectuer des mises à jour de la configuration → Mettre à jour l’appel d’API de configuration
- Enregistrer la configuration finale dans CPQ → Enregistrer la configuration Appel d’API
Un client revient et souhaite passer une commande pour un produit similaire à celui qu’il a acheté auparavant.
- Effectuer une reconfiguration à l’aide d’un ID de configuration existant CPQ → Reconfigurer l’appel d’API
- Enregistrer dans → Enregistrer la configuration Appel d’API CPQ
Une commande pour un produit fabriqué complexe est passée et l’équipe d’ingénierie doit savoir de quelles pièces elle a besoin et quels sous-ensembles construire.
Récupérez la nomenclature « Fabrication » pour une configuration existante → Obtenir un appel d’API BOM.