認証
FourA APIへのすべてのrequestには認証が必要です。このページでは、APIキーの取得、使用、および管理方法について説明します。
APIキーの取得
- FourA Dashboardにサインインします
- API Keysページに移動します
- Create Keyをクリックします
- すぐにキーをコピーします(二度と完全な状態では表示されません)
APIキーは次のようになります:pk_live_a1b2c3d4e5f6...
APIキーの使用
すべてのrequestのX-API-Key headerに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から新しいキーを作成し、古いキーを無効化します。
環境変数の使用
キーを環境変数に保存します:
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-Key headerが含まれていません |
X-API-Key headerを追加します |
| 401 | Invalid API key | 誤ったキー、余分な空白、または無効化されたキー | キーを確認する、空白を削除する、またはDashboardから新しいキーを作成します |
次のステップ
- クイックスタート: 最初のrequestを送信する
- API Endpoints: 完全なendpointリファレンス
- エラーハンドリング: 認証エラーを適切に処理する