Docs認証 (Auth)
認証 (Authentication)
認証が必要なすべての FindIP API リクエストでは、API キーを X-API-Key ヘッダに含める必要があります。
API キー形式
API キーは psk_live_xxxxxxxxxxxxxxxx 形式です。API キーは お問い合わせ から発行いたします。
ご注意
API キーは安全に保管してください。クライアントサイドコード、公開リポジトリ、ブラウザリクエストに露出させないでください。サーバ環境変数またはサーバサイドプロキシをご利用ください。
認証付きリクエスト
API キーを X-API-Key ヘッダに含めます(Bearer プレフィックスは使用しません)。
cURL
curl -X POST https://api.findip.ai/api/v1/search/semantic \
-H "X-API-Key: psk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{"query": "semiconductor etching process", "top_k": 5}'Python
import requests
response = requests.post(
"https://api.findip.ai/api/v1/search/semantic",
headers={
"X-API-Key": "psk_live_your_api_key",
"Content-Type": "application/json",
},
json={
"query": "semiconductor etching process",
"top_k": 5,
},
)
data = response.json()JavaScript (Node.js)
const response = await fetch("https://api.findip.ai/api/v1/search/semantic", {
method: "POST",
headers: {
"X-API-Key": "psk_live_your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify({
query: "semiconductor etching process",
top_k: 5,
}),
});
const data = await response.json();公開エンドポイント
GET /api/v1/drawings/...、GET /api/v1/stats/coverage、ヘルスチェックには X-API-Key ヘッダは不要です。
リクエスト上限 (Rate Limiting)
検索呼び出しはサブスクリプションプランの月間枠から控除されます。詳細・図面・番号照会はカウントされません。枠を超えると API は 429 Too Many Requests を返します。すべての呼び出しに分間 60 回のレート制限が別途適用されます。
| プラン | 月間検索枠 |
|---|---|
| Free | 月 30 回 |
| Basic | 月 300 回 |
| Pro | 月 1,000 回 |
| Enterprise | 別途協議 |
キー管理
ダッシュボードから API キーを簡単に管理できます。
- 環境(開発、本番)ごとに複数のキーを発行
- 流出したキーを即時失効(Revoke)
- キー別の使用量とリクエストログをモニタリング