Welcome to Customer's Canvas Documentation
Customer's Canvas is a web-to-print system which 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 consists of the following sections: Getting Started, APIs, SDKs, and IT Administration.
Getting Started
It contains the overview of Customer's Canvas components, as well as the information how to work with them. You will also find here some suggestions how to use Customer's Canvas in typical scenarios along with some tutorials. It is highly recommended to start learning Customer's Canvas from here.
Here is a list of the most important articles.
APIs
This section will be more interesting to the backend developers who are interested to see how to work with Customer's Canvas components through API. Each section includes not just the API reference but also the how-to articles and concept explanations.
- Customer's Canvas Backend Services
- Design Editor Web API
- Dynamic Image API
- Preflight Tool APIs
- Packaging Editor APIs
SDKs
In addition to APIs, Customer's Canvas also offers some JavaScript libraries which helps to configure and customize personalization tool interface. Also, it includes the Design Atoms SDK to help you working with the designs in your frontend and backend code.
IT Administration
This section will be interesting to the IT Operations teams who maintain Design Editor and other Customer's Canvas components on their servers. If you are using a cloud version of Customer's Canvas, you may skip this section.
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.