Docs认证 (Auth)
认证 (Authentication)
所有需要认证的 Findip API 请求都必须在 X-API-Key 请求头中携带 API 密钥。
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请求限制为每分钟60次，统计所有API请求。触发限制时，API会返回429 Too Many Requests。
密钥管理
在仪表盘中可方便地管理 API 密钥。
- 按环境（开发、生产）发行多个密钥
- 立即吊销（Revoke）泄露的密钥
- 监控每个密钥的使用量和请求日志