# @aurigma/axios-design-atoms-api-client

> Axios API Client for Design Atoms API service of Customer's Canvas web-to-print system.

Latest version **2.82.1** (published 2026-09-03) · SEE LICENSE IN License.md license · 0 weekly downloads

## Install

```sh
npm install @aurigma/axios-design-atoms-api-client
pnpm add @aurigma/axios-design-atoms-api-client
yarn add @aurigma/axios-design-atoms-api-client
bun add @aurigma/axios-design-atoms-api-client
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.82.1 |
| Published | 2026-09-03 |
| First published | 2022-02-08 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN License.md |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Aurigma Inc |
| Maintainers | asimontsev, t.vybornova, vitaliykozlov |
| Keywords | customer's canvas, web-to-print, api client, design atoms |

## Links

- npm: https://www.npmjs.com/package/@aurigma/axios-design-atoms-api-client
- Homepage: https://customerscanvas.com
- Issues: https://customerscanvas.com/account/cases
- npm.io page: https://npm.io/package/@aurigma/axios-design-atoms-api-client

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.1.3

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 2.82.1 (latest) — 2026-09-03
- 2.80.14 — 2026-07-22
- 2.80.12 — 2026-07-22
- 2.80.11 — 2026-07-22
- 2.80.8 — 2026-07-20
- 2.80.6 — 2026-07-20
- 2.80.1 — 2026-07-02
- 2.79.3 — 2026-06-15
- 2.79.1 — 2026-06-04
- 2.77.4 — 2026-04-15
- 2.76.4 — 2026-02-12
- 2.74.1 — 2025-11-18
- 2.73.1 — 2025-10-09
- 2.72.1 — 2025-09-11
- 2.71.1 — 2025-08-07
- … 58 more at https://npm.io/package/@aurigma/axios-design-atoms-api-client/versions

## README

# Aurigma Customer's Canvas SDK - Design Atoms API Client

This module is an Axios API client for Design Atoms API service which is a part of [**Customer's Canvas**](https://customerscanvas.com) web-to-print system. It is supposed that you are familiar with its services and understand how to use its APIs. To learn more about Customer's Canvas and its services, refer the [Getting Started section of its documentation](https://customerscanvas.com/dev/getting-started/intro.html).

The API client is automatically generated with [NSwag tool](https://github.com/RicoSuter/NSwag). If for any reasons this API client does not work well for you, feel free to generate it yourself using Swagger document published at [Customer's Canvas API Gateway](https://api.customerscanvashub.com/).

## Pre-requisites

To be able to use this package, you need to meet the following requirements:

- You must have an account at Customer's Canvas.
- You need to use it in Javascript\Typescript applications.

For other platforms, see the [Backend services](https://customerscanvas.com/dev/getting-started/about-backend-services.html) article in Customer's Canvas documentation.

## Usage

Install it as a regular npm package:

```
npm install @aurigma/axios-design-atoms-api-client
```

### NodeJs

Receive an access token through your backend as explained in the [documentation](https://customerscanvas.com/dev/getting-started/about-backend-services.html#authorization) and deliver it to your app.

```js
const designAtomsApiClient = require("@aurigma/axios-design-atoms-api-client").DesignAtomsApiClient;
const axios = require("axios").default;

// You need to create external app in BackOffice with required scopes to receive clientId\clientSecret
// https://customerscanvas.com/dev/getting-started/about-backend-services.html#authorization
const clientId = "";
const clientSecret = "";
const apiUrl = "https://api.customerscanvashub.com/";

const getToken = async (clientId, clientSecret) => {
  const requestConfig = {
    method: "post",
    url: apiUrl + "connect/token",
    headers: {
      "Content-Type": "application/x-www-form-urlencoded",
    },
    data: new URLSearchParams({
      client_id: clientId,
      client_secret: clientSecret,
      grant_type: "client_credentials",
    }),
  };

  const response = await axios(requestConfig);
  return response.data["access_token"];
};

const token = await getToken(clientId, clientSecret);
```

And then you can call ApiClients methods with this token:

```js
const config = new designAtomsApiClient.ApiClientConfiguration();
config.apiUrl = apiUrl;
config.setAuthorizationToken(token);

const buildInfoClient = new designAtomsApiClient.BuildInfoApiClient(config);
const buildInfo = await buildInfoClient.getInfo();

console.log(token);
console.log(buildInfo);
```

### Frontend

You should retrieve access token from your backend, how it's explained above.

```ts
import { DesignAtomsApiClient } from "@aurigma/axios-design-atoms-api-client";

// get token on backend by clientId\clientSecret. Never use clientId\clientSecret on frontend!
// https://customerscanvas.com/dev/getting-started/about-backend-services.html#authorization
const token = "";

const config = new DesignAtomsApiClient.ApiClientConfiguration();
config.apiUrl = "";
config.setAuthorizationToken(token);

const buildInfoClient = new DesignAtomsApiClient.BuildInfoApiClient(config)
buildInfoClient.getInfo().then(data => console.log(data));
```

To find out what other clients are available in this module, refer [Design Atoms API Reference](https://customerscanvas.com/dev/backend/backend/api/DesignAtoms.OpenApi2.html).

> NOTE: The class name for each client is formed as <i>ClientName</i>ApiClient, e.g. `BuildInfo` -> `BuildInfoApiClient`, etc.

---
_Source: https://npm.io/package/@aurigma/axios-design-atoms-api-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._