Welcome to The Customiser's Customisation API Documentation. Our platform offers a market-leading customisation experience that enables the custom design and production of even the most complex products. As a hands-on agency composed of product customisation experts and software developers, we work closely with our clients to build and integrate cutting-edge solutions.
Our API empowers e-commerce websites and applications to support:
This documentation is designed to guide you through the process of integrating our powerful customisation tools into your systems. Whether you're looking to enhance your existing e-commerce platform or build a completely new customisation experience, our API provides the flexibility and features you need.
Key Features:
In the following sections, you'll find detailed information on getting started, core concepts, authentication, API reference, file specifications, order processing, and integration guides. Our goal is to make your integration process as smooth and efficient as possible.
Should you have any questions or require assistance, our dedicated support team is always ready to help. Let's begin building extraordinary customisation experiences together!
To begin integrating The Customiser's Customisation API into your system, follow these steps:
Engage with Our Team Contact our sales team to discuss your customisation needs. Once we've agreed to provide a solution, we'll manually set up an account for you.
Receive API Credentials After your account is set up, our team will provide you with your unique Access Token which is essential for API authentication, so keep it secure.
Choose Your Integration Method Based on our discussion, we'll recommend whether you should use our Iframe / WebView or native SDKs. We can provide guidance on the best approach for your specific needs.
Set Up Your Development Environment Ensure your development environment is set up to make HTTPS requests. Our API uses RESTful principles and communicates over HTTPS.
Make Your First API Call With guidance from our team, try making a simple API call to test your setup. We'll provide you with a specific example tailored to your use case.
Explore the Documentation Familiarise yourself with our API capabilities by exploring this documentation.
Plan Your Integration Work with our team to plan out which API endpoints you'll need to use. We'll help you consider aspects like product customisation flow, order processing, and file handling.
Test Thoroughly Before going live, make sure to test your integration thoroughly in a staging environment. Our team will be available to assist with testing various customization scenarios and order processes.
Go Live Once you're confident in your integration, deploy it to your production environment. We recommend monitoring the integration closely during the initial period to ensure everything is working as expected.
Ongoing Support Our team will continue to provide support and updates throughout our partnership. We'll keep you informed of any changes or new features that might enhance your integration.
Remember, our support team is here to help you throughout this process. If you encounter any issues or have questions, don't hesitate to reach out through your designated contact person.
Next, we'll dive into the Core Concepts that are fundamental to understanding and effectively using our Customisation API.
Understanding the following core concepts will help you effectively integrate and use our Customisation API:
Customisation Project A Customisation Project represents a single instance of a product being customised. It contains all the information about the customisations applied, including selected options, images selected and/or upload, and any other modifications.
Product Template A Digital Blank Product is the base model for a customisable product. It defines the available customisation options, constraints, and default settings for a particular product type.
Customisation Options These are the specific areas or features of a product that can be modified. Examples include exact print areas, colour and/or material options, 3D values and customisation tools.
Rendering Rendering refers to the process of generating a visual representation of the customised product. This can be a 2D image or a 3D model, depending on the product and customisation options.
Print-Ready File A Print-Ready File is the final output file that contains all necessary information for production. This file is typically in a high-resolution format suitable for printing or manufacturing. Available as both Vector and Raster options and suitable for all print methods.
Order An Order represents a customer's request to purchase one or more customised products. It includes details about the Customisation Project(s), quantity, pricing, and customer information.
Production Specification The Production Specification is a set of instructions and technical documents generated for each Order, detailing how the customised product should be manufactured or produced.
Dynamic Pricing Dynamic Pricing refers to the automatic calculation of a product's price based on the selected customisation options. This ensures accurate pricing for complex customisations.
Asset Library The Asset Library is a collection of pre-approved images, textures, or 3D models that can be used in customisation. This helps maintain brand consistency and simplifies the customisation process.
Customisation Rules Customisation Rules are predefined constraints that ensure all customisations are feasible and meet quality standards. These rules may prevent certain combinations of options or limit customisation in specific areas.
Preview Generation Preview Generation is the process of creating real-time visual representations of the customised product as changes are made. This allows customers to see the results of their customisations immediately.
Integration Points Integration Points are specific areas in your e-commerce platform where our API can be leveraged. These typically include product pages, shopping carts, and order management systems.
Understanding these concepts will provide a solid foundation for working with our Customisation API. In the following sections, we'll explore how these concepts are applied in practical API usage.
Our system offers two flexible options for setting up customisable products, allowing you to integrate our customisation capabilities seamlessly with your existing e-commerce infrastructure.
With this option, we set up an entirely new e-commerce product within our system, assigning all necessary parameters, values, rules, and other elements that make it customisable.
This option is ideal for new product lines or when you want to create a separate customisable version of an existing product.
This option allows you to take your existing e-commerce products and make them customisable without creating duplicate entries.
Product Catalog retrieval via API or direct e-commerce access: allows our platform to:
API Implementation: The Product Catalog API should include endpoints for:
Customisation Layer: We add a customisation layer to your existing products, defining:
Integration: Our system interfaces via API or direct e-commerce access to seamlessly blend the customisation options with your existing product data.
This option is ideal when you want to add customisation capabilities to your existing product catalog without duplicating product entries.
Option 1 is best for:
Option 2 is best for:
Our team will work with you to determine the best approach based on your specific needs and existing infrastructure.
For detailed API specifications related to Option 2, please refer to the API Reference section, specifically the Product Catalog API endpoints.
Order information files are delivered via:
To facilitate smooth integration with your systems:
For any issues related to file specifications or integration, please contact our technical support team at or through your dedicated account manager.