账号授权
提交二次密码
当渠道在验证码认证后要求二次验证时,提交两步验证密码。
POST
https://api.unifyport.ai/v1/accounts/{account_id}/auth/password调用前准备
在服务端使用资源所属工作区的 X-Api-Key。运行示例前替换所有占位符。
参数从哪里取得
- account_id
- 从创建或查询账号的响应取得 data.id。账号标识属于 X-Api-Key 对应的工作区。 获取账号
请求参数
请求头
X-Api-Keystring必填
工作区 API Key,工作区由该请求头解析得到。
Content-Typestring必填
发送 JSON 请求体时使用 application/json。
路径参数
account_idstring必填
用于该 authentication 路由的标识符。
请求体
passwordstring必填
二次验证密码,请通过安全输入路径传入,切勿落日志。
如何理解结果
按文档解释响应字段和 HTTP 状态。204 成功响应没有响应体,排查时使用 X-Request-Id。下一步操作见相关链接。
响应 200 OK
{
"request_id": "<REQUEST_ID>",
"data": {
"account_id": "acc_example",
"status": "authorized"
}
}
响应体
account_idstring
该响应所对应的渠道账号。
statusstring
当前授权流程状态,例如 pending_auth、awaiting_qr_scan、awaiting_code、pending、passkey_required、passkey_pending、passkey_confirmation、passkey_confirmation_sent、authorized 或 failed。
响应
200200 OK
请求成功,响应体示例如上。
400请求错误
请求体、路径或参数不合法。
401未授权
X-Api-Key 请求头缺失或无效。
409冲突
当前操作与已有的渠道账号或资源冲突。
500服务端错误
服务端遇到了未预期的错误。
502上游网关错误
渠道适配器或上游渠道未能完成该操作。
失败后怎么处理
检查 HTTP 状态和 error.code/numeric_code,保存 request_id 用于排查。按原因修正参数、继续授权或检查运行态。重试发送及其他写操作前先确认上一次结果,避免重复操作。 错误码参考
- invalid_request · 10000 · 400
- 检查必填字段、格式和渠道条件,修正请求后再调用。
- invalid_api_key · 11001 · 401
- 检查 X-Api-Key 是否正确、工作区是否有效。