> For the complete documentation index, see [llms.txt](https://support.ordereazi.com/central/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.ordereazi.com/central/order-management/integrations/api-keys.md).

# API Keys

Create API keys that let other systems read and write your OrderEazi data, and limit what each key can see.

When an online shop or another system needs your products, or needs to send you orders, it connects to the API (the way other systems connect to OrderEazi to read and send data) with a key. Each API key in OrderEazi has its own permissions, so a shop that only needs products can't see your clients. You can also hide categories, brands, suppliers, and products from a key, and choose the prices it sees.

### Before you start

You'll need the **API Keys** permission, in the **Integrations** permission group. If you don't have it, ask your OrderEazi administrator to add it to your role.

> **Warning:** An API key works like a password for another system. Only give it to the system that needs it, and delete it when that system stops using it.

### How to create an API key

1. In the main menu, go to **Integrations** > **API Keys**.
2. Select **Add Api Key**.
3. Enter an **Application Name**, such as "WebShop". It can't be changed later.
4. Under **Permissions**, tick **Read** or **Write** for each kind of data the system needs (see below).
5. To limit the key further, use the other tabs (see below).
6. Select **Create**.

You see "API Key for" and the name "has been created." To see the key, open the menu on its row and select **View Key**, then select the copy icon.

### The permissions

| Permission                  | What it gives access to                                                                                                                  |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| **For Products**            | Products, prices, pricelists, images, stock levels, and branding.                                                                        |
| **For Clients**             | Clients, their addresses, and End Users.                                                                                                 |
| **For Supplier**            | Suppliers.                                                                                                                               |
| **For Project**             | Projects, their documents and lines, and creating orders.                                                                                |
| **For Administrative Data** | Reference data such as branches, brands, categories, warehouses, users, sales channels, and webhooks, plus courier quotes and shipments. |
| **For OData (PowerBI)**     | Your data in reporting tools such as Microsoft Power BI, read only.                                                                      |
| **For Rounding**            | Your rounding settings, read only.                                                                                                       |

**Read** lets the system look at the data. **Write** lets it create and change it. Give each key only what it needs.

### How to limit what a key sees

* **Categories, Brands, Suppliers, and Products:** Tick what to hide from the key. On the category and brand tabs, products with no category or brand are hidden too.
* **Pricelists:** Choose the **Pricelist** the key's prices come from. Products not on that pricelist are hidden. Tick **Exclude out of Stock** to hide products with no stock.
* **Branch Access:** Tick the branches whose prices the key can see. With none ticked, no branch prices are included.

These limits apply to the API only. A key with **For OData (PowerBI)** reads all of your data through OData, so keep reporting keys separate. See [OData and Power BI](/central/developers/odata-and-power-bi.md).

**Example:** You sell clothing and stationery, but your online shop sells clothing only, at retail prices. You create a "WebShop" key with **Read** on **For Products** and **Write** on **For Project**. On **Pricelists**, you choose your "Retail" pricelist, and on **Categories**, you hide "Stationery". The shop sees only your clothing, at retail prices, and can send in orders.

### How to change or delete a key

1. In the main menu, go to **Integrations** > **API Keys**.
2. Open the menu on the key's row.
3. Select **Update Permission** to change its permissions and tabs, then select **Update**.
4. Or select **Delete**, and confirm "Yes, delete it!", to remove the key. The system using it can no longer connect.

To replace a key, delete it and create a new one.

Keys created by apps you install from the App gallery are listed under **Application API Keys (Apps)**. You can update their permissions, but not delete them here.

### Giving the key to the other system

Copy the key and give it, securely, to whoever sets up the other system. Their developer will find everything they need in your API reference, at your OrderEazi address followed by `/api/v2/`, such as <https://yourcompany.ordereazi.com/api/v2/>. Select **Api Reference** at the top of the **API Keys** page to open it.

### Related pages

* [Sales Channels](/central/order-management/integrations/sales-channels.md): where orders from the API arrive
* [OData and Power BI](/central/developers/odata-and-power-bi.md): use the OData permission