Cleer
申请接入
API 参考 › iframe 嵌入
POST/sso/partner-login

iframe 嵌入:为合作方平台用户换取工作台票据

平行接入模式(与 API Key 的 /v1/token 互不依赖,按场景选用)。

需要 Bearer 令牌

请求体

字段必填类型约束说明
app_id必填string格式 ^app_[a-z0-9]+$我们发放给贵司的应用标识(AppID)
app_secret必填string≥32应用密钥(AppSecret,仅贵司服务端保管;错误返回 401)
external_user_id必填string≤160贵司平台用户的唯一标识
target_project必填string目标工作台项目(如 dsh-xrd,接入时约定)
entry_state可选string≤400可选:嵌入初始页参数(如落地上传页)
display_name可选string≥1;≤64可选:贵司平台用户的展示名(姓名/昵称/贵司规定的展示标识)。传入后我方工作台顶栏与报告"分析人"署名显示该名称;不传时显示 external_user_id。后续传入即更新(不产生新账号)。
请求示例(curl)
curl -X post https://api.cleerscience.com/v1/sso/partner-login \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"app_id": "app_8f3ka2m9x0", "app_secret": "(服务端环境变量,不入前端)", "external_user_id": "贵司平台用户唯一标识", "target_project": "dsh-xrd"}'
响应 200
{
  "ticket": "stt_mQWw…(单次短票据)",
  "expires_at": "(60 秒内)",
  "workbench_callback": "https://xrd.cleerscience.com/api/auth/sso/callback?ticket=stt_…(单次短票据,即 iframe src)",
  "mapped_user_id": "usr_…",
  "external_user_id": "partner-user-101"
}

状态码

HTTP说明
200票据与工作台地址
401AppID/AppSecret 无效
403目标项目未开放或机构权益停用