code2session

更新时间 2024-07-24 02:58:49

我的收藏

接口介绍

该接口用于第三方小程序应用为授权小程序获取用户的 session_key 和 openid。

注意：

•

需要先通过 tt.login 接口获取用户的临时登录凭证 code 或者匿名登录凭证 anonymous_code。

•

登录凭证 code，anonymous_code 只能使用一次。

•

关于该接口作用以及使用的更多说明，可以参考原文档 code2session。二者逻辑一致，只是前者针对普通小程序，后者是提供给服务商使用。

请求

基本信息

基本
HTTP URL	https://open.microapp.bytedance.com/openapi/v1/microapp/code2session
HTTP Method	GET

查询参数

参数名	参数类型	是否必须	备注
component_appid	string	是	第三方小程序应用 appid
authorizer_access_token	string	是	授权小程序接口调用凭据
code	string	否	code 和 anonymous_code 至少要有一个
anonymous_code	string	否	code 和 anonymous_code 至少要有一个

响应

响应体

参数名	参数类型	备注
errno	int	错误码
message	string	错误信息
data	object

data 说明：

参数名	参数类型	备注
session_key	string	会话密钥，如果请求时有 code 参数才会返回
openid	string	用户在当前小程序的 ID，如果请求时有 code 参数才会返回
anonymous_openid	string	匿名用户在当前小程序的 ID，如果请求时有 anonymous_code 参数才会返回
unionid	string	用户在小程序平台的唯一标识符，如果请求时有 code 参数才会返回。如果开发者拥有多个小程序，可通过 unionid 来区分用户的唯一性。

响应体示例

json复制
{
  "errno": 0,
  "message": "success",
  "data": {
    "session_key": "h0rt4/77I09nDuSWeGwKKw==",
    "openid": "8PB.cW.TabxdbJFs",
    "anonymous_openid": "",
    "unionid": "ab085c8d-6911-4sca-ba17-257vh646cba8"
  }
}

错误码

错误码	message	排查建议
40001	参数错误
40003	找不到相关第三方小程序应用
40004	找不到相关授权小程序
40020	第三方小程序应用 authorizer_access_token 不正确或者已过期
40043	code 错误	参考常见问题文档 code2session 相关
40044	anonymous_code 错误	参考常见问题文档 code2session 相关