后台接口

接口调试

您可以使用空间应用提供的API联调工具进行接口调试。

注意

  • 正式环境以及测试环境的域名均为api.urlshare.cn。

公共逻辑

格式

json

HTTP/HTTPS请求方式

GET, POST

请求域名

  1. api.urlshare.cn
  2. api-sandbox.urlshare.cn
  3. openapi.tencentyun.com

注意： （2018/04/10更新）

  1. api.urlshare.cn 与原开平openapi域名 openapi.tencentyun.com 完全一致，建议使用新域名.
  2. 新增沙箱域名 api-sandbox.urlshare.cn 可使用此域名切换沙箱环境（接口支持沙箱模式），接口不支持进正式环境。
  3. 如有接口需要支持沙箱模式，请联系空间小游戏管理员。

输入参数说明

各个参数请进行URL 编码，编码时请遵守 RFC 1738

公共参数

参数名称 是否必须 类型 描述
appid 是 string 应用的唯一ID
openid 是 string 用户ID, 获取方法参考登录态注入全局变量与接口
openkey 是 string 登录态，openkey过期时间为两小时
pf 是 string 应用的来源平台，如：wanba_ts、weixin
format 是 string 定义API返回的数据格式，json
sig 是 string 请求串的签名， 计算方法参考小游戏签名说明文档

通用返回码

常见错误码，更多错误码参见公共返回码说明。

错误码 描述
-1 请求参数无效
-2 请求中的appid不存在
-3 无API访问权限。
-5 签名参数sig校验失败。
-7 要求必须为https协议的地方，使用了http协议。
1001 服务器繁忙，通常是后台出错
1002 用户没有登录态或openkey过期
1004 账户余额不足

接口列表

分类 接口 描述
基础信息 /v3/user/get_info 获取登录用户的信息，包括昵称、头像、性别等信息
/v3/user/is_login 验证登录态
/v3/user/get_unionid 获取当前登录用户的unionid
/v3/user/get_vip_level 获取小游戏VIP特权信息
/v3/user/gift_exchange 积分兑换礼包
玩吧平台 /v3/gamebar/report_battle_result 对战类游戏上报游戏结果
/v3/gamebar/report_user_achievement 用户游戏成就上报
实名注册 /v3/idcard/get_info 获取当前登录用户实名注册信息
/v3/idcard/set_info 设置当前登录用户实名注册信息
关系链 /v3/relation/get_app_friends 获取已安装了应用的好友列表
/v3/user/get_multi_info 批量获取多个用户的基本信息，包括昵称、头像等
支付 /v3/user/get_playzone_userinfo 查询用户积分(余额)及其它支付相关信息
/v3/user/buy_playzone_item 使用积分(余额)兑换指定游戏的道具
/v3/pay/query_record 查询支付记录
消息 /v3/user/send_gamebar_msg 玩吧游戏内调用消息接口向好友发送消息
排行榜 /v3/user/set_achievement 上传用户在应用中的等级相关信息，从而将用户的等级相关信息进行存储
/v3/user/get_gamebar_ranklist 玩吧游戏拉取游戏的排行榜列表
道具索要 /v3/user/confirm_prop_ask 玩吧游戏内赠送道具发货完毕之后通知玩吧后台
认证空间 /v3/user/is_video_brand 判断是否是视频空间认证帐号
校园空间 /v3/user/is_school_brand 判断是否是校园空间认证帐号
/v3/user/is_school_follow 判断是否关注了校园空间
/v3/user/school_app 校园应用添加、删除、查询
/v3/user/get_school_info 获取校园空间相关信息
/v3/campus/concern_school 关注校园空间
/v3/campus/get_school_id_by_name 获取学校对应的校园空间
/v3/campus/get_school_run_step 获取用户跑步数据
/v3/campus/set_user_school 设置用户归属学校
/v3/campus/user_belong_school_list 拉取用户所属学校
/v3/campus/school_run_report 校园跑数据上报
/v3/campus/batch_get_run_step 批量拉取qq运动数据
/v3/campus/check_leda_auth_state 查询校园乐答认证状态
/v3/campus/run_add_score 校园跑回退用户积分
/v3/campus/run_query_score 拉取用户校园跑活动中的积分
/v3/campus/run_sub_score 校园跑扣减用户积分
/v3/campus/run_get_rank_list 拉取用户校园跑活动中的学校里程榜
背景商城 /v3/cover/get_nba_vip 拉取当前登录用户是否nba会员
/v3/cover/judge_cover_type 判断用户使用cover情况
空间宠物 /v3/pet/get_mall_category_list 拉取宠物商城分类列表
/v3/pet/get_my_pets 拉取用户“我的”宠物数据
/v3/pet/express 宠物糖果发放接口
/v3/pet/get_user_rank 拉取宠物游戏好友排行榜
/v3/pet/get_love_score 获取宠物好友缘分值接口
/v3/pet/add_love_score 增加宠物好友缘分值接口
/v3/pet/marry 宠物结婚
/v3/pet/divorce 宠物离婚
/v3/pet/get_mate 拉取用户宠物的结婚对象
/v3/pet/consume 宠物消耗（扣减）财富或物品
/v3/pet/query_property 宠物查询拥有的财富或物品余量
/v3/pet/get_mall_item 查询宠物商城物品信息
/v3/pet/set_love_score 批量设置好友缘份值绝对值
/v3/pet/set_pair_love_score 设置用户与某一好友相互间缘份值绝对值
认证空间 /v3/fun/vendor_push_resource 外部电商平台推送资源位数据到空间商城好物页
人脸融合 /v3/picture/face_merge 获取，上传的人脸头像和素材模板人脸头像融合之后的新图片
空间送礼接口 /v3/gift/send_gift 空间送礼接口
交叉任务 /v3/task/query 查询用户任务
/v3/task/report 上报任务
/v3/task/recive 领取任务
红包活动 /v3/redpacket/taskreport 红包活动任务完成上报
营销活动 /v3/gift/send_game_props 向玩家在腾讯游戏上的游戏角色赠送游戏道具
敏感词查询 /v3/user/forbidden_word 敏感词查询