Firecrawl for Platforms

​

概要

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

​

Gateway

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

​

ベースURL

https://integrations.firecrawl.dev

​

認証

Authorization: Bearer <platform key>

​

セキュリティ要件

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

​

エンドポイント

​

ユーザーの作成

POST /partner/v1/accounts

​

動作

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

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

​

リクエスト

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

​

レスポンス

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

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

​

Errors

​

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 <platform key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'

​

レスポンス

{
  "teamName": "Example Team",
  "email": "user@example.com"
}

​

Errors

​

APIキーのローテーション

POST /partner/v1/api-keys/rotate

​

リクエスト

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": "fc-..."
}

​

Errors

​

はじめに