Squarespace

This guide is intended for Squarespace merchants who are connecting their store to Violet. During this process, the merchant will create a new API Key in their Squarespace dashboard and then provide the generated credentials to Violet through the Violet Connect onboarding tool. The merchant will retain full control of the created API Key and can remove it at any time from within their Squareapace dashboard. Total time for completion is around 5 minutes.

​

Step 1: Creating App Credentials

1. Within your Squarespace site admin dashboard navigate to the Settings page using the left sidebar navigation.
2. From the Settings page, expand the Developer Tools section in the left sidebar and click on Developer API Keys.
3. Click the Generate Key button on the Developer API Keys page. A modal will now open.
4. Enter a Key Name for the new API Key that will remind you of the reason for creating this client. This can be as simple as “Violet” or the name of the channel you are connecting to.
5. In the Permissions section ensure that each of the following boxes are checked.
   1. Products → Read Only
   2. Inventory → Read Only
   3. Orders → Read and Write (Orders permission is only required if the channel you are connecting to requires it.)
6. Click the Generate Key button in the upper right corner of the modal. Your API Key will now be created.
7. The modal will refresh and display your new API Key. Copy this token and keep it available for Step 2 of this guide. Once you close the screen with the key you will no longer be able to retreive the key.

​

Step 2: Provide App Credentials to Violet

Once you have your **API Key, it’s time to return to the Violet Connect onboarding tool and enter the following credentials created in the previous steps:

1. When prompted for your store URL, enter the full URL including the protocol. Example - https://example.com.
2. Enter your API Key obtained in the previous steps in the ”API Key” field.

Once entered, click the Connect button to validate the credentials and complete the connection between your store and Violet. If the credentials are invalid you should check for any spaces or other copy/paste errors and try again.

Upon success you will be redirected back to the channel who first sent you to Violet.

​

Troubleshooting