Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -130,19 +130,6 @@ div.nav-tabs :not(a[data-active="true"]) {
border-radius: 8px;
}

/* ── Buttons (primary) ─────────────────────────────────────────────────────── */
button[class*='primary'],
a[class*='button'][class*='primary'] {
background-color: var(--df-primary);
color: #fff;
border-radius: 6px;
}

button[class*='primary']:hover,
a[class*='button'][class*='primary']:hover {
background-color: var(--df-navy);
}

/* ── Tables ────────────────────────────────────────────────────────────────── */
thead {
background-color: var(--df-sidebar);
Expand Down
2 changes: 1 addition & 1 deletion index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Each API uses a different subdomain pattern:
| Category Merchandising | `https://{zone}-category-merchandising.doofinder.com` |

<Note>
Your search zone is shown in the [Doofinder Admin Panel](https://admin.doofinder.com). All Search API keys are zone-prefixed (e.g. `eu1-ab46030x...`).
Your search zone is shown in the [Doofinder Admin Panel](https://admin.doofinder.com). The zone prefix on API keys (e.g. `eu1-ab46030x...`) is optional — the zone is determined by the hostname you call.
</Note>

## Authentication at a Glance
Expand Down
21 changes: 5 additions & 16 deletions introduction/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,16 @@ Generate an API key in the [Doofinder Admin Panel](https://admin.doofinder.com/a
Only the API key of the **account owner** is valid for API operations. Keys generated by team members will not work.
</Warning>

### Search API: zone-prefixed format
### Key format

When calling the Search API, prepend your zone to the key:
The same key works across all APIs. You may see it written with a zone prefix (e.g. `eu1-ab46030x...`) — this prefix is optional and ignored by the API. Both formats are valid:

```
eu1-ab46030xza33960aac71a10248489b6c26172f07
eu1-ab46030xza33960aac71a10248489b6c26172f07 ← zone prefix included (optional)
ab46030xza33960aac71a10248489b6c26172f07 ← no prefix (also valid)
```

The prefix (`eu1`, `us1`, `ap1`) routes the request to the correct datacenter.

<Warning>
Always use the prefix that matches your search engine's zone. Using a mismatched zone prefix will result in authentication errors.
</Warning>

### Management & Stats API: unprefixed format

When calling the Management or Stats API, use the key without a zone prefix:

```
ab46030xza33960aac71a10248489b6c26172f07
```
The zone that serves your request is determined by the **hostname** you call, not by the key.

---

Expand Down
2 changes: 1 addition & 1 deletion introduction/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The request is missing an `Authorization` header, or the provided API key is inv
**Common causes:**
- No `Authorization` header sent
- API key has been revoked or does not exist
- Wrong key format (e.g. missing the zone prefix for the Search API, or including it for the Management API)
- Wrong key format (e.g. using a JWT token where a plain token is expected)

---

Expand Down
2 changes: 1 addition & 1 deletion search-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Replace `{search_zone}` with your zone (`eu1`, `us1`, `ap1`).

## Authentication

The Search API uses zone-prefixed API keys:
The Search API uses the standard Doofinder API key. The zone prefix is optional:

```http
Authorization: Token eu1-ab46030xza33960aac71a10248489b6c26172f07
Expand Down