API Documents
Smart CPQ Javadocs
| GUIDE NAME | VERSION |
|---|---|
| 13.8 | |
| 13.7 | |
| 13.6 |
Performance Quoting APIs
This table shows the Performance Quoting APIs (included in the Performance Quoting Javadoc).
| API | DESCRIPTION |
|---|---|
| Domains | Performance Quoting Domains APIs allow the management of Dynamic Filters. Dynamic filters are stored in a dedicated domain service which can only be administrated via APIs. See the change log for information on changes between versions. |
| Model | Performance Quoting Model APIs allow the management of Quote Models. See the change log for information on changes between versions. |
| Quote | Performance Quoting Quote APIs allow to perform operations on quotes. See the change log for information on changes between versions. |
| eCommerce | Performance Quoting eCommerce APIs are used to perform operations on quotes and microsites for Collaborative Quoting. See the change log for information on changes between versions. |
| Data Provider | Performance Quoting Data Provider APIs are used to perform operations on data providers. See the change log for information on changes between versions. |
| Quote Designer | Performance Quoting Quote Designer APIs allow to perform operations on data providers. See the change log for information on changes between versions. |
| Export | Performance Quoting Export APIs allow to perform export operations. See the change log for information on changes between versions. |
| User Interface | Performance Quoting User Interface APIs allow to perform operations on the user interface. See the change log for information on changes between versions. |
Catalog, Configurator, Cart APIs
This table shows the available APIs for Smart CPQ (included in the Catalog, Configurator, & Cart Javadoc).
| API | DESCRIPTION |
|---|---|
| Versioning and Distribution Web Services | The webservices are used to version and distribute Smart CPQ models. All projects, all underlying objects, all basic data and all business rules which have been created in the Designer can be versioned and distributed. |
| Engines REST | These REST APIs provide capabilities of various Smart CPQ Solution engines: Catalog engines Configurator engines NeedAnalyzers engines: for Guided Selling iterations ManufacturingGenerators engines Note that unlike conventional REST web services, these API are stateful for performance reasons. Each API call needs an authentication that will, in case of success, return a JSESSIONID cookie within the answer, if it was not already present in the request. This JSESSIONID cookie corresponds to a session managed on server side, valid for 30 minutes and renewed at each new API call with the corresponding JSESSIONID cookie. Thus, one shall incorporate this JSESSIONID cookie on every API call. |
| UI Web Services | These Web Services consist of: A catalog UI (CatalogUISkeleton) to manage actions on catalog UI. A configurator UI (ConfiguratorUISkeleton) to manage actions on configurator UI. |
| Cart | These APIs gather all the actions that can be triggered from the Cart. |
| Cart Web Services | These Web Services gather all the actions that can be done on the Cart. |
| Catalog Web Services | These APIs detail Smart CPQ Catalog Web Service. The web service is a stateless session (CatalogStatelessWS) to export or search products. |
| Engines | These engine APIs provide capabilities of various Smart CPQ Solution engines: Catalog engines Configurator engines Need Analyzer engines: for Guided Selling interactions Manufacturing Generator engines Business Properties Validator engines: for BP validation Note that these API are stateful for performance reasons. |
| Configurator UI Web Services | This document is the specification for the ConfiguratorUI API. |
| Configurator Web Services | These Web Services consist of: One web service with a stateful session (ConfiguratorStatefulWS) to interact with the engine configurator, One web service with a stateless session (ConfiguratorStatelessWS) to load and run configuration. |
| Eximp Web Services | Smart CPQ Eximp Web Services can be used to Export or Import Smart CPQ catalog and configuration models in XML or XLSX format, and manage the Smart CPQ model versions. |
| Business Property Modeling Engine | These APIs detail Smart CPQ Business Property Modeling Engine services and Smart CPQ Business Property Validator engine. |
| Control Pricing DataSync Web Services | These APIs detail PPSS DataSync Web Services. |
| Report Management REST | These APIs detail Report Management Web Services. |