パートナー連携API

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.

https://api.firecrawl.dev

Authorization: Bearer <partner key>

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

POST /admin/integration/create-user

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

curl -X POST "https://api.firecrawl.dev/admin/integration/create-user" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'

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

POST /admin/integration/validate-api-key

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

curl -X POST "https://api.firecrawl.dev/admin/integration/validate-api-key" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'

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

POST /admin/integration/rotate-api-key

curl -X POST "https://api.firecrawl.dev/admin/integration/rotate-api-key" \
  -H "Authorization: Bearer <partner key>" \
  -H "Content-Type: application/json" \
  -d '{"apiKey": "fc-..."}'

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