> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/developer-guides/api-keys.md).

# API Keys

Connect your own systems to Mimeeq securely. Learn what the Embed and Admin APIs do, how to create keys and how to monitor API requests.

Mimeeq gives you two ways to connect your own systems to your Mimeeq account: the **Embed API** and the **Admin API**. This article explains what each one does, how to generate and manage the keys that authenticate them, and what happens to any key you're already using. You'll find everything described here under **Settings → Customer settings → API Management**.

{% hint style="info" %}
For endpoint-level technical details, see our [developer documentation](https://docs.mimeeq.com/authorization-guide/).
{% endhint %}

***

## Embed API and Admin API

<table><thead><tr><th width="60">#</th><th>API</th><th>What it does</th><th>When to use it</th></tr></thead><tbody><tr><td>1</td><td><strong>Embed API</strong></td><td>Powers your customer-facing configurator experience. It handles product listings, configuration details, pricing and short codes — the things your website or storefront needs to show a configured product and its price.</td><td>If you already have an integration built with Mimeeq, it almost certainly uses this API.</td></tr><tr><td>2</td><td><strong>Admin API</strong></td><td>Newer, and for managing your account and catalogue data from your own systems: companies, contacts, products, quotations, carts, price lists, option sets and similar setup data.</td><td>When you want to sync Mimeeq with an ERP, CRM, e-commerce platform or internal tool — for example, pushing quotations into your order system or keeping company records in sync.</td></tr></tbody></table>

![Admin API Keys and Embed API Keys sections under API Management in Mimeeq](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2F5RIZXq0uOroN3YTJYOzc%2Fapi-image-1_1cbd921.png?alt=media)

{% hint style="info" %}
In short: Embed API is about serving configured products to your customers; Admin API is about managing the account and catalogue behind the scenes.
{% endhint %}

***

## Creating an Admin API key

{% stepper %}
{% step %}

### Open API Keys

Go to **Settings → Customer settings → API Management → API Keys**.
{% endstep %}

{% step %}

### Create a new key

In the **Admin API Keys** section, click **+ Create Admin Key**.
{% endstep %}

{% step %}

### Name the key

Give the key a name (required) and, optionally, a description and an expiry date.
{% endstep %}

{% step %}

### Select scopes

Under **Select Scopes**, choose only the resources your integration actually needs (for example, just Companies and Contacts), or check **All scopes** if the integration needs full access.
{% endstep %}

{% step %}

### Create the key

Click **Create**.

![Create Admin Key form with name, description, expiry date and scope selection](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FIFVbOEKzSN8xSWkmU5tt%2Fapi-image-2_9csii2.png?alt=media)
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
Your new key is shown exactly once, in full, right after creation. Copy it and store it somewhere safe — Mimeeq will not display it again. If you lose it, you'll need to create a new key rather than retrieve the old one.
{% endhint %}

{% hint style="success" %}
We recommend scoping keys narrowly and giving each integration its own key, so you can tell them apart in the requests log and revoke one without affecting the others.
{% endhint %}

***

## What about the key I already have?

If you've been using Mimeeq's API before today, you have an **Embed API key** — it now lives under **API Management → API Keys → Embed API Keys**, listed as your **Legacy Embed Key** (or similarly named). This is simply a new home for it in the interface:

* The key's value hasn't changed.
* Your existing integration keeps working exactly as before.
* You don't need to do anything unless you want to.

{% hint style="warning" %}
The only time this key changes is if you choose to regenerate it — in which case the old value stops working immediately, and any integration using it will need to be updated with the new one.
{% endhint %}

This key is separate from the new Admin API keys described above. You don't need an Embed API key to create an Admin API key, or vice versa, since they authenticate two different APIs.

![Legacy Embed Key listed under Embed API Keys](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FBO9YDfnSQ277Af7oRrcg%2Fapi-image-3_10qbf0w.png?alt=media)

***

## Keeping an eye on your API activity

The **Requests Log** tab (next to **API Keys**) shows the calls made with your keys over the last 30 days: timestamp, method, endpoint, status code, which key was used, and response time. Click any row to see full details, including whether the request was authorised, which scope it required, and — for failed requests — the exact error returned.

{% hint style="success" %}
This is the fastest way to check why an integration isn't working. A `403` with a scope-related error usually means the key wasn't granted the permission the endpoint requires; going back into **API Keys** and adding that scope (or creating a new key with it) resolves it.
{% endhint %}

***

## Where to go next

For request and response formats, authentication headers, available endpoints, scopes, pagination and error codes, see the full developer documentation:

* [Admin API introduction](https://docs.mimeeq.com/admin-api-introduction/)
* [Admin API reference](https://docs.mimeeq.com/admin-api-reference/)
* [Admin API conventions](https://docs.mimeeq.com/admin-api-conventions/)
* [Authorisation guide](https://docs.mimeeq.com/authorization-guide/)
* [Embed API reference](https://docs.mimeeq.com/api-reference/)
* [Working with request logs](https://docs.mimeeq.com/api-request-logs/)
* [Migrating between API key types](https://docs.mimeeq.com/api-integration-migration/)

If you're not sure which API or scopes your integration needs, your developer or integration partner can check the reference docs above, or you can reach out to our support team.

***

## Related articles

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Webhooks</strong></td><td>Send real-time Mimeeq event data to your own systems.</td><td><a href="/developer-guides/webhooks.md">Webhooks</a></td></tr><tr><td><strong>Events &#x26; Tracking</strong></td><td>Use configurator events to feed your own analytics.</td><td><a href="/developer-guides/events-and-tracking.md">Events &amp; Tracking</a></td></tr><tr><td><strong>Custom UI</strong></td><td>Build and deploy your own interface around the Mimeeq 3D configurator.</td><td><a href="/developer-guides/custom-ui.md">Custom UI</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/developer-guides/api-keys.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.