1. CPQ
  2. External Integrations
  3. Embed API

Understanding the Embed API

Article last updated:

Using the Embed API, you can embed your Epicor CPQ configurators and scenes into any other webpage to create a seamless experience for your users.

Further Reading

Embedding Options

  • Embed a configurator and its viewer into any web page.
    Show the configurator, along with any related 3D scene or 2D graphics, sizing the overall embed precisely how you want it.
  • Optionally Style the configurator with a theme.
    Match the font and colors of the surrounding web page for a seamless fit.
  • Optionally Gather real-time information from an existing form on the surrounding page.
    For example, if you have a form with an input field 'width' on your web page, and the embedded configurator has a field of the same name, then changes to that field in the webform will automatically drive the Width field in your configurator, run your rules, and update the 3D scene. With no code for your webmaster to write.
  • Optionally Send real-time information back to the surrounding page.
    For example, if you have an analytics engine gathering statistics on your web site, and a configurator is embedded into a page on that web site, have the configurator send information back to the page, so it can be seen and gathered by your analytics engine.
  • A configurator along with a 3D scene.
    This is the most common implementation. Since a configurator can show a scene within its viewer, you can simply embed that configurator into your web page, and the scene will be automatically included.
  • A 3D scene all by itself. 
    Since most scenes rely on a configurator, embedding a scene independently is less common. 

Embedding Limitations

Embedding a configurator into a "host" page on your web server or mobile app gives you the most flexibility in controlling when the configurator appears, and to whom. However, along with this flexibility comes some responsibilities.

  • Accept Third-Party Cookies.
    Since your users viewing this "host" page will be looking at content from both your servers and the Epicor CPQ platform servers, their browsers should allow third-party cookies.
  • Leverage the existing authentication on your webserver.
    When viewing this "host" page, your users want to see the embedded configurator, not an embedded login screen. Follow our suggested architecture in the page of common embed use cases, so you don't have to manage a second set of logins.
  • Build the browsing path to create new or edit existing configured products.
    We make it easy to have your configurator appear in any "host" web page. But your web site or app needs to help your users get there.
    • To create their configured product, your users will probably want to browse through a list of your products to find the page with the embedded configurator.
    • To review the configured product at a later date, your user may want to browse through a list of all the configurations they've submitted to find and view a specific one.
    The Embed API does not include any screens to help your users find new configurators, or old configured products. Therefore, if your requirements include customers being able to view these lists, then include that functionality in your web-infrastructure. Your web server can securely gather up this data from our infrastructure through our REST API, but it is up to your web server to render this data as useful lists for your users.

 

Don't forget the Channels feature.
The embed API gives you precise control over the appearance of configurators, and is ideal for exposing your configurator to the general public. However, if you simply want a turn-key solution for your distributors or resellers, consider the Channels feature. You have only basic control over the configurator styling, but get our existing Products and Quotes tabs, so there's no need to create your own catalog.

 


Was this article helpful?