登录相关 API
阅读提示:本文是登录 OpenAPI 的接口字典,适合查询字段和示例。如果你还不清楚端侧如何取得
login_code、phone_code,或服务端如何完成账号绑定,请先阅读 登录接入(服务端)。
login_code 和 phone_code 都是短时、一次性的端侧票据,服务端收到后应立即兑换。手机号密文必须在服务端解密;证书与解密方法参见 关于证书。
获取应用级别鉴权 Token
获取应用级 access_token,供业务服务端以应用身份调用需要应用级鉴权的 OpenAPI。本文中,“获取用户加密手机号”需要该 Token;“通过 login_code 获取用户 OpenID”不需要该 Token。
使用限制
- 获取的
access_token有有效期限制(以响应中expires_in字段返回的秒数为准),过期后需重新获取。 - 不要为每次业务请求重新获取 Token。建议由服务端单一模块统一缓存,并按
expires_in判断有效期;多实例部署时共享缓存或使用刷新锁,避免并发刷新。
接口说明
-
业务场景:适用于服务端应用以自身身份调用豆包应用插件开放平台 API 的场景。登录流程中,获取用户手机号接口需要传入此 token 作为鉴权凭证。
-
前提条件:需要在豆包应用插件开放平台完成应用创建,获取到
app_id和app_secret。 -
注意事项:
app_secret属于敏感信息,请妥善保管,切勿在客户端代码或公开环境中暴露。grant_type参数请填写固定值client_credential。
基本信息
请求头
请求参数
Body
请求示例
cURL:
Go:
Java:
Node.Js:
响应参数
data 字段说明
响应示例
正常示例
异常示例
错误码
通过 login_code 获取用户 OpenID
使用端侧取得的一次性 login_code,换取当前用户在当前应用下的唯一标识 open_id。业务服务端应使用 app_id + open_id 关联自有账号;完整登录和账号绑定流程参见 登录接入(服务端)。
使用限制
login_code为短期有效的一次性授权码,使用后即失效,不可重复使用。- 每个
login_code仅能换取一次open_id。
接口说明
-
业务场景:用户在三方豆包应用插件中触发登录操作,豆包应用插件调用豆包登录组件获取
login_code,随后将其发送至三方服务端。服务端调用本接口将login_code换取用户在该应用下的唯一标识open_id,用于关联三方自有账号体系。 -
前提条件:
- 已在豆包应用插件开放平台完成应用创建,获取到
app_id和app_secret。 - 豆包应用插件客户端已完成用户登录授权流程,获取到有效的
login_code。
- 已在豆包应用插件开放平台完成应用创建,获取到
-
注意事项:
login_code有效期极短,服务端收到后应立即调用本接口,避免 code 过期。open_id是用户在当前应用下的唯一标识,同一用户在不同应用下的open_id不同。- 本接口使用
app_id+app_secret进行鉴权,无需额外传入access_token。
基本信息
请求头
请求参数
Body
请求示例
cURL:
Go:
Java:
Node.Js:
响应参数
data 字段说明
响应示例
正常示例
异常示例
错误码
通过 phone_code 获取用户加密手机号
使用端侧取得的一次性 phone_code 换取用户的加密手机号。调用前,业务服务端需要先获取应用级 access_token,并通过请求头 x-DB-AccessToken 传入;接口返回的是密文,不会直接返回明文手机号。
使用限制
phone_code为一次性授权码,短期有效,使用后即失效,不可重复使用。- 本接口需要传入应用级
access_token(通过「获取应用级别鉴权 Token」接口获取),请确保 token 未过期。 - 接口返回
encrypt_phone_number密文,业务服务端使用与平台登记的开发者证书配套的私钥解密。证书准备、数据方向和解密方法参见 关于证书。
接口说明
-
业务场景:用户在三方豆包应用插件中授权手机号,豆包应用插件调用豆包获取手机号组件获得
phone_code,发送至三方服务端。服务端调用本接口获取用户加密手机号,解密后可用于账号绑定或注册。 -
前提条件:
- 已通过「获取应用级别鉴权 Token」接口获取有效的
access_token。 - 豆包应用插件客户端已完成用户手机号授权流程,获取到有效的
phone_code。
- 已通过「获取应用级别鉴权 Token」接口获取有效的
-
注意事项:
phone_code有效期极短,服务端收到后应立即调用本接口,避免 code 过期。- 解密必须在业务服务端完成,禁止将开发者私钥或解密后的明文手机号下发到应用插件。
- 手机号属于用户敏感信息,解密后请遵守相关隐私法规妥善处理。
基本信息
请求头
请求参数
Body
请求示例
cURL:
Go:
Java:
Node.Js: