パートナー連携API

Firecrawl パートナー連携API を使うと、承認済みパートナーは自社プラットフォーム内から直接、ユーザー向けの Firecrawl APIキーを作成・管理できます。これにより、ユーザーはパートナーのプラットフォームを離れることなく Firecrawl の利用を開始でき、シームレスなオンボーディングを実現できます。

クレジット、有効期限、プランの上限など、パートナーユーザーに付与される内容の詳細については、Partner Credits を参照してください。

https://integrations.firecrawl.dev

すべての パートナー連携API リクエストには、パートナーキーを含む Authorization ヘッダーが必要です。

Authorization: Bearer <partner key>

パートナーキーは通常のFirecrawl APIキーとは異なり、Firecrawlチームから直接提供されます。

• サーバーサイドのみ: パートナーキーは、サーバーサイドのコードでのみ使用してください。フロントエンドのコード、クライアントサイドの JavaScript、モバイルアプリケーションでは、パートナーキーを決して公開しないでください。
• 利用規約: POST /partner/v1/accounts を呼び出す前に、ユーザーに Firecrawl の利用規約への同意を求める必要があります。

ユーザーのメールアドレスに紐づくFirecrawl APIキーを作成します。

POST /partner/v1/accounts

• ユーザーがまだ Firecrawl アカウントを持っていない場合は、新しいユーザーとチームが作成されます。
• ユーザーがすでに Firecrawl アカウントを持っていても、パートナー連携に関連付けられたチームがない場合は、新しいパートナー連携用のチームが作成されます。
• ユーザーがすでに Firecrawl アカウントを持っており、パートナー連携に関連付けられたチームもすでにある場合は、既存のチームが返され、プロモーションクーポンは 再適用されません。

curl -X POST "https://integrations.firecrawl.dev/partner/v1/accounts" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

ボディ

200 OK

{
  "apiKey": "fc-...",
  "alreadyExisted": false
}

Firecrawl APIキーを検証し、関連するチーム名とユーザーのメールアドレスを返します。APIキーが有効と判定されるのは、このパートナー連携を通じて作成された場合に限られます。

POST /partner/v1/api-keys/validate

• Firecrawl APIキーには権限設定や有効期限がありません。
• APIキーは、ユーザーがいつでも手動で削除できます。
• 削除されたAPIキーはソフトデリートされません。Firecrawlでは、削除されたキーと、そもそも存在しなかったキーを区別できません。

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-..."}'

ボディ

200 OK

{
  "teamName": "Example Team",
  "email": "[email protected]"
}

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

POST /partner/v1/api-keys/rotate

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-..."}'

ボディ

200 OK

{
  "apiKey": "fc-..."
}

Firecrawlのパートナープログラムは、承認済みのプラットフォーム向けに提供されています。ご自身のプラットフォームにFirecrawlを統合し、ユーザーにクレジットを提供することにご関心がある場合は、詳細の確認やパートナー向けAPIキーの申請について [email protected] までお問い合わせください。