API Reference

• 1 minute to read

Customer's Canvas provides a powerful REST API for managing your data and integrating with backend services. While you can interact with the API directly via HTTP requests, using our official API clients simplifies development by providing type safety, built-in error handling, and convenient methods for common tasks.

API Clients

Why Use API Clients?

• Type Safety: Compile-time checks for API endpoints and data structures.
• Convenience: Pre-generated methods for all API operations.
• Error Handling: Built-in validation and error responses.
• Documentation: Integrated with your IDE for quick reference.

You can use the API directly via REST or leverage one of our official clients:

• .Net
• Angular
• NodeJS
• PHP
• Python

.NET Client

Use the official .NET client for seamless integration with Customer's Canvas backend services. The client is available as NuGet packages.

Install-Package Aurigma.AssetGenerator.ApiClient
Install-Package Aurigma.AssetStorage.ApiClient
Install-Package Aurigma.AssetProcessor.ApiClient
Install-Package Aurigma.BackOffice.ApiClient
Install-Package Aurigma.DesignAtomsApi.ApiClient
Install-Package Aurigma.StorefrontApi.ApiClient

For a step-by-step guide, see the .NET API Client Tutorial.

Angular Client

If you're building a frontend application with Angular, use our official TypeScript client. Install the required packages via npm:

npm install @aurigma/ng-asset-generator-client
npm install @aurigma/ng-asset-storage-client
npm install @aurigma/ng-asset-processor-client
npm install @aurigma/ng-backoffice-api-client
npm install @aurigma/ng-design-atoms-api-client
npm install @aurigma/ng-storefront-api-client

NodeJS Client (Axios-based)

For NodeJS applications, install the Axios-based API client packages:

npm install @aurigma/axios-asset-generator-api-client
npm install @aurigma/axios-asset-storage-api-client
npm install @aurigma/axios-asset-processor-api-client
npm install @aurigma/axios-backoffice-api-client
npm install @aurigma/axios-design-atoms-api-client
npm install @aurigma/axios-storefront-api-client

PHP Client

For PHP applications, use the following Composer packages:

composer require aurigma/php-asset-storage-client
composer require aurigma/php-asset-processor-client
composer require aurigma/php-backoffice-client
composer require aurigma/php-design-atoms-client
composer require aurigma/php-storefront-client

Python Client

For Python applications, install the required packages via pip:

pip install aurigma-asset-generator-api-client
pip install aurigma-asset-storage-api-client
pip install aurigma-asset-processor-api-client
pip install aurigma-backoffice-api-client
pip install aurigma-design-atoms-api-client
pip install aurigma-storefront-api-client

For a step-by-step guide, see the Python API Client Tutorial.

Generate your own API client

If you're using a platform not listed above, we recommend generating your own API client using tools like:

• Swagger Codegen
• OpenAPI Generator

Download the latest OpenAPI (Swagger) specifications for your region:

• US: https://api.customerscanvashub.com
• EU: https://api.eu.customerscanvashub.com
• AU: https://api.au.customerscanvashub.com

---

Need Help?

Submit a support ticket