Welcome to Customer's Canvas Documentation
- 2-3 minutes to read
Customer's Canvas is a web-to-print system that consists of several components, libraries, and APIs. You can use these components separately or together to build various web-to-print solutions, such as e-commerce with the product personalization, marketing material automation projects, and others.
This documentation describes the usage of the system from various perspectives — a backend developer who integrates Customer's Canvas with some system, a frontend developer who configures the editor, an IT operations specialist who maintains a self-hosted version of Customer's Canvas.
How this documentation is organized?
The documentation describes the following packages:
Personalization Platform
In this section, you will learn the cloud version of Customer's Canvas. It allows you to use the API for integration into your site as well as the on-premises version. However, you don't need to deploy, configure, and maintain the SDK on your server.
- What are Personalization Platform services
- Using Personalization Platform services
- Creating a custom integration
Design Editor
It contains the overview of the editors. When you need working with the back end, you can refer to the description of a RESTful API. Customer's Canvas also offers JavaScript libraries, which help to configure and customize the personalization tool interface. You will also find here references of JavaScript libraries and .NET packages. Each section includes not just the API reference but also the how-to articles and concept explanations.
- Understanding print products
- Editor configuration
- Design Editor APIs
- Design Atoms Reference
- IframeApi.js Reference
UI Framework
This framework helps you organize a multistep editor for personalization, set up its user interface, and integrate with e-commerce systems. In this section, you will learn concept of the framework and its programming language, descriptions of UI Framework widgets, and how to configure the editor. Each widget description includes links to the API reference.
Preflight
It's crucial to perform validation on a print-ready file to guarantee that the final product meets customer expectations. Customer's Canvas Preflight is an add-on that can enable these features on your website.
Dynamic Image
This section describes how you can upload Photoshop files to the Dynamic Image and make REST API requests to apply commands to those PSD files, like insert the image from http://example.com/1.jpg to the Photo Placeholder layer and change the color of the Background layer to #00FF00. The Dynamic Image will render the PSD file with the requested changes, save the resulting image inside the application, and return a link to this image.
Legacy
This section describes applications that, while still functional, rely on outdated processes. To enhance efficiency, we recommend transitioning to modern approaches integrated within our cloud-based solution.
User guide
Before diving into the integration and customization tasks, you may want to learn how to use Customer's Canvas from the end users' perspective - designers, online store content managers, production team who fulfill orders.
Legal information
Any questions?
We do a lot of efforts to keep this documentation comprehensive and actual. However, it is inevitable that certain subjects are not covered as thorough as you need. Don't hesitate to contact us for any questions and suggestions how to improve this documentation.