> ## Documentation Index
> Fetch the complete documentation index at: https://firecrawl-locadex-parallel-t9n-main-ydzk9zxoc20klj1uk5u1gd5b.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Partner API

> Firecrawlパートナー向けに、ユーザーのAPIキーを作成・管理するためのAPIリファレンス

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

Firecrawl パートナー連携APIを使うと、自社のバックエンドから直接、ユーザー向けのFirecrawl APIキーを作成・管理できます。ユーザーは自社プラットフォームを離れることなくFirecrawlを使い始められます。

<Note>
  パートナーAPIは[Firecrawl ダッシュボード](https://www.firecrawl.dev/app/partner-api)からご自身でセットアップできます。組織の管理者またはメンバーであれば誰でもインテグレーションを作成できます。名前を付け、セットアップを選択し、そのセットアップの規約に同意して、パートナーキーをコピーしてください。キーが表示されるのは一度だけです。キーの発行と失効は後からSettingsで行えます。申請や承認は不要です。
</Note>

セットアップは2種類あります。どちらも以下のエンドポイントを通じて同じ方法でアカウントをプロビジョニングしますが、ユーザーの利用分を誰が支払うかが異なります。

* **Partner API**: プロビジョニングされた各アカウントが独自のFirecrawl planと課金を持ちます。ユーザーはFree planから始め、Firecrawlと直接契約してupgradeします。
* **Gateway**: インテグレーションで作成したアカウントはGatewayに登録され、ユーザー自身のクレジットを使い切った後の対象利用分は自社の組織に課金されます。GatewayのアカウントはAPI専用で、独自のdashboardログインはありません。

セットアップはインテグレーション作成時に選択します。後から変更するのは簡単ではないため、規約に同意する前に両方のオプションをよくご確認いただくことをおすすめします。概要については[Partner APIページ](https://www.firecrawl.dev/partner-program)をご覧ください。

一部のパートナーオファーには、プロビジョニングされたユーザー向けのプロモーションクレジットが含まれます。その場合、ユーザーが受け取る内容については[Partner Credits](/ja/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 ダッシュボード](https://www.firecrawl.dev/app/partner-api)の 設定 > Partner API で作成・失効できます。

<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>

**Partner API** セットアップの場合:

* ユーザーがまだ Firecrawl アカウントを持っていない場合、新しいユーザーとチームが作成されます。
* ユーザーがすでに Firecrawl アカウントを持っているものの、お客様の連携に紐づくチームがない場合、新たにパートナー紐付けチームが作成されます。
* ユーザーがすでに Firecrawl アカウントを持ち、お客様の連携に紐づくチームもある場合は、既存のチームが返されます。

**Gateway** セットアップの場合:

* アカウントはすべて、お客様の連携専用に作成されます。メールアドレスが一致する場合でも、リクエストが既存の Firecrawl アカウントに紐づけられることはありません。メールアドレスはアカウントの連絡先として保存されるだけで、アカウントの検索には使用されません。
* 同じメールアドレスで繰り返し呼び出した場合は、同じアカウントとそのAPIキーが返されます。

お客様の連携にプロモーションクレジットが含まれる場合は、アカウントの初回作成時に一度だけ付与されます。

<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 | はい | ユーザーのメールアドレス。Gateway セットアップでは、アカウントの連絡先アドレスとして保存されます。 |

<div id="response">
  #### レスポンス
</div>

**`200 OK`**

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

Gateway セットアップの場合、レスポンスには登録 status も含まれます。

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

| フィールド            | 型       | 説明                                                                                                   |
| ---------------- | ------- | ---------------------------------------------------------------------------------------------------- |
| `apiKey`         | string  | このユーザーのパートナーに関連付けられたチームの Firecrawl APIキー                                                             |
| `alreadyExisted` | boolean | このメールアドレス向けのアカウントをお使いのインテグレーションがすでにプロビジョニング済みだった場合は `true`。Firecrawl の他の場所にそのメールアドレスが存在するかどうかは示しません。 |
| `gatewayStatus`  | string  | Gateway連携のみ。アカウントを作成する呼び出しでは `enrolled`、同じメールアドレスに対する以降の呼び出しでは `already_enrolled` となります。             |

<div id="errors">
  #### エラー
</div>

| ステータス | 説明                                        |
| ----- | ----------------------------------------- |
| `400` | 不正なリクエスト - `email` が未指定または形式が不正です         |
| `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-2">
  #### リクエスト
</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-2">
  #### レスポンス
</div>

**`200 OK`**

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

| フィールド      | タイプ    | 説明                                                         |
| ---------- | ------ | ---------------------------------------------------------- |
| `teamName` | string | このAPIキーに関連付けられたチーム名                                        |
| `email`    | string | アカウントの発行時に使用されたメールアドレス。Gatewayアカウントの場合は、ご提供いただいた連絡先アドレスです。 |

<div id="errors-2">
  #### エラー
</div>

| ステータス | 説明                                                   |
| ----- | ---------------------------------------------------- |
| `400` | 不正なリクエスト - APIキーの形式が誤っています                           |
| `401` | 未認証 - パートナーキーが誤っているか無効です                             |
| `404` | APIキーを識別できません - キーが存在しないか、このパートナー連携経由で作成されたものではありません |
| `500` | 内部サーバーエラー - これらのエラーは Firecrawl 側で監視されています            |

***

<div id="rotate-api-key">
  ### APIキーを再発行
</div>

既存のFirecrawl APIキーを削除し、同じユーザーとチーム向けに新しいキーを作成します。

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

<div id="request-3">
  #### リクエスト
</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-3">
  #### レスポンス
</div>

**`200 OK`**

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

| フィールド    | 型      | 説明            |
| -------- | ------ | ------------- |
| `apiKey` | string | 新しく作成されたAPIキー |

<div id="errors-3">
  #### エラー
</div>

| ステータス | 説明                                                 |
| ----- | -------------------------------------------------- |
| `401` | 未認証 - パートナーキーが誤っているか無効です                           |
| `404` | API key を特定できません - キーが存在しないか、このパートナー連携経由で作成されていません |
| `500` | 内部サーバーエラー - これらのエラーは Firecrawl 側で監視されています          |

***

<div id="get-started">
  ## はじめに
</div>

[Firecrawl ダッシュボード](https://www.firecrawl.dev/app/partner-api)でインテグレーションを作成します。サインインし、Partner API または Gateway を選択して規約に同意し、パートナーキーをコピーしてください。このセットアップは後から変更することが難しいため、規約に同意する前に選択内容をご確認ください。あとは、上記のエンドポイントをサーバーから呼び出すだけです。セットアップについてご質問がある場合は、[help@firecrawl.com](mailto:help@firecrawl.com) までご連絡ください。より大規模な連携をご検討中の場合は、[partnerships@firecrawl.dev](mailto:partnerships@firecrawl.dev) までご連絡ください。