認証
認証
FourA APIへのすべてのrequestには認証が必要です。このページではAPIキーの取得、使用、管理方法を説明します。
APIキーの取得
- FourA Dashboardにサインインします。
- API Keysページに移動します。
- Create Keyをクリックします。
- 確認ダイアログからキーをコピーします。
APIキーは次のようになります: pk_live_a1b2c3d4e5f6...
現在作成されたキーは表示可能です。後でキーの行にある目のアイコンをクリックすると、必要に応じて完全なシークレットを再表示できます(表示フローと権限についてはManaging API Keysを参照してください)。表示機能のリリース前に作成されたレガシーキーは再表示できず、ロックアイコンが表示されます。切り替えるには一度再生成してください。
APIキーの使用
すべてのrequestのX-API-Keyheaderに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からキーを再生成します。古いシークレットは即座に機能しなくなり、すべての表示は監査ログに記録されるため、盗まれた認証情報は事後でも容易に発見できます。
環境変数の使用
APIキーを環境変数に保存します:
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. | requestにX-API-Keyheaderがない |
X-API-Keyheaderを追加する |
| 401 | Invalid API key | 誤ったキー、余分な空白、または無効化されたキー | キーを確認し、空白を削除するか、Dashboardから新しいキーを作成する |
成功か失敗かに関わらず、すべてのresponseにはX-Foura-Request-Idheaderが含まれます。後でサポートが特定の呼び出しを調査できるように、そちら側で記録してください。
次のステップ
- Quick Start: 最初のrequestを作成する
- Managing API Keys: キーの表示、編集、再生成、削除
- API Endpoints: 完全なendpointリファレンス
- Error Handling: 認証エラーを適切に処理する