Freewebstore API

A brief guide and explanation detailing the perks of using Freewebstore's API feature and how to gain an API key from within your control panel.

Getting Started with our API

The API allows you to connect to your store data directly via code. This opens up limitless integration possibilities. Perhaps link your store directly to your warehouse for order processing? Or hook it up to your email marketing campaigns?

It really is powerful stuff, the possibilities are endless.

If you have not been given an API Key yet, simply click the Request an API Key button in the Store API panel.

For more information view our API documentation.

How do I obtain an API key?

To gain an API key:

1. Log in to your freewebstore control panel.

2. Click the API button located at the bottom of the side panel on the left.

3. Once the page has loaded, simply click the Request an API Key button.

You will then be provided with your API key for your control panel and online store. Further actions open up to along with being able to see all requests the API has received.

How do I delete an API key?

To delete an API key:

1. Log in to your freewebstore control panel.

2. Click the API button located at the bottom of the side panel on the left.

3. Click the Revoke button next to your API key.

This will delete your current API key. If you need another in the future, you will need to request a new one.

How do I add a webhook to the API?

To add a webhook:

1. Log in to your freewebstore control panel.

2. Click the API button located at the bottom of the side panel on the left.

3. When the page has loaded, you will see that the bottom panel has two tabs, API requests and Webhooks. Click Webhooks.

4. The bottom panel will then change so that you can see the webhooks (if any) you already have in place. To add a webhook, click the Add Webhook button here.

5. A new window will open with two fields that you will need to complete, simply enter the URL for the webhook you wish to add and select the desired webhook type.

6. Click "Create" when you are happy.

You will now see that the webhook is added to the Webhooks panel.

How do I delete a webhook connected to the API?

To delete a webhook:

1. Log in to your freewebstore control panel.

2. Click the API button located at the bottom of the side panel on the left.

3. Click to view the Webhooks tab.

4. Locate the webhook you wish to delete and click the Delete button.

How do I download my API keys to a CSV file?

To export your API keys to a CSV file:

1. Log in to your freewebstore control panel.

2. Click the API button located at the bottom of the side panel on the left.

3. Click the Download as CSV File button at the bottom of the API keys panel. A download will then start and you will receive the requested file containing information such as:

   • your API Key

   • usage of the API key

   • overall percentage

How do I filter the API call types?

In order to filter the different calls made to the API:

1. Log in to your freewebstore control panel.

2. Click the API button located at the bottom of the side panel on the left.

3. To the right of your screen, you will notice a panel labeled Page Filters. Here, by checking the appropriate boxes, you can change the different API calls that appear in the API Requests panel.

The filters you can use here are:

• All

• GET

• POST

• DELETE

• PUT

• Errors