- 小游戏 OpenAPI SDK 总览
- 服务端API介绍
- 接口调用凭证
- 登录
- 数据缓存
- 二维码
- 其它
- 订阅消息
- 客服消息
- 礼包福袋
- 内容安全
code2Session
更新时间 2024-07-24 02:58:49
收藏
我的收藏接口说明
通过tt.login接口获取到登录凭证后,开发者可以通过服务器发送请求的方式获取 session_key 和 openid。
匿名 openid 数据迁移
Bug & Tip
- Tip:原域名 https://developer.toutiao.com/api/apps/jscode2session 仍然可用,不过为了后续兼容性和可能的迁移,建议开发者更换到新的域名。
- Tip: 为了保障应用的数据安全,只能在开发者服务器使用 AppSecret;开发者服务器不应该把会话密钥下发到小游戏,也不应该对外提供这个密钥。如果小游戏存在泄露 AppSecret 或会话密钥的问题,字节小游戏平台将有可能下架该小游戏,并暂停该小游戏相关服务。
- Tip:登录凭证 code,anonymous_code 只能使用一次,非匿名需要 code,非匿名下的 anonymous_code 用于数据同步;匿名需要 anonymous_code。
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://minigame.zijieapi.com/mgplatform/api/apps/jscode2session |
HTTP Method | GET |
Scope | open.ttgame.mgplatform |
请求头
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
content-type | String | 是 | application/json | 固定值"application/json" |
请求参数
Query
请求示例
curl -X GET \
-H "content-type: application/json" \
https://minigame.zijieapi.com/mgplatform/api/apps/jscode2session?appid=tt**********5&secret=988**************92&code=1********3
响应参数
Body
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
error | Int64 | 是 | 错误号 返回非 0 | |
anonymous_openid | String | 否 | 匿名用户在当前小游戏的 ID,如果请求时有 anonymous_code 参数才会返回 | |
errcode | Int64 | 否 | 详细错误号 | |
errmsg | String | 否 | 错误信息 | |
message | String | 否 | 错误信息(同 errmsg) | |
openid | String | 否 | 用户在当前小游戏的 ID,如果请求时有 code 参数才会返回 | |
session_key | String | 否 | 会话密钥,如果请求时有 code 参数才会返回 | |
unionid | String | 否 | 用户在小游戏平台的唯一标识符,请求时有 code 参数才会返回。如果开发者拥有多个小游戏,可通过 unionid 来区分用户的唯一性。 |
响应示例
正常响应示例
{
"error": 0,
"session_key": "ffaaed37bb05d096***",
"openid": "36d4bd3c8****",
"anonymous_openid": "",
"unionid": "f7510d9ab***********"
}
异常响应示例
{
"errcode": 40018,
"errmsg": "bad code",
"error": 3,
"message": "bad code"
}
错误码
http状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 0 | 请求成功 | |
200 | -1 | 系统错误 | |
200 | 40014 | 未传必要参数,请检查 | |
200 | 40015 | appid 错误 | |
200 | 40017 | secret 错误 | |
200 | 40018 | code 错误 | |
200 | 40019 | acode 错误 |
该文档是否有帮助?
点击纠错