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

# Firecrawl for Platforms

> ユーザーの Firecrawl APIキーを作成・管理するプラットフォーム向けの APIリファレンス

<h2 id="overview">
  概要
</h2>

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

<Note>
  Firecrawl for Platforms は、[Firecrawl ダッシュボード](https://www.firecrawl.dev/app/partner-api)からご自身で設定できます。組織の管理者またはメンバーであれば誰でも連携を作成できます。連携に名前を付けて連携タイプを選択し、そのタイプの規約に同意したうえで、プラットフォームキーをコピーしてください。キーは一度しか表示されません。キーの発行と失効は、後から設定で行えます。申請や承認は不要です。
</Note>

連携タイプは2種類あります。どちらも同じプラットフォームキーを使い、以下のエンドポイントから同じ方法でアカウントをプロビジョニングします。違いは、ユーザーの利用料金を誰が支払うかです。

* **Standard**: ユーザーが Firecrawl に直接支払います。プロビジョニングされた各アカウントはそれぞれ独自の Firecrawl プランと課金を持ち、Free プランから始まり、アップグレードも Firecrawl で直接行います。
* **Gateway**: 貴組織がユーザーの利用料金を負担します。連携によって作成されたアカウントは Gateway に登録され、ユーザー自身のクレジットを使い切った後の対象利用分は貴組織に請求されます。詳しくは後述の [Gateway](#gateway) を参照してください。

連携タイプは連携の作成時に選択します。後から変更するのは容易ではないため、規約に同意する前に両方のタイプを十分に比較検討することをお勧めします。概要については [Firecrawl for Platforms ページ](https://www.firecrawl.dev/firecrawl-for-platforms)を参照してください。

一部のパートナーオファーには、プロビジョニングされたユーザー向けのプロモーションクレジットが含まれます。その場合にユーザーが受け取る内容については、[Partner Credits](/ja/partner-credits) を参照してください。

<h3 id="gateway">
  Gateway
</h3>

Gateway は連携の種類の一つであり、独立した API ではありません。プラットフォームキーもエンドポイントも共通です。Gateway 連携で異なる点は次のとおりです。

* アカウントはお客様の連携専用として作成され、API 経由でのみ利用できます。そのアカウント自体でダッシュボードにログインすることはできません。メールアドレスが既存の Firecrawl アカウントと一致する場合でも、リクエストが既存のアカウントに紐付けられることはありません。
* まずユーザー自身のクレジットが消費されます。それを超えた分のうち対象となる利用分は、お客様の組織に請求されます。
* `POST /partner/v1/accounts` のレスポンスには `gatewayStatus` フィールドが含まれます。
* 連携の作成時に、Gateway 版の規約に同意したものとみなされます。

<h2 id="base-url">
  ベースURL
</h2>

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

<h2 id="authentication">
  認証
</h2>

Platforms API へのリクエストには、すべてプラットフォームキーを指定した `Authorization` ヘッダーが必要です：

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

プラットフォームキーは、通常の Firecrawl APIキーとは別のものです。プラットフォームキーの作成と失効は、[Firecrawl ダッシュボード](https://www.firecrawl.dev/app/partner-api)の「設定 > Firecrawl for Platforms」から行います。

<h2 id="security-requirements">
  セキュリティ要件
</h2>

* **サーバーサイドのみ**: プラットフォームキーは必ずサーバーサイドのコードでのみ使用してください。フロントエンドのコード、クライアントサイドの JavaScript、モバイルアプリケーションにプラットフォームキーを決して含めないでください。
* **利用規約**: `POST /partner/v1/accounts` を呼び出す前に、プラットフォーム側でユーザーに Firecrawl の[利用規約](https://www.firecrawl.dev/terms-of-service)への同意を求める必要があります。

***

<h2 id="endpoints">
  エンドポイント
</h2>

<h3 id="create-user">
  ユーザーの作成
</h3>

メールアドレスで識別される自社ユーザー向けにFirecrawlアカウントをプロビジョニングし、そのAPIキーを返します。

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

<h4 id="behavior">
  動作
</h4>

**Standard** 連携の場合:

* ユーザーがまだ Firecrawl アカウントを持っていない場合は、新しいユーザーと Team が作成されます。
* ユーザーがすでに Firecrawl アカウントを持っているものの、自社の連携に紐づく Team がない場合は、その連携に紐づく新しい Team が作成されます。
* ユーザーがすでに Firecrawl アカウントを持ち、自社の連携に紐づく Team もある場合は、既存の Team が返されます。

**Gateway** 連携の場合:

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

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

<h4 id="request">
  リクエスト
</h4>

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

**ボディ**

| フィールド | 型 | 必須 | 説明 |
| - | - | - | - |
| `email` | string | はい | ユーザーのメールアドレス。Gateway 連携の場合は、アカウントの連絡先メールアドレスとして保存されます。 |

<h4 id="response">
  レスポンス
</h4>

**`200 OK`**

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

Gateway 連携の場合、レスポンスには登録ステータスも含まれます：

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

| フィールド | 型 | 説明 |
| - | - | - |
| `apiKey` | string | お使いの連携がこのユーザー向けにプロビジョニングしたTeamのFirecrawl APIキー |
| `alreadyExisted` | boolean | お使いの連携がこのメールアドレスのアカウントをすでにプロビジョニングしていた場合は `true`。Firecrawlの他の場所にこのメールアドレスが存在するかどうかは示しません。 |
| `gatewayStatus` | string | Gateway連携のみ。アカウントを作成する呼び出しでは `enrolled`、同じメールアドレスでの2回目以降の呼び出しでは `already_enrolled` になります。 |

<h4 id="errors">
  Errors
</h4>

| ステータス | 説明 |
| - | - |
| `400` | 不正なリクエスト - `email` が指定されていないか、形式が正しくありません |
| `401` | 未認証 - プラットフォームキーが誤っているか、無効です |
| `500` | 内部サーバーエラー - このエラーは Firecrawl 側で監視されています |

***

<h3 id="validate-api-key">
  APIキーの検証
</h3>

Firecrawl APIキーを検証し、関連付けられたTeam名とユーザーのメールアドレスを返します。APIキーが有効と判定されるのは、お使いの連携経由で作成されたキーである場合のみです。

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

<h4 id="important-notes">
  重要な注意事項
</h4>

* Firecrawl APIキーには、権限や有効期限は設定されていません。
* APIキーは、ユーザーがいつでも手動で削除できます。
* 削除されたAPIキーは論理削除ではなく、完全に削除されます。そのため、Firecrawlは削除されたキーと最初から存在しないキーを区別できません。

<h4 id="request-2">
  リクエスト
</h4>

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

**ボディ**

| フィールド | 型 | 必須 | 説明 |
| - | - | - | - |
| `apiKey` | string | はい | 検証対象のAPIキー |

<h4 id="response-2">
  レスポンス
</h4>

**`200 OK`**

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

| フィールド | 型 | 説明 |
| - | - | - |
| `teamName` | string | このAPIキーに関連付けられたTeamの名前 |
| `email` | string | アカウントのプロビジョニング時に使用されたメールアドレス。Gatewayアカウントの場合は、指定した連絡先メールアドレスです。 |

<h4 id="errors-2">
  Errors
</h4>

| ステータス | 説明 |
| - | - |
| `400` | 不正なリクエスト - APIキーの形式が正しくありません |
| `401` | 未認証 - プラットフォームキーが正しくないか、無効です |
| `404` | APIキーを識別できません - キーが存在しないか、お使いの連携を通じて作成されたキーではありません |
| `500` | 内部サーバーエラー - このエラーは Firecrawl 側で監視されています |

***

<h3 id="rotate-api-key">
  APIキーのローテーション
</h3>

既存のFirecrawl APIキーを削除し、同じユーザーとTeamに紐づく新しいキーを作成します。

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

<h4 id="request-3">
  リクエスト
</h4>

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

**ボディ**

| フィールド | 型 | 必須 | 説明 |
| - | - | - | - |
| `apiKey` | string | はい | 削除して新しいキーに置き換えるAPIキー |

<h4 id="response-3">
  レスポンス
</h4>

**`200 OK`**

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

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

<h4 id="errors-3">
  Errors
</h4>

| ステータス | 説明 |
| - | - |
| `401` | 未認証 - プラットフォームキーが正しくないか、無効です |
| `404` | APIキーを識別できません - キーが存在しないか、お使いの連携経由で作成されたものではありません |
| `500` | 内部サーバーエラー - これらのエラーは Firecrawl が監視しています |

***

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

[Firecrawl ダッシュボード](https://www.firecrawl.dev/app/partner-api)で連携を作成します。サインインして Standard または Gateway を選択し、規約に同意したうえで、プラットフォームキーをコピーしてください。連携の種類は後から簡単には変更できないため、規約に同意する前に選択内容を必ずご確認ください。その後、サーバーから上記のエンドポイントを呼び出します。セットアップに関するご質問は [help@firecrawl.com](mailto:help@firecrawl.com) までお寄せください。より大規模な連携をご検討の場合は、[partnerships@firecrawl.dev](mailto:partnerships@firecrawl.dev) までご連絡ください。