---
title: "How to Enable an API Key"
canonical: "https://bizcore.refined.site/space/BCKB/1948090409/How%20to%20Enable%20an%20API%20Key"
format: markdown
---
> Macro (toc)

# **Overview**

API Keys provide a variety of functionality within the Biz Core platform, they enable the Payment Gateway where customers can make payments or set up their own Direct Debit Agreements, and allow users to build and share Self-Service Pages for customers to purchase products or services.

These Pages provide a completely dynamic experience for customers. As users edit, add, enable or disable their products the page will update in real time, while the link that is shared with customers will never change. In order to allow the Self-Service Page to accurately reflect the products and services available, or to activate the Payment Gateway, users can follow these steps to enable their API Key.

> ℹ️ Whether users intend on using both the Payment Gateway and the Self-Service Page, or just one of them, they will only need to set up a single API Key.

---

## **Step 1 - Add a New API Key**

Within Biz Core, using the sidebar, users navigate to **Settings → Advanced** and select the API KEYS tab at the top:

![add-new-api-key.gif](media://c09d8e23-7a39-4a84-b1dd-4705e611243e)

From here:

- Click on the Subscription API Keys widget to expand it:

![image](media://2b352531-f8ce-4ae0-a399-15a08982d6c6)

- To add a new API Key, click the **Add New API Key** :plus: button. An input box labeled Description will appear. Enter a clear description to help identify what the API key is used for (in the below example we have used “Payment Gateway and Self-Service Page”) before clicking **ADD**:

![image](media://95d83c0a-3351-42e8-b7a2-abfb60588579)

- After clicking ADD the API Key Created popup window will appear, users must ensure they save the Key ID and Key information shown here in a safe place:

![image](media://6b07a354-d099-497e-8df9-cf54c20ddb39)

> ⚠️ API’s Key ID and Key are not recoverable, so it is imperative to copy and safely store this information before continuing to the next step.

## **Step 2 - Enable the New API Key**

After the users saves their Key ID and Key they can click **OK, I HAVE SAVED THIS INFORMATION** to continue:

- Click the Self-Service Settings widget to expand it and enable the Toggle for the newly created API, Payment Gateway and Self-Service Page:

![image](media://1bfde4e3-c15d-46c1-9fd2-ca59dfe2ecda)

> ✅ Users can now share their Self-Service Page with customers, and any changes made to the Products and Product Groups will be updated in real-time.