API 概览
使用 API 之前，请先创建 API Key。
认证方式
所有 Palm X 接口均通过 HTTPS Bearer Auth + API Key 认证。
| 项目 | 值 |
|---|---|
| Security Scheme Type | https |
| HTTP Authorization Scheme | bearer |
| 凭证类型 | API Key（ak_ 前缀） |
在开发者控制台申请 API Key：
每个请求均需在 Header 中携带：
Authorization: Bearer ak_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
⚠️ API Key 属于服务端凭证，请勿嵌入客户端代码、公开仓库或移动应用安装包中。如发生泄露，请立即在控制台删除并重新生成。
公共约定
| 项目 | 值 |
|---|---|
| 接口域名 | https://open.intl.palm.tencent.com |
| URL 格式 | POST /palm/openai/<接口名> |
| Content-Type | application/json; charset=utf-8 |
| 字段命名 | PascalCase（如 UserId、RgbImage） |
| 图片传输 | Base64 编码字符串，置于 RgbImage.Data |
所有接口返回统一响应结构：
{
"code": 0,
"message": "ok",
"requestId": "4d5912a82af144f8a982c2da031c1035",
"data": {}
}
| 字段 | 类型 | 说明 |
|---|---|---|
code | Integer | 业务错误码。0 表示成功；非 0 表示失败，详见 错误码 |
message | String | 错误描述（成功时为 "ok"） |
requestId | String | 请求唯一 ID，排查问题时请务必提供 |
data | Object | 业务数据，详见各接口文档 |
功能分类
掌纹管理接口（RGB）
| 接口名称 | 接口功能 | 频率限制(次/秒/AppId) |
|---|---|---|
| RegisterRgbPalm | 注册 RGB 掌纹 | 20 |
| CompareRgbPalm | 比对 RGB 掌纹（1:1） | 20 |
| SearchRgbPalm | 检索 RGB 掌纹（1:N） | 20 |
| DeletePalm | 删除掌纹 | 20 |
频率限制
- 默认频率限制：每个接口 20 次/秒（按凭证独立计数）。
- 超出频率限制时，API 将返回 HTTP
429或业务错误码2060002（too many requests）。请降低 QPS；如需更高限额，请联系官方申请提额。 - 容量类业务错误码（如
2080014、2080020）表示掌纹库容量已满，请联系官方申请扩容，或先删除无用掌纹。详见 错误码。
试用与付费：自应用创建起 90 天内可免费使用；90 天后将受到调用次数与掌纹库容量限制，付费购买 License 即可解除限制。具体计费规则以后续官方公告为准。