Consultez la liste des API utilisées dans l’expérience utilisateur final d’exécution, ainsi que leurs objectifs et leurs réponses.

CPQ Les API sont divisées en deux catégories : les API d’exécution et les API d’administration. Cet article répertorie les API d’exécution pour Transaction Manager.

Les API d’exécution sont les mêmes que celles utilisées dans l’expérience utilisateur final d’exécution et incluent les actions clés suivantes.

• Initialiser une session
  • Objectif : initialise une session afin d’établir un contexte pour l’exécution des événements de transaction, la gestion de l’état et le traitement des appels d’API ultérieurs. Peut initialiser pour une transaction existante. Si aucune transaction n’est spécifiée, une nouvelle transaction est créée.
  • Réponse : renvoie un ID de session, un ID de transaction et des informations sur la transaction.
• Supprimer une session
  • Objectif : Supprime une session pour sécuriser l’activité de l’utilisateur final, effacer les données spécifiques à la session et libérer des ressources système.
  • Réponse : La session est supprimée. Aucune information n’est renvoyée.
• Créer une transaction
  • Objectif : Crée une transaction en fournissant l’objet permettant de gérer le cycle de vie de la transaction, de configurer et d’ajouter des produits, et de déterminer la tarification.
  • Réponse : renvoie un ID de transaction et des informations sur la transaction.
• Exécuter des événements sur une transaction (système et personnalisée)
  • Objectif : déclenche un événement spécifié sur une transaction pour exécuter une logique ou des workflows prédéfinis, tels que la modification de valeurs de champ, l’initiation d’approbations, la gestion des versions des transactions et la validation des configurations.
  • Réponse : Varie selon l’événement.
• Ajouter des produits à des transactions (upsert)
  • Objectif : ajoute un ou plusieurs produits à une transaction, permettant une configuration dynamique et des mises à jour de la tarification en fonction des attributs du produit.
  • Réponse : renvoie les données de transaction mises à jour avec le produit supplémentaire.
• Obtenir une liste des transactions
  • Objectif : Récupère une liste des transactions, permettant aux utilisateurs d’afficher, de gérer ou d’effectuer des actions sur les transactions existantes.
  • Réponse : une liste des transactions avec des ID de transaction et d’autres métadonnées.
• Obtenir les détails d’une transaction
  • Objectif : récupère les informations d’en-tête d’une transaction, fournissant des détails clés tels que l’étape, le compte et les données de niveau résumé nécessaires à l’affichage ou au traitement.
  • Réponse : toutes les données de champ d’en-tête de la transaction.
• Obtenir les lignes d’une transaction
  • Objectif : récupère les détails de l’élément de ligne pour une transaction, en renvoyant des données au niveau du produit telles que les quantités, les prix et les attributs personnalisés pour chaque élément du devis.
  • Réponse : toutes les données de champ au niveau de la ligne pour la transaction.
• Obtenir les statistiques des transactions
  • Objectif : Récupère des mesures sur les transactions. Les mesures incluent les vues par utilisateur, la durée de session par utilisateur et l’heure de l’étape.
  • Réponse : Mesures récapitulatives pour les 30 derniers jours ou pour une plage de dates spécifiée.

  Pour en savoir plus sur l’API de mesures Transaction Manager, reportez-vous à la section Gestionnaire de transaction : API de mesures de transaction.

Collection Postman