Skip to main content

FAQs

Here are some frequently asked questions (FAQs) related to the epigraph-configurator web component.

Where do I start?​

Please follow our Quick Setup Guide to get started with the initial setup for epigraph-configurator. It goes through the basics and even contains links within to navigate you through the process.

We will soo create a video walk-through of the process, to make things even easier to understand.

Where do I import the web component from?​

Epigraph configurator npm package (to always gets the latest version): https://cdn.jsdelivr.net/npm/@epigraph/configurator

Besides, if you wish to stick to a specific major version like 1.x.x, you could use this URL instead: https://cdn.jsdelivr.net/npm/@epigraph/[email protected]

As a general rule, it is a good idea to only pull the updates for a major version but we also make sure to keep our clients posted when there is a breaking update like that.

We follow Semantic versioning for our packages.

I am building my own UI, how do I subscribe/listen to an event from the configurator?​

We have a full guide explaining how events work in the epigraph-configurator, here: Core Events

I see some unfamiliar terminologies being used throughout the documentation, how do I learn more about them?​

If words like, ghosts, items, sku, etc. sound confusing to you. We have a full guide explaining this: Configurator Terminologies

What is a client-access-key and how do I get one?​

A client-access-key is the first level security to ensure that an unauthorised source cannot use the configurator on their website.

Each key:

  1. relates to a project ID that we internally create (not exposed anywhere).
  2. Only works for the authorised domains. You are required to submit a request to add your domains to a given key.

You only need to request the client-access-key at the beginning, when you are starting with the implementation and can request more domains to be whitelisted for that key.