API Reference

1 minute to read

In the architecture overview, you may have already learned about BackOffice backend services for managing your data. In this section, you can find a more detailed description and specifications of these services.

API Clients

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.

.NET Client

To use our official .NET client, you just need to install required packages from Nuget:

Install-Package Aurigma.AssetGenerator.ApiClient
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:

C# API Client

Angular Client

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-generator-client
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
npm install @aurigma/ng-storefront-products-api-client

NodeJS Client based on Axious

For NodeJS applications, you may install the following npm 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-design-atoms-api-client
npm install @aurigma/axios-storefront-api-client
npm install @aurigma/axios-storefront-products-api-client

PHP Client

You may use the following composer packages for your PHP apps:

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

Generate your own API client

If you are using some other platform, it is highly recommended generating your own API client through the Swagger Codegen, OpenAPI Generator or your other favorite tools.

You can get the latest Swagger/OpenAPI files (version 3 only) at our cloud version API gateway, depending on your Customer's Canvas subscription:

Authentication

Customer's Canvas API is based on OAuth2 protocol. The following auth flows are supported:

Client Credentials
Implicit
Authorization Code

For more information about it, we recommend to refer the OAuth2 documentation.

To make API calls, you need to request an access token from our identity provider (which is a part of BackOffice service). See the Authentication in Customer's Canvas Hub article for all the details how you can do it each of the supported flow.

This token should be sent along with each request through the Authorization header with the Bearer prefix:

Authorization: Bearer <token>