> 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 A guide to Mimeeq API keys: what the Embed API and Admin API do, how to generate a key, and how to monitor API requests ## Content 1. [Overview](#overview) 2. [Creating an Admin API key](#creating-an-admin-api-key) 3. [What about the key I already have?](#what-about-the-key-i-already-have) 4. [Keeping an eye on your API activity](#keeping-an-eye-on-your-api-activity) 5. [Where to go next](#where-to-go-next) ## Overview 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** is what 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. If you already have an integration built with Mimeeq, it almost certainly uses this API. **Admin API** is newer, and it's for managing your account and catalog data from your own systems: companies, contacts, products, quotations, carts, price lists, option sets, and similar setup data. Use it 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. ![Admin and Embed API Keys 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 catalog behind the scenes. {% endhint %} ## Creating an Admin API key 1. Go to **Settings → Customer settings → API Management → API Keys**. 2. In the **Admin API Keys** section, click **+ Create Admin Key**. 3. Give the key a name (required) and, optionally, a description and an expiry date. 4. 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. 5. Click **Create**. {% 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 %} 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. ![How to create an Admin API key](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) ## 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. 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. 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](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 authorized, which scope it required, and — for failed requests — the exact error returned. 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. ## 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/) * [Authorization 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. --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.mimeeq.com/developer-guides/api-keys.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.