Cas d’utilisation : affichage de l’interface utilisateur native via une CPQ URL directe
Découvrez comment initialiser une interface utilisateur de configuration à l’aide d’une URL au lieu d’une bibliothèque externe.
Cet article explique comment une CPQ interface utilisateur de configuration peut être initialisée à l’aide d’une URL de configuration plutôt que de s’appuyer sur une bibliothèque externe (telle que easyXDM).
L’URL de configuration de base est au format https://{tenant}.logik.io/ui/configure/{configurableProductId}, où :
- {tenant} est le CPQ locataire que vous utilisez, qui se trouve dans Salesforce ou, si vous utilisez CPQ le headless, l’URL de base de l’expérience administrateur
- {configurableProductId} est l’ID du CPQ produit configurable à utiliser pour la configuration
Exemple d’URL de configuration : https://demo6.demo.logik.io/ui/configure/01t5f000006QKynAAG?v=1
Paramètres de requêtes URL de configuration
Des paramètres et des données supplémentaires peuvent être transmis via les paramètres de requête d’URL.
| Paramètre | Description | Obligatoire | Valeurs/Notes |
|---|---|---|---|
| v | Version | VRAI | 1 |
| pid | ID de Pricebook | ID du catalogue de prix Salesforce | |
| id | ID de configuration | UUID Logik de la configuration existante à charger | |
| Couvercle | ID des lignes de devis | ID de ligne de devis Salesforce | |
| QID (QID) | ID du devis | ID du devis Salesforce | |
| journal | Exécution du journal (trajectoire de vol) | Aucun | Disponible | Active (Active) Ce paramètre est sensible à la casse. |
|
| cm | ID de configuration validée | Lorsqu’une commande contractuelle est modifiée, CPQ identifie l’ID de configuration précédent. Cet ID devient alors l’ID de configuration validé. | |
| Champs | Champs |
Tableau d’objets de table. Par exemple, Dans JavaScript, utilisez encodeURI pour vous assurer que tous les caractères spéciaux sont échappés |
|
| Climatisation | Contexte d’action | nul ou « Amendement » | |
| e | Modifiabilité | L’une des catégories suivantes :
|
|
| disposition | Nom de la variable de mise en page | Nom de la mise en page à charger à partir du plan du produit configurable | |
| rendre | URL de retour | URL sur laquelle définir window.location lors de l’enregistrement ou de l’annulation. Doit être codé et sécurisé par URL | |
| RT | Jeton d’exécution | Voir la remarque ci-dessous | Jeton d’exécution à partir de la configuration de l’administrateur CPQ |
| rta | URL de l’API d’exécution |
Doit être codé et sécurisé par URL. Fortement recommandé si vous utilisez le paramètre de jeton d’exécution. Utilisez encodeURI dans Javascript pour vous assurer que tous les caractères spéciaux sont échappés, en particulier lors de l’appel d’une API. |
|
| currency | Code ISO de devise |
Si vous n’accédez pas à l’URL de configuration où vous vous êtes déjà authentifié (via Salesforce ou directement), le jeton d’exécution sera requis pour vous authentifier. Si vous accédez à l’URL de configuration avant de vous authentifier via l’environnement SFDC associé ou d’accéder à l’URL de configuration d’un environnement sans en-tête, l’URL CPQ du locataire doit être répertoriée comme origine pour le client d’exécution exploité. Par exemple, https://<yourLogikUrl>.test.logik.io.
Si le paramètre version n’est pas inclus, l’interface utilisateur ne se chargera pas et vous recevrez l’erreur suivante : « Erreur : une version doit être spécifiée. »
Si une URL de retour n’est pas incluse, l’interface utilisateur diffusera un postMessage jusqu’au parent, avec l’UUID à l’enregistrement (tel que {"uuid » : « 8b88c843-d10b-468b-8c49-17f8c9698799"}) et un objet vide à l’annulation ({}).
Utilisation de l’URL de configuration
L’URL de configuration peut être utilisée comme fenêtre de niveau supérieur ou dans un iframe sur une page.
Contrairement à l’utilisation de l’exemple easyXDM pour initialiser une configuration, les données de configuration ne seront pas envoyées à la console du navigateur en JavaScript lors de l’utilisation de l’URL de configuration.
Considérations relatives à l’utilisation de l’URL de configuration comme URL de fenêtre de niveau supérieur :
- Lors des actions d’enregistrement ou d’annulation, l’interface CPQ utilisateur effectue l’appel au CPQ back-end pour enregistrer ou annuler la configuration. Ces appels peuvent être consultés dans l’onglet Réseau du navigateur pour voir les données envoyées et renvoyées.
- Si une URL de retour est incluse, l’interface utilisateur tentera de définir l’emplacement de la fenêtre sur cette URL lors de l’enregistrement (« Devis ») ou de l’annulation.
Considérations relatives à l’utilisation de l’URL de configuration dans un iframe :
- Si une URL de retour est incluse, l’interface utilisateur tentera de définir l’emplacement de la fenêtre sur cette URL lors de l’enregistrement (« Devis ») ou de l’annulation. Si une URL de retour n’est pas incluse, l’interface CPQ utilisateur diffusera un postMessage jusqu’au parent, avec l’UUID à l’enregistrement (tel que
{"uuid » : « 8b88c843-d10b-468b-8c49-17f8c9698799"}) et un objet vide à l’annulation ({}). - Quelle que soit l’implémentation, après l’exécution de l’action enregistrer ou annuler, la configuration est supprimée. Les actions de sauvegarde suivantes entraîneront une erreur 404 avec un message d’erreur : « Aucun moteur de règles trouvé pour le locataire avec l’ID de configuration '<Logik UUID>'. Les actions d’annulation ultérieures entraîneront également une erreur 404.
Résultat de la configuration
Vous pouvez accéder au résultat de la configuration enregistrée à l’aide de l’API GET pour récupérer les données BOM.
Collection Postman avec URL de l’API de configuration
Le résultat peut être envoyé à un système en aval via Webhook. Consultez Webhooks.