As explained in the architecture overview article, there are several services are available to manage your data.
- Asset Storage - CRUD operations for your assets
- Asset Processor - manipulations on the assets, such as import or generate a preview
- Design Atoms API - can be used if you are building your own editor based on Design Atoms SDK
- Storefront API - allows for connecting online store, its products and orders to Customer's Canvas infrastructure.
You can use it as a REST API by sending HTTP requests directy, or alternatively, you may work through the API clients. At the moment we have official API clients for .Net and Angular.
To use our official .NET client, you just need to install required packages from Nuget:
Install-Package Aurigma.AssetStorage.ApiClient Install-Package Aurigma.AssetProcessor.ApiClient Install-Package Aurigma.DesignAtomsApi.ApiClient Install-Package Aurigma.StorefrontApi.ApiClient
See this tutorial for more details how to use it:
If you are building a frontend application using Angular framework, you may use an official TypeScript client for Angular. Just install the required packages from npm:
npm install @aurigma/ng-asset-storage-client npm install @aurigma/ng-asset-processor-client npm install @aurigma/ng-design-atoms-api-client npm install @aurigma/ng-storefront-api-client
Generate your own API client
You can get the latest Swagger/OpenAPI files (version 3 only) at our cloud version API gateway.
Customer's Canvas API is based on OAuth2 protocol. To make API calls, you need to request an access token from our identity provider (which is a part of BackOffice service). This token should be sent along with each request through the
Authorization header with the
Authorization: Bearer <token>
To receive the access token, it is necessary to send a POST request as explained in OAuth2 documentation to the so-called access token URL:
At this moment, we support only the client_credentials grant type. The client ID and secret may be created in your tenant settings (the External Apps tab).