一、环境配置

1. PC端文档说明

   PC端接入游戏,只需要接入对应接口即可

2. 请求域名:

   https://sdk.gxlyyx.cn    

3. 配置文件

   游戏的运行目录需要新增配置文件, 文件名必须为:bstconfig.ini
          

   [游戏名称]
   domain=https://sdk.gxlyyx.cn
   alliance=0
   promotion_id=0
   promotion_type=

4. 调试工具

   下载PC端接口调试工具.zip

二、初始化SDK

1. 接口说明

   游戏初始化完成后,需要初始化SDK

2. 请求URL

   /controller/init.ashx?action=get_init_par_win

3. 请求方式

   HTTP POST  application/x-www-form-urlencoded (POST Form表单形式)        

4. 请求参数

   参数如下

   字段	必填	类型	示例值	描述
   app_id	是	String(16)	1650e68cf57045c1	我方游戏的app_id
   alliance	是	String(16)	0	INI配置文件的alliance值

5. 返回参数(JSON格式)

   返回参数如下

   参数	必填	类型	示例值	说明
   status	是	int	1	0:失败;1:成功
   msg	否	string	初始化成功	初始化结果描述
   paymethods	是	Array	["mihua:alipay","mihua:alipay_scan"]	支付方式列表

6. 返回示例数据

   成功返回:        

   {"status":1,"msg":"初始化成功","paymethods":["mihua:alipay","mihua:alipay_scan"]}

          

          

          

   失败返回:        

   {"status":0, "msg":"游戏不存在或app_id错误"}

          

          

      

三、登录游戏

1. 接口说明

   用户登录并获取小号列表及实名信息

2. 请求URL

   /controller/login.ashx?action=username_login

3. 请求方式

   HTTP POST  application/x-www-form-urlencoded (POST Form表单形式)        

4. 请求参数

   参数如下

   字段	必填	类型	示例值	描述
   app_id	是	String(16)	1650e68cf57045c1	我方游戏的app_id
   timestamp	是	long	1710000000	时间戳(秒)
   username	是	string	test001	用户名
   password	是	string	123456	密码
   ip	是	string	192.168.0.1	ip地址
   fid	否	string	ABCDEF123456	设备序列号
   devicename	否	string	PC-WIN10	设备名称
   plat	是	string	win	固定值

5. 返回参数(JSON格式)

   返回参数如下

   参数	必填	类型	示例值	说明
   status	是	int	1	0:失败;1:成功
   msg	否	string	登录成功	请求结果描述
   users_small	是	Array	[]	小号列表(users_small对象属性见下方表格)
   isauthentication	否	int	1	0:未实名认证;1:已实名认证
   age	否	int	20	年龄
   show_forcemobile	否	int	0	0:不显示绑定手机;1:显示绑定手机
   show_forcemobile_close	否	int	1	0:不允许跳过绑定手机;1:允许跳过绑定手机

6. users_small对象

   字段	必填	类型	示例值	描述
   uid	是	string	10001	小号uid
   small_title	是	string	小号1	小号显示名称

7. 返回示例数据

   成功返回:        

   {"status":1,"msg":"登录成功","isauthentication":1,"age":20,"show_forcemobile":0,"show_forcemobile_close":1,"users_small":[{"uid":"10001","small_title":"小号1"}]}

          

          

          

   失败返回:        

   {"status":0,"msg":"用户名或密码错误"}

          

          

      

8. 注意事项

   注意:登录成功后,
   需要判断返回值isauthentication  是否实名认证了
   如果这个值是0   则显示实名认证框, 让他进行实名认证
   如果是1 则判断age (年龄),如果年龄小于18,则禁止进入游戏
   如果是1且年龄大于18, 则显示小号列表 , 让用户进游戏
          

四、进入游戏

1. 服务端验签

   进入游戏之前,需要调用服务端登录验证(参考服务端文档,点击顶部"服务端文档进行查看")

2. 进入游戏

   说明:如果小号列表数量大于1,则显示小号列表(需要研发画一个小号弹框), 点击小号,携带小号uid进入游戏;

   如果数量为1,则可以使用小号的uid直接进入游戏

      2.在进入游戏之前,需要调用服务端登录验证(参考服务端文档,点击顶部"服务端文档进行查看")

五、手机注册

1. 接口说明

   使用手机号注册账号

2. 请求URL

   /controller/register.ashx?action=reg_mobile

3. 请求方式

   HTTP POST  application/x-www-form-urlencoded (POST Form表单形式)        

4. 请求参数

   参数如下

   参数	必填	类型	示例值	描述
   app_id	是	String(16)	1650e68cf57045c1	我方游戏的app_id
   promotion_id	是	string	0	INI配置文件的promotion_id
   promotion_type	是	string	0	INI配置文件的promotion_type
   plat	是	string	win	固定值
   timestamp	是	long	1710000000	时间戳(秒)
   ip	是	string	127.0.0.1	客户端IP
   mobile	是	string	13800138000	手机号码
   code	是	string	123456	短信验证码(请先调用发送验证码接口)
   password	是	string	123456	密码
   fid	否	string	ABCDEF123456	设备序列号
   devicename	否	string	PC-WIN10	设备名称

5. 返回参数(JSON格式)

   返回参数如下

   参数	必填	类型	示例值	说明
   status	是	int	1	0:失败;1:成功
   msg	否	string	注册成功	请求结果描述

6. 返回示例数据

   成功返回:        

   {"status":1,"msg":"注册成功"}

          

          

          

   失败返回:        

   {"status":0,"msg":"验证码错误或已过期"}

          

          

      

六、发送验证码

1. 接口说明

   手机注册发送验证码

2. 请求URL

   /controller/register.ashx?action=send_sms_code

3. 请求方式

   HTTP POST  application/x-www-form-urlencoded (POST Form表单形式)        

4. 请求参数

   参数如下

   参数	必填	类型	示例值	描述
   app_id	是	String(16)	1650e68cf57045c1	我方游戏的app_id
   timestamp	是	long	1710000000	时间戳(秒)
   ip	是	string	127.0.0.1	客户端IP
   mobile	是	string	13800138000	手机号码

5. 返回参数(JSON格式)

   返回参数如下

   参数	必填	类型	示例值	说明
   status	是	int	1	0:失败;1:成功
   msg	否	string	发送成功	请求结果描述

6. 返回示例数据

   成功返回:        

   {"status":1,"msg":"发送成功"}

          

          

          

   失败返回:        

   {"status":0,"msg":"手机号格式错误或发送频繁"}

          

          

      

七、用户名注册

1. 接口说明

   使用用户名注册账号

2. 请求URL

   /controller/register.ashx?action=reg_user_name

3. 请求方式

   HTTP POST  application/x-www-form-urlencoded (POST Form表单形式)        

4. 请求参数

   参数如下

   参数	必填	类型	示例值	描述
   app_id	是	String(16)	1650e68cf57045c1	我方游戏的app_id
   promotion_id	是	string	0	sdk.promotion_id
   promotion_type	是	string	0	sdk.promotion_type
   plat	是	string	win	固定值
   timestamp	是	long	1710000000	时间戳(秒)
   ip	是	string	127.0.0.1	客户端IP
   username	是	string	test001	用户名
   password_new_1	是	string	123456	新密码
   password_new_2	是	string	123456	确认新密码
   fid	否	string	ABCDEF123456	设备序列号
   devicename	否	string	PC-WIN10	设备名称

5. 返回参数(JSON格式)

   返回参数如下

   参数	必填	类型	示例值	说明
   status	是	int	1	0:失败;1:成功
   msg	否	string	注册成功	请求结果描述

6. 返回示例数据

   成功返回:        

   {"status":1,"msg":"注册成功"}

          

          

          

   失败返回:        

   {"status":0,"msg":"用户名已存在"}

          

          

      

八、实名认证

1. 接口说明

   提交实名认证信息

2. 请求URL

   /controller/register.ashx?action=authentication

3. 请求方式

   HTTP POST  application/x-www-form-urlencoded (POST Form表单形式)        

4. 请求参数

   参数如下

   参数	必填	类型	示例值	描述
   app_id	是	String(16)	1650e68cf57045c1	我方游戏的app_id
   idcard_realname	是	string	张三	身份证姓名
   idcard_no	是	string	110101199001011234	身份证号
   username	是	string	test001	用户名
   password	是	string	123456	密码

5. 返回参数(JSON格式)

   返回参数如下

   参数	必填	类型	示例值	说明
   status	是	int	1	0:失败;1:成功
   msg	否	string	认证成功	请求结果描述

6. 返回示例数据

   成功返回:        

   {"status":1,"msg":"认证成功"}

          

          

          

   失败返回:        

   {"status":0,"msg":"身份证信息不匹配"}

          

          

      

九、角色上报

1. 接口说明

   上报游戏角色信息(登录/注册/升级/退出等事件)

2. 请求URL

   /controller/gamerole.ashx?action=uploadgameroleinfo

3. 请求方式

   HTTP POST  application/x-www-form-urlencoded (POST Form表单形式)        

4. 请求参数

   参数如下

   参数	必填	类型	示例值	描述
   appid	是	String(16)	1650e68cf57045c1,注意:请求参数appid中间没有_	我方游戏的app_id
   uid	是	string	10001	小号uid
   orleplat	是	string	win	固定值
   gamerole	是	string	{"serverid":"1","servername":"1区","roleid":"10000","rolename":"角色名称",....}	角色对象JSON字符串

5. gamerole对象

   JSON字符串内容)

   字段	必填	类型	示例值	描述
   serverid	是	string	1	区服ID
   servername	是	string	1区	区服名称
   roleid	是	string	10000	角色ID
   rolename	是	string	H5角色名称	角色名称
   rolelevel	是	int	58	角色等级
   rolebalance	否	string	1000	角色游戏内货币余额
   partyid	否	string	dxdy	帮派ID
   partyname	否	string	dxdy	帮派名称
   rolepower	否	string	100000	角色战力
   viplevel	否	string	VIP8	VIP等级
   rolegender	否	string	男	角色性别
   partyrolename	否	string	天下第一帮	角色在帮派名称
   professionid	否	string	1	角色职业Id
   profession	否	string	法师	角色职业名称
   friendlist	否	Array	[]	角色好友列表
   eventname	是	string	升级	事件类型: 登录/注册/升级/退出

6. 请求示例数据

   {"app_id":"1650e68cf57045c1","uid":"10001","orleplat":"win","gamerole":"{\"serverid\":\"1\",\"servername\":\"1区\",\"roleid\":\"10000\",\"rolename\":\"H5角色名称\",\"rolelevel\":58,\"rolebalance\":\"1000\",\"partyid\":\"dxdy\",\"partyname\":\"dxdy\",\"rolepower\":\"100000\",\"viplevel\":\"VIP8\",\"rolegender\":\"男\",\"partyrolename\":\"天下第一帮\",\"professionid\":\"1\",\"profession\":\"法师\",\"friendlist\":[],\"eventname\":\"升级\"}"}

          

          

      

7. 返回参数(JSON格式)

   返回参数如下

   参数	必填	类型	示例值	说明
   status	是	int	1	0:失败;1:成功
   msg	否	string	上报成功	请求结果描述

8. 返回示例数据

   成功返回:        

   {"status":1,"msg":"上报成功"}

          

          

          

   失败返回:        

   {"status":0,"msg":"参数错误"}

          

          

      

十、充值

1. 接口说明

   创建本地订单并发起支付

2. 请求URL

   /controller/gameorder.ashx?action=create_local_order

3. 请求方式

   HTTP POST  application/x-www-form-urlencoded (POST Form表单形式)        

4. 请求参数

   参数如下

   参数	必填	类型	示例值	描述
   paymethod	是	string	mihua:alipay_scan	支付方式(取初始化接口paymethods返回值)
   uid	是	string	10001	小号uid
   appid	是	String(16)	1650e68cf57045c1注意:请求参数appid中间没有_	我方游戏的app_id
   plat	是	string	win	固定值
   timestamp	是	long	1710000000	时间戳(秒)
   gamerole	是	string	{\"serverid\":\"1\",\"servername\":\"1区\",\"roleid\":\"10000\"}	角色对象JSON字符串(见角色上报)
   orderinfo	是	string	{\"cpOrderID\":\"test1710000000\",\"amount\":\"1\",\"count\":\"10\",\"goodsID\":\"1001\",\"goodsName\":\"点券\"}	订单对象JSON字符串(对象字段见下方表格)
   coupon_id	否	string	0	折扣券ID(预留,传0即可)
   sign	是	string	2b4c3d...	签名

   orderinfo对象(JSON字符串内容)
          

   字段	必填	类型	示例值	描述
   cpOrderID	是	string	test1710000000	cp的订单编号
   amount	是	string	1	订单金额
   count	是	string	10	购买的游戏币数量
   goodsID	是	string	1001	游戏方商品Id
   goodsName	是	string	点券	商品名称
   goodsdesc	否	string	月卡	商品描述
   extrasParams	否	string		透传参数(不参与签名)

5. 签名说明

   string signstr = "amount={amount}&app_id={app_id}&cporder={cporder}&timestamp={timestamp}&uid={uid}" + "{pay_key}";

          

          

          

   这里使用pay_key进行签名; 金额amount单位为分,需要把元金额乘以100

   说明: app_id对应请求参数appid, cporder对应orderinfo中的cpOrderID

6. 返回参数(JSON格式)

   返回参数如下

   参数	必填	类型	示例值	说明
   status	是	int	1	0:失败;1:成功
   order_id	是	string	20260312123456	订单号
   url	是	string	https://pay.example.com/xxx	支付链接
   order_amount	是	string	1.00	订单金额
   pay_amount	是	string	1.00	应付金额

7. 返回示例数据

   成功返回:        

   {"status":1,"order_id":"20260312123456","url":"https://pay.example.com/xxx","order_amount":"1.00","pay_amount":"1.00"}

          

          

          

   失败返回:        

   {"status":0,"msg":"签名错误"}