Registering a storefront

• Last updated on November 11, 2024
• •
• 1 minute to read

Before you can manage the integration parameters of an online store in your Customer's Canvas account, you need to enter some information about it.

Customer's Canvas allows you to organize simultaneous work with several online stores in one account if needed. It provides a single platform for managing product designs and flexible customization of personalization parameters.

Adding a storefront

You can only register storefronts in your Customer's Canvas account through the user interface.

To add information about a new store:

1. Log in to your Customer's Canvas account.
2. On the main menu, click Settings.
3. Click the Integrations tab and then click Create new.
4. Type in the store name and select the Custom integration type.

As already noted, Customer's Canvas supports dedicated schemes for integration with online stores based on popular e-commerce platforms. In this scenario, we consider the most complex integration type, which involves performing all the integration work by oneself.

Registering a new store is an important procedure that is always performed manually by users in the BackOffice admin panel. You cannot register one through the API.

Data access using the Storefront API

Let's take a look at Storefront API that provides programmatic access to information about the online store.

The dedicated integration entity storefront is responsible for storing information about online stores connected to your Customer's Canvas account.

You can use the endpoint Storefronts_GetAll to get the available information about all online stores connected to a Customer's Canvas account.

For example, if a tenant ID is 12345, the API call may look like this.

• cURL
• HTTP
• C#
• TS
• PHP

curl -X \
  GET "https://api.customerscanvashub.com/api/storefront/v1/storefronts?tenantId=12345" \
  -H  "accept: text/plain" \
  -H  "Authorization: Bearer <TOKEN>"

Note that you need to store either the ID or name of the returned model on the online store side to manage the integration parameters of this store.

---

Next, let's learn how to add users to your storefront.