>[danger] 注意：旧版本API已经弃用，随时可能被删除，此页面仅做归档，请不要使用旧版本API ## 目录 [TOC] ## 前言 >[danger] 注意：旧版本API已经弃用，随时可能被删除，此页面仅做归档，请不要使用旧版本API 为了实现广大用户的需求，现开放API接入功能，依赖McPay核心插件，仅需几行代码，快捷接入！ 你可以利用McPay API做这些事情 ： 1. 获取商品列表 2. 创建订单并获取二维码 3. 监听玩家支付结果 5. 获取玩家订单列表 6. 获取玩家统计信息 马上开发适合自己的McPay附属吧~ 随着版本更新API方法可能会有所改变 因所有的API方法均将产生实时网络请求，请尽量使用异步逻辑包裹 ## 获取商品列表 |方法名|返回| | --- | --- | |org.miaokuaiyunplugin.mcpay.Api.getCommodity(int 获取页数,int 每页获取商品数) | org.miaokuaiyunplugin.mcpay.util.json.Commodity| **org.miaokuaiyunplugin.mcpay.util.json.Commodity** * getResult() int 获取结果 1为成功 0为失败 * getMsg() String 获取结果状态消息 若获取结果为0，以下方法返回null！ * getTotalAmount() int 商品总数量 * getMaxPage() int 最大页数 * getCommdity() List<org.miaokuaiyunplugin.mcpay.util.json.Commodity.Commodity2> 获取到的商品 **org.miaokuaiyunplugin.mcpay.util.json.Commodity.Commodity2** * getId() String 商品id * getName() String 商品名称 * getPrice() String 商品价格 * getIntroduce() String 商品介绍 ## 创建订单并获取二维码 |方法名|返回| | --- | --- | | org.miaokuaiyunplugin.mcpay.Api.Buy(String 操作插件,String 支付方式,String 商品id,String 购买玩家名称) | Map<String, String> | **参数说明** * @param 操作插件 此参数是仅作为监听玩家支付事情而设置的插件标识，如果你不需要后续的监听，请设置为null或"McPay"。 * @param 支付方式 ALIPAY=支付宝 WEIXINPAY=微信 QQPAY=QQ * @param 商品id 略 * @param 购买玩家名称 略 **Map<String, String>** * @key result 订单创建结果 1为成功 0为失败 * @key msg 订单状态消息 * 若获取结果为0，以下key为null！ * @key order_on 订单号 * @key qr_code 二维码地址，无需生成二维码，地址即二维码图片 ## 支付完成事件 **org.miaokuaiyunplugin.mcpay.event.PaymentEvent** **事件说明** 你可以通过该事件监听玩家何时支付完成，从而执行一些操作，例如关闭您创建的扫码页面、通知玩家支付成功等 该事件仅支付成功触发。 **方法说明** * getPlugin() String 操作插件 * getOrderOn() String 订单号 * getPlayerName() String 购买玩家名称 * getCommodityName() String 商品名称 * getPrice() String 支付金额 ## 获取玩家订单列表 |方法名|返回| | --- | --- | |org.miaokuaiyunplugin.mcpay.Api.getBuyTrade(int 获取页数,int 每页获取商品数,String 玩家名称) | org.miaokuaiyunplugin.mcpay.util.json.BuyTrade| **org.miaokuaiyunplugin.mcpay.util.json.BuyTrade** * getResult() int 获取结果 1为成功 0为失败 * getMsg() String 获取结果状态消息 若获取结果为0，以下方法返回null！ * getTotalAmount() int 订单总数量 * getMaxPage() int 最大页数 * getTrade() List<org.miaokuaiyunplugin.mcpay.util.json.BuyTrade.Trade> 获取到的订单 **org.miaokuaiyunplugin.mcpay.util.json.BuyTrade.Trade** * getOrderOn() String 订单号 * getPayment() String 支付方式 * getCommodityName() String 商品名称 * getPrice() String 付款金额 * getStatus() String 交易状态 ## 获取玩家统计信息 |方法名|返回| | --- | --- | |org.miaokuaiyunplugin.mcpay.Api.getStatistics(String 玩家名称,String 商品id) | Map<String,String>| **参数说明** * @param 玩家名称 指定玩家名称，如果你需要获取全部玩家请设该值为null * @param 商品id 指定商品id，如果你需要获取全部商品请设改值为null **Map<String, String>** * @key result 获取结果 1为成功 0为失败 * @key msg 获取状态消息 * 若获取结果为0，以下key为null！ * @key amount 购买次数 * @key money 消费总额