## 目錄
[TOC]
## 前言
>[info] 此處僅列出部分主要API,詳細API請參考javadoc
[點擊進入Javadoc](http://q1lzbuhju.bkt.clouddn.com/javadoc/index.html)
為了實現廣大用戶的需求,現開放API接入功能,依賴McPay核心插件,僅需幾行代碼,快捷接入!
你可以利用McPay API做這些事情 :
1. 獲取商品列表
2. 獲取商品信息
3. 創建訂單并獲取訂單信息
4. 監聽玩家支付結果
5. 獲取玩家訂單列表
6. 獲取統計信息
馬上開發適合自己的McPay附屬吧~
隨著版本更新API方法可能會有所改變
因所有的API方法均將產生實時網絡請求,請盡量使用異步邏輯包裹
## 獲取商品列表
|方法名|返回|
| --- | --- |
| com.mkuaiyun.mcpay.api.McPay.getCommodities(boolean includeHide) | List<ICommodity> |
|參數名|參數說明|
| --- | --- |
| includeHide | 是否要包含服主設置為隱藏的商品 |
## 獲取商品信息
|方法名|返回|
| --- | --- |
| com.mkuaiyun.mcpay.api.McPay.getCommodity(int id) |ICommodity |
|參數名|參數說明|
| --- | --- |
| id | 商品ID |
## 創建訂單并獲取訂單信息
|方法名|返回|
| --- | --- |
| com.mkuaiyun.mcpay.api.McPay.createTrade(String source, PaymentType payment, int commodityId, Player player) | Future<ITradeRequestInfo> |
|參數名|參數說明|
| --- | --- |
| source | 訂單來源(一般傳入自己的插件名即可) |
| payment | 付款方式 |
| commodityId | 商品ID |
| player | 購買該訂單的玩家 |
## 支付完成事件
|事件名|事件說明|
| --- | --- |
| com.mkuaiyun.mcpay.api.event.PaymentEvent | 你可以通過該事件監聽玩家何時支付完成,從而執行一些操作,例如關閉您創建的掃碼頁面、通知玩家支付成功等。該事件僅支付成功觸發。 |
## 獲取玩家訂單列表
|方法名|返回|
| --- | --- |
|com.mkuaiyun.mcpay.api.McPay.getTradeInfoList(String playerName) | List<ITradeInfo> |
|參數名|參數說明|
| --- | --- |
| playerName | 玩家名 |
## 獲取玩家統計信息
|方法名|返回|
| --- | --- |
| com.mkuaiyun.mcpay.api.McPay.getPlayerStatistics(String playerName) | IStatistics |
|參數名|參數說明|
| --- | --- |
| playerName | 玩家名 |
## 獲取商品統計信息
|方法名|返回|
| --- | --- |
| com.mkuaiyun.mcpay.api.McPay.getCommodityStatistics(int commodityId) | IStatistics |
|參數名|參數說明|
| --- | --- |
| commodityId | 商品ID |
## 獲取商戶全部統計信息
|方法名|返回|
| --- | --- |
| com.mkuaiyun.mcpay.api.McPay.getAllStatistics() | IStatistics |