Developer Center

This section covers the Personalization Platform — a set of backend services and frontend components that let you build web-to-print applications, integrate with e-commerce systems, and automate print production workflows.

The platform exposes REST API for managing designs, products, and orders, and provides web components (Workflow Elements) that you can embed into your storefront to enable personalization, configuration, and approval workflows.

Sections

Concepts

Learn the key concepts behind Customer's Canvas: storefronts and storefront users, products and variants, PIM, design templates, mockups, projects, pipelines, and retention policies. Understanding these entities is essential before you start building integrations.

Implementation Scenarios

Step-by-step guides for typical use cases:

• Online Store — Connect an e-commerce system, configure products, open the editor for customers, and receive print-ready files.
• Direct Mail — Pre-design variable templates, specify personalization data, preview variable data designs, and render print files.
• Mockup-based Product Images — Render preview images with mockups for product catalogs.

REST API

The Personalization Platform provides several REST API services accessible through an API Gateway at https://api.customerscanvashub.com/. Authorization is based on OAuth2 (Client Credentials flow). Available services include:

• Asset Storage API — Manages designs, fonts, images, and other assets (CRUD operations).
• Asset Processor API — Imports designs, generates previews, and processes assets.
• Asset Generator API — Creates die-cut templates and 3D mockups.
• Design Atoms API — Works with the design object model (useful for building custom editors).
• Storefront API — Handles storefront registration, customer management, and project operations.
• BackOffice API — Manages tenant data and PIM products.

Official API clients are available for .NET and TypeScript/Angular. You can also generate clients from OpenAPI specs or write your own wrappers.

Frontend Integration

Embed Customer's Canvas editors and workflow components into your storefront:

• Prepare environment for frontend integration — Build a custom integration for any storefront, supporting both Product Specification and PIM product types.
• Workflow elements — Web components for building personalization workflows: Handy Editor, Simple Editor, Template Editor, Customers Canvas Options, and Configurator.
• UI Framework & StorefrontJS — A JavaScript library that simplifies storefront integration by handling authorization, editor loading, and workflow file management.

Samples

Sample applications in our GitHub repository illustrating practical API use cases in different programming languages, including basic Python samples, a Direct Mail app, and Workflow Elements examples.