跳到主要内容

小游戏

1、游戏礼包-发送游戏道具接口规范

  • 接口描述: 微信小游戏游戏圈设置礼包后玩家领取礼包后推送游戏提供的接口进行游戏道具发送
  • 接口提供方:由项目(游戏)开发人员提供。
  • 接口注意:如果没有创角返回失败;小游戏领取礼包是没有类似区服信息,如果有多个区服小游戏,发送规则有产品侧决定
  • 方式:POST
  • 输入参数: JSON
  • 请求参数说明:
序号变量名类型长度说明备注
1orderidString20订单号id(唯一),SDK服务端生成的订单号
2accountidString20账号数字id,对应客户端接入支付的[uid]参数
3sendtimeString14发送时间yyyyMMddHHmmss(位数固定,24小时制)
4sourceInt4发送来源
5giftidString30礼包 ID(可在 MP 配置好礼包后,提前获取)
6gifttypeidInt4发货礼包类型:1- 每日签到礼包 2- 周福利礼包 3-运营活动礼包 6-每日登录礼包 7-游戏圈活动礼包
7goodslistJsonArray500发送道具列表
8sandboxstring2是否测试订单,1:测试订单;0:正式
9signstring32加密参数,加密规则:加密字符串MD5 accountid+orderid+sendtime+giftid+source+appkey ,appkey的值跟登录的appkey是同一个
  • goodslist请求参数:
序号变量名类型长度说明备注
1IdString30游戏道具id标识
2NumInt4发送的道具数量
  • 返回参数(Json):
序号变量名类型说明备注
1statusstring接口请求结果ok:成功,fail:失败,repeat:订单号重复 (如游戏返回重复,我们认为成功,其他的错误继续提交)

2、微信小游戏--敏感词验证

2.1、接口地址

  • 生产环境:https://xxxxxxx/api/wxminigame/msgseccheck 域名请联系发行获取(安全模块域名)

2.2、使用场景

  • 前提:微信小游戏用户才能调用接口:
  • 场景:昵称、聊天内容等。
  • 逻辑:微信接口验证后返回。

2.3、接口说明

  • 此接口为使用微信小游戏内容安全合规接口,必接
  • 请求方式 post

2.4、请求方式

  • 方式:POST

  • 接入方式: 直接接入

    请求参数: headers头 Body raw(JSON)

参数类型字段名值类型必填说明
Bodyappidint产品ID
Bodyaccountidlong玩家账号ID
Bodytimespanlong(服务器调用)当前时间戳,秒,前后2小时有效
Bodysignlong(服务器调用)接口加密签名md5("appid=" appid "&accountid=" accountid "×pan=" timespan appkey)
Bodytokenstring(SDK调用)登录返回的票据
Bodymainchannelint(SDK调用) sdk配置的主渠道ID
Bodysecochannelint(SDK调用) sdk配置的次渠道ID
Bodysceneint场景枚举值(1 资料;2 评论;3 论坛;4 社交日志)
Bodycontentstring需检测的文本内容,文本字数的上限为2500字,需使用UTF-8编码
Bodynicknamestring用户昵称,需使用UTF-8编码
Bodytitlestring文本标题,需使用UTF-8编码
Bodysignaturestring个性签名,该参数仅在资料类场景有效(scene=1),需使用UTF-8编码

2.5、接口响应说明

  • 请求示例
{"appid":"1316271529","accountid":"1823506688","mainchannel":"100708","secochannel":"100709","token":"31****36","scene":"1","content":"测试中"}
  • 验证通过响应结果JSON格式

    {
    "resultCode": 10000,
    "datum": {
    "riskLevel": "pass",
    "score": 0,
    "message": "{\"errcode\":0,\"errmsg\":\"ok\",\"detail\":[{\"strategy\":\"keyword\",\"errcode\":0},{\"strategy\":\"content_model\",\"errcode\":0,\"suggest\":\"pass\",\"label\":100,\"prob\":90}],\"trace_id\":\"64770211-60007d60-4fc6c401\",\"result\":{\"suggest\":\"pass\",\"label\":100}}"
    },
    "resultInfo": "",
    "rid": "sickyd.a6dcf928669547e7961c1bb064404466"}
  • 返回说明:
参数类型字段名值类型说明备注
resultresultCodeint响应值10000验证完成,其它失败
resultresultInfostring提示信息
resultridstringresponse identifies(响应唯一标识)
resultdatumT数据泛型
resultdatum -> scoreint风险积分
resultdatum -> riskLevelstring有risky、pass、review三种值pass为通过验证,其它未通过
resultdatum -> messagestring微信接口返回数据

3、微信小游戏--获取access_token

3.1、接口地址

  • 生产环境:https://xxxxxxx/api/wxminigame/getkey 域名请联系发行获取(安全模块域名)

3.2、使用场景

  • 前提:微信小游戏服务器调用接口:
  • 场景:非必要不对接。
  • 调用:access_token 存在有效期,需定期获取或者微信返回过期再重新获取

3.3、接口说明

  • 请求方式 post

3.4、请求方式

  • 方式:POST

  • 接入方式: 直接接入

    请求参数: headers头 Body raw(JSON)

参数类型字段名值类型必填说明
Bodyappidint产品ID
Bodytimespanlong(服务器调用)当前时间戳,秒,前后2小时有效
Bodysignstring(服务器调用)接口加密签名md5("appid=" + appid + "×pan=" + timespan + appkey)

3.5、接口响应说明

  • 请求示例
{"appid":1145329484,"timespan":1697180944,"sign":"78b******4dec1a4d"}
  • 验证通过响应结果JSON格式

    {
    "resultCode": 10000,
    "datum": {
    "expires_in": 1697188318,
    "access_token": "73_dgDK03b9iKRW9RBBoHO7K******Qh4B9bm9ib6Lh1YcjCAvMObqD80HkQqJiNdlaWKJfm6oAEDdxAK8p9aqV0NNXbAFAIIS"
    },
    "resultInfo": "",
    "rid": "siwxmnackey.06ce14c59a824fd994bc64a6a3094240"}
  • 返回说明:
参数类型字段名值类型说明备注
resultresultCodeint响应值10000验证通过,其它失败
resultresultInfostring提示信息
resultridstringresponse identifies(响应唯一标识)
resultdatumT数据泛型
resultdatum -> expires_inlong过期时间
resultdatum -> access_tokenstring凭据期间可能会主动刷新,过期需要重新調用接口

4、获取AES加密key

4.1、接口地址

  • 生产环境:https://xxxxxxx/api/sign/getaeskey 域名请联系发行获取(安全模块域名)

4.2、使用场景

  • 前提:游戏用户数据有被篡改风险:
  • 场景:客户端加密,服务端解密、验证。
  • 调用:客户端、服务端

4.3、接口说明

  • 请求方式 post

4.4、请求方式

  • 方式:POST

  • 接入方式: 直接接入

    请求参数: headers头 Body raw(JSON)

参数类型字段名值类型必填说明
Bodyappidint产品ID
Bodyaccountidlong账号唯一ID
BodytokenstringSDK登录票据

4.5、接口响应说明

  • 请求示例
{"appid":1145329484,"timespan":1697180944,"sign":"78b******4dec1a4d"}
  • 验证通过响应结果JSON格式

    {
    "resultCode": 10000,
    "datum": [
    {
    "encrypt_key": "zbVIrP0C7ApZzbs0MdgpXGXSDhi8ZlVmw6NlAghPmmQ=",
    "iv": "XAnmb/rRjMrR8Wh/3ejKhA==",
    "version": 1,
    "expire_in": 3362,
    "create_time": 1717575218
    }
    ],
    "resultInfo": "sucess",
    "rid": "sisaeskey.9faa709cb61c45cf8eb55f61a67f1f4a"
    }

  • 返回说明:
参数类型字段名值类型说明备注
resultresultCodeint响应值10000验证通过,其它失败
resultresultInfostring提示信息
resultridstringresponse identifies(响应唯一标识)
resultdatumT数据泛型获取用户encryptKey。 会获取用户最近3次的key,每个key的存活时间为3600s
resultdatum -> encrypt_keystring加密key
resultdatum -> ivstring加密iv
resultdatum -> versionintkey的版本号
resultdatum -> expire_inint剩余有效时间
resultdatum -> create_timeint创建key的时间戳