Docs認証 (Auth)
認証 (Authentication)
認証が必要なすべての Findip API リクエストでは、API キーを X-API-Key ヘッダに含める必要があります。
API キー形式
API キーは pmk_live_xxxxxxxxxxxxxxxx 形式です。API のご利用は お問い合わせ ください。ご契約後、API 従量契約の請求担当アカウントでログインし、ダッシュボードの API キー 画面からキーを発行していただけます。
ご注意
API キーは安全に保管してください。クライアントサイドコード、公開リポジトリ、ブラウザリクエストに露出させないでください。サーバ環境変数またはサーバサイドプロキシをご利用ください。
認証付きリクエスト
API キーを X-API-Key ヘッダに含めます(Bearer プレフィックスは使用しません)。
cURL
curl -X POST https://api.findip.ai/api/v1/search/semantic \
-H "X-API-Key: pmk_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": "pmk_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": "pmk_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リクエストは1分あたり60回に制限され、すべてのAPIリクエストを数えます。上限に到達した場合、APIは429 Too Many Requestsを返します。
キー管理
ダッシュボードから API キーを簡単に管理できます。
- 環境(開発、本番)ごとに複数のキーを発行
- 流出したキーを即時失効(Revoke)
- キー別の使用量とリクエストログをモニタリング