認証
FourA API へのすべてのリクエストには認証が必要です。このページでは、API キーの取得、使用、管理方法について説明します。
API キーの取得
- FourA ダッシュボードにサインインします
- API Keys ページに移動します
- Create Key をクリックします
- 確認ダイアログからキーをコピーします
API キーの形式は次のとおりです: pk_live_a1b2c3d4e5f6...
現在作成されるキーは再表示が可能です。後からキーの行にある目のアイコンをクリックすると、必要に応じてシークレット全体を再表示できます(表示フローと権限については API キーの管理 を参照してください)。再表示機能のリリース前に作成された従来のキーは再表示できず、南京錠アイコンが表示されます。切り替えるには一度再生成してください。
API キーの使用
すべてのリクエストの X-API-Key ヘッダーに API キーを含めます:
curl -X POST https://eu.api.foura.ai/api/single/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"method": "GET", "url": "https://example.com"}'
Pythonの場合:
import requests
response = requests.post(
"https://eu.api.foura.ai/api/single/",
headers={
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={"method": "GET", "url": "https://example.com"}
)
Node.js の場合:
const response = await fetch('https://eu.api.foura.ai/api/single/', {
method: 'POST',
headers: {
'X-API-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});
APIキーのセキュリティ
APIキーはパスワードと同様に取り扱ってください。
- バージョン管理にコミットしないこと。 代わりに環境変数を使用してください。
- クライアント側コードで公開しないこと。 サーバー側アプリケーションでのみ使用してください。
- 漏洩した場合はローテーションすること。 Dashboardからキーを再生成してください。古いシークレットは1分以内に機能しなくなります。また、キーの表示はすべて監査ログに記録されるため、不正アクセスされた認証情報の事後特定も容易です。
環境変数の使用
キーは環境変数に保存してください。
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
コード内でそれを参照します。
import os
api_key = os.environ["FOURA_API_KEY"]
const apiKey = process.env.FOURA_API_KEY;
一般的な認証エラー
すべての認証エラーは 401 Unauthorized ステータスを返します。
| エラー | メッセージ | 原因 | 対処法 |
|---|---|---|---|
| 401 | Missing API key. Include X-API-Key header. | リクエストに X-API-Key ヘッダーが含まれていません |
X-API-Key ヘッダーを追加してください |
| 401 | Invalid API key | キーが誤っている、不要な空白がある、または無効化されたキーです | キーを確認し、空白を削除するか、ダッシュボードから新しいキーを作成してください |
データベースのフェイルオーバー中など、FourA が一時的にキーを検証できない場合は、401 ではなく、API key check temporarily unavailable および Retry-After: 5 とともに 503 を返します。待機後に再試行してください。キー自体に問題はありません。
成功か失敗かにかかわらず、すべてのレスポンスには X-Foura-Request-Id ヘッダーが付与されます。ただし、FourA がまったく読み取れないボディ(不正な形式の JSON や 100 KB を超えるボディなど)は ID が割り当てられる前に拒否されます。後でサポートが特定の呼び出しを調査できるよう、クライアント側でこれを記録してください。
次のステップ
- クイックスタート: 最初のリクエストを送信する
- API キーの管理: キーの表示、編集、再生成、削除
- API エンドポイント: エンドポイント完全リファレンス
- エラーハンドリング: 認証エラーを適切に処理する