> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 合作伙伴集成 API

> 供已获批的 Firecrawl 合作伙伴为其用户创建和管理 API 密钥的 API 参考

<div id="overview">
  ## 概述
</div>

Firecrawl 合作伙伴集成 API 允许已获批准的合作伙伴直接在自己的平台内为其用户创建和管理 Firecrawl API 密钥。这让用户无需离开合作伙伴的平台，即可无缝完成接入并开始使用 Firecrawl。

<Note>
  Partner API 访问权限**仅对已获批准的 Firecrawl 合作伙伴开放**。合作伙伴密钥会私下提供给已获批准的合作伙伴。如需申请加入合作伙伴计划或申请合作伙伴 API 密钥，请发送邮件至 [partnerships@firecrawl.dev](mailto:partnerships@firecrawl.dev)。
</Note>

有关合作伙伴用户可获得内容的详细信息，包括额度、有效期和套餐限制，请参见 [Partner Credits](/zh/partner-credits)。

<div id="base-url">
  ## 基本 URL
</div>

```
https://integrations.firecrawl.dev
```

<div id="authentication">
  ## 身份验证
</div>

所有 合作伙伴集成 API 请求都必须在 `Authorization` 标头中附带您的合作伙伴密钥：

```bash theme={null}
Authorization: Bearer <partner key>
```

合作伙伴密钥与标准 Firecrawl API 密钥不同，由 Firecrawl 团队直接提供。

<div id="security-requirements">
  ## 安全要求
</div>

* **仅限服务器端**：合作伙伴密钥只能用于服务器端代码。切勿在前端代码、客户端 JavaScript 或移动应用中暴露合作伙伴密钥。
* **服务条款**：调用 `POST /partner/v1/accounts` 前，你的平台必须提示用户接受 Firecrawl 的 [服务条款](https://www.firecrawl.dev/terms-of-service)。

***

<div id="endpoints">
  ## 接口
</div>

<div id="create-user">
  ### 创建用户
</div>

创建与用户邮箱地址关联的 Firecrawl API 密钥。

```
POST /partner/v1/accounts
```

<div id="behavior">
  #### 行为
</div>

* 如果用户尚未拥有 Firecrawl 账户，则会创建一个新用户和新团队。
* 如果用户已拥有 Firecrawl 账户，但还没有与你的合作伙伴集成关联的团队，则会创建一个新的合作伙伴关联团队。
* 如果用户已拥有 Firecrawl 账户，并且已经有与你的合作伙伴集成关联的团队，则会返回现有团队，且**不会**再次应用促销优惠券。

<div id="request">
  #### 请求
</div>

```bash cURL theme={null}
curl -X POST "https://integrations.firecrawl.dev/partner/v1/accounts" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'
```

**请求体**

| 字段      | 类型     | 必填 | 描述     |
| ------- | ------ | -- | ------ |
| `email` | string | 是  | 用户邮箱地址 |

<div id="response">
  #### 响应
</div>

**`200 OK`**

```json theme={null}
{
  "apiKey": "fc-...",
  "alreadyExisted": false
}
```

| 字段               | 类型      | 描述                                                    |
| ---------------- | ------- | ----------------------------------------------------- |
| `apiKey`         | string  | 该用户所属合作伙伴关联团队的 Firecrawl API 密钥                       |
| `alreadyExisted` | boolean | 如果该用户及其合作伙伴关联团队都已存在，则为 `true`。为 `true` 时，不会再次应用促销优惠券。 |

<div id="errors">
  #### 错误
</div>

| 状态    | 描述                            |
| ----- | ----------------------------- |
| `401` | 未授权 - 合作伙伴密钥不正确或无效            |
| `500` | 服务器内部错误 - 这些错误会由 Firecrawl 监控 |

***

<div id="validate-api-key">
  ### 验证 API 密钥
</div>

验证 Firecrawl API 密钥，并返回关联的团队名称和用户邮箱地址。只有通过此合作伙伴集成创建的 API 密钥才会被视为有效。

```
POST /partner/v1/api-keys/validate
```

<div id="important-notes">
  #### 重要说明
</div>

* Firecrawl API 密钥不设权限，也不会过期。
* 用户可以随时手动删除 API 密钥。
* 已删除的 API 密钥不会进行软删除。Firecrawl 无法区分某个密钥是已被删除，还是从未存在过。

<div id="request">
  #### 请求
</div>

```bash cURL theme={null}
curl -X POST "https://integrations.firecrawl.dev/partner/v1/api-keys/validate" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'
```

**请求体**

| 字段       | 类型     | 必填 | 描述          |
| -------- | ------ | -- | ----------- |
| `apiKey` | string | 是  | 待验证的 API 密钥 |

<div id="response">
  #### 响应
</div>

**`200 OK`**

```json theme={null}
{
  "teamName": "Example Team",
  "email": "user@example.com"
}
```

| 字段         | 类型     | 描述                 |
| ---------- | ------ | ------------------ |
| `teamName` | string | 与此 API 密钥关联的团队名称   |
| `email`    | string | 与此 API 密钥关联的用户邮箱地址 |

<div id="errors">
  #### 错误
</div>

| 状态    | 描述                                 |
| ----- | ---------------------------------- |
| `401` | 未授权 - 合作伙伴密钥不正确或无效                 |
| `404` | API 密钥无法识别 - 该密钥不存在，或并非通过此合作伙伴集成创建 |
| `500` | 内部服务器错误 - 此类错误会由 Firecrawl 监控      |

***

<div id="rotate-api-key">
  ### 轮换 API 密钥
</div>

删除现有的 Firecrawl API 密钥，并为同一用户和团队生成一个新的密钥。

```
POST /partner/v1/api-keys/rotate
```

<div id="request">
  #### 请求
</div>

```bash cURL theme={null}
curl -X POST "https://integrations.firecrawl.dev/partner/v1/api-keys/rotate" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'
```

**请求体**

| 字段       | 类型     | 必填 | 描述             |
| -------- | ------ | -- | -------------- |
| `apiKey` | string | 是  | 要删除并替换的 API 密钥 |

<div id="response">
  #### 响应
</div>

**`200 OK`**

```json theme={null}
{
  "apiKey": "fc-..."
}
```

| 字段       | 类型     | 描述          |
| -------- | ------ | ----------- |
| `apiKey` | string | 新创建的 API 密钥 |

<div id="errors">
  #### 错误
</div>

| 状态    | 描述                                 |
| ----- | ---------------------------------- |
| `401` | 未授权 - 合作伙伴密钥不正确或无效                 |
| `404` | API 密钥无法识别 - 该密钥不存在，或并非通过此合作伙伴集成创建 |
| `500` | 内部服务器错误 - 此类错误会由 Firecrawl 监控      |

***

<div id="become-a-partner">
  ## 成为合作伙伴
</div>

Firecrawl 的合作伙伴计划仅向获批平台开放。如果你有意将 Firecrawl 集成到自己的平台中，并向用户提供额度，请通过 [partnerships@firecrawl.dev](mailto:partnerships@firecrawl.dev) 联系我们，了解更多信息并申请合作伙伴 API 密钥。