認証
認証
FourA APIへのすべてのrequestには認証が必要です。このページでは、API keyの取得、使用、管理方法について説明します。
API keyの取得
- FourA Dashboardにサインインします
- API Keysページに移動します
- Create Keyをクリックします
- 確認ダイアログからkeyをコピーします
API keyの形式は次のとおりです: pk_live_a1b2c3d4e5f6...
現在作成されるkeyは再表示が可能です。後からkeyの行にある目のアイコンをクリックすると、必要に応じてシークレット全体を再表示できます(表示フローと権限についてはAPI Keysの管理を参照してください)。再表示機能のリリース前に作成されたレガシーkeyは再表示できず、鍵アイコンが表示されます。切り替えるには一度再生成してください。
API keyの使用
すべてのrequestのX-API-Key headerにAPI keyを含めます:
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 | キーの誤り、余分な空白、または無効化されたキーです | キーを確認し、空白を削除するか、ダッシュボードから新しいキーを作成してください |
成功か失敗かを問わず、すべてのレスポンスには X-Foura-Request-Id ヘッダーが含まれます。ただし、FourA がまったく読み取れないボディ (不正な形式の JSON、または 100 KB を超えるボディ) は ID が割り当てられる前に拒否されるため除外されます。後からサポートが特定の呼び出しを調査できるよう、クライアント側でこれを記録してください。
次のステップ
- クイックスタート: 初回リクエストの実行
- API キーの管理: キーの表示、編集、再生成、削除
- API エンドポイント: エンドポイント完全リファレンス
- エラーハンドリング: 認証エラーを適切に処理