Skip to content

身份认证 ​

开放平台采用两段式认证:API Key 用于换取 Access Token,Access Token 用于调用业务 API。

获取 Access Token ​

POST/v1/auth/token

请求头 ​

请求头必填说明
x-api-key是开放平台生成的项目 API Key
Content-Type是固定为 application/json

请求体 ​

字段类型必填说明
project_nostring是项目页面展示的公开项目编号,最大 64 个字符
user_idstring是接入方业务系统中的稳定用户标识,最大 256 个字符
json
{
  "project_no": "prj_your_project_no",
  "user_id": "your_user_001"
}

响应体 ​

json
{
  "code": 200,
  "message": "success",
  "data": {
    "access_token": "eyJhbGciOiJSUzI1NiIs...",
    "token_type": "Bearer",
    "expires_in": 86400
  }
}
字段类型说明
codeinteger200 表示成功
access_tokenstringJWT Access Token
token_typestring固定为 Bearer
expires_inintegerToken 有效期,单位秒(实测为 86400)

携带 Access Token ​

所有宠物 AI 请求均应使用标准 Bearer 认证;Authorization 由开放平台网关校验,网关校验通过后向服务注入用户上下文请求头 x-qj-user:

http
Authorization: Bearer <ACCESS_TOKEN>
bash
curl 'https://open-api.habitaxx.com/v1/ms-ai-fast/locales' \
  --header "Authorization: Bearer ${ACCESS_TOKEN}"

Token 使用建议 ​

  1. 在服务端缓存 Access Token,并根据 expires_in 提前刷新。
  2. 不要在每个业务请求前重复换取 Token。
  3. 不要解析 Token 后依赖其内部字段实现业务逻辑;以开放平台响应为准。
  4. 同一项目下,同一业务用户应持续使用相同的 user_id。
  5. API Key 泄露后应立即在控制台禁用并重新生成。

凭证安全

文档中的 qj_live_your_api_key、prj_your_project_no 和 eyJ... 均为占位值。请勿把真实 API Key 或 Access Token 提交到 Git。

最近更新

栖界开放平台 · API Documentation