メインコンテンツへスキップ

​
概要

Firecrawl パートナー連携API を使うと、承認済みパートナーは自社プラットフォーム内から直接、ユーザー向けの Firecrawl APIキーを作成・管理できます。これにより、ユーザーはパートナーのプラットフォームを離れることなく Firecrawl の利用を開始でき、シームレスなオンボーディングを実現できます。
Partner API へのアクセスは、承認済みの Firecrawl パートナーのみに提供されます。パートナーキーは、承認済みパートナーにのみ非公開で共有されます。パートナープログラムへの申請、またはパートナー APIキーのリクエストは、partnerships@firecrawl.dev までメールでご連絡ください。
クレジット、有効期限、プランの上限など、パートナーユーザーに付与される内容の詳細については、Partner Credits を参照してください。

​
ベース URL

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
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"}'
ボディ
フィールド型必須説明
emailstringはいユーザーのメールアドレス

​
レスポンス

200 OK 
{
  "apiKey": "fc-...",
  "alreadyExisted": false
}
フィールド型説明
apiKeystringこのユーザーのパートナーに関連付けられたチームの Firecrawl APIキー
alreadyExistedbooleanユーザーとパートナーに関連付けられたチームの両方がすでに存在していた場合は true。true の場合、プロモーションクーポンは再適用されません。

​
エラー

ステータス説明
401認証されていません - パートナーキーが誤っているか無効です
500サーバー内部エラー - これらのエラーは Firecrawl 側で監視されています

​
APIキーの検証

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

​
重要な注意点

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

​
リクエスト

cURL
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-..."}'
ボディ
フィールド型必須説明
apiKeystringはい検証対象の API キー

​
レスポンス

200 OK 
{
  "teamName": "Example Team",
  "email": "user@example.com"
}
フィールドタイプ説明
teamNamestringこのAPIキーに関連付けられたチーム名
emailstringこのAPIキーに関連付けられたユーザーのメールアドレス

​
エラー

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

​
APIキーを再発行

既存のFirecrawl APIキーを削除し、同じユーザーとチーム向けに新しいキーを作成します。 
POST /partner/v1/api-keys/rotate

​
リクエスト

cURL
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-..."}'
ボディ
フィールド型必須説明
apiKeystringはい削除して新しいものに置き換える API キー

​
レスポンス

200 OK 
{
  "apiKey": "fc-..."
}
フィールド型説明
apiKeystring新しく作成されたAPIキー

​
エラー

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

​
パートナーになる

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