Skip to content

Commit

Permalink
README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pyihe committed Jul 15, 2020
1 parent 1f9a204 commit d0fad3a
Showing 1 changed file with 35 additions and 10 deletions.
45 changes: 35 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
# wechat-sdk
##### 功能列表
| 方法名 | 解释 | 备注 |
### Function List

##### Mini Program(小程序)

| Name | Explain | comment |
| :---- | :----| :----|
| GetUserPhoneForMini | 小程序获取电话号码 | 客户端调用微信接口获取加密信息时不能在回调中再次调用登陆接口, 否则会让session_key失效 |
| GetSessionKeyAndOpenId | 通过小程序授权code获取session_key和用户openid |
| GetAccessTokenForMini | 小程序获取AccessToken | |
| GetUserInfoForMini | 小程序获取用户基本信息 | |

##### Official Accounts(公众号)

| Name | Explain | comment |
| :---- | :----| :----|
| GetAppBaseAccessToken | 公众号开发获取基础接口调用Access_Token | 用于调用其他接口 |
| GetAppOauthAccessToken | 公众号开发通过code获取网页授权Access_Token | 此Access_Token用于拉取用户信息, code只能用一次 |
| RefreshOauthToken | 公众号开发刷新网页授权Access_Token ||
| GetAppUserInfo | 公众号开发拉取用户信息 | 返回结果参考[微信文档](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html) |
| CheckOauthToken | 公众号开发校验网页授权Access_Token是否有效 ||

##### WeChat Pay(微信支付)

| Name | Explain | comment |
| :---- | :----| :----|
| CloseOrder | 关闭订单 | |
| DownloadBill | 下载对账单 | |
| DownloadComment | 拉取订单评论 | |
Expand All @@ -23,15 +41,22 @@
| UnifiedMicro | 扫码下单 | 如果需要传detail参数, 参数格式参照[单品优惠活动detail字段列表说明](https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_102&index=2) |
| UnifiedOrder | 统一下单: H5/APP/MWEB/NATIVE | 返回给前端的唤起支付参数中, package = prepay_id=xxxxxxx |
| UnifiedQuery | 下单结果查询 | |
| GetAppBaseAccessToken | 公众号开发获取基础接口调用Access_Token | 用于调用其他接口 |
| GetAppOauthAccessToken | 公众号开发通过code获取网页授权Access_Token | 此Access_Token用于拉取用户信息, code只能用一次 |
| RefreshOauthToken | 公众号开发刷新网页授权Access_Token ||
| GetAppUserInfo | 公众号开发拉取用户信息 | 返回结果参考[微信文档](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html) |
| CheckOauthToken | 公众号开发校验网页授权Access_Token是否有效 ||

**Notice: 所有请求接口都不需要加入appid/mch_id/key/secret/sign参数**

##### 如何使用:
##### ProfitSharing(商户分账)
| Name | Explain | comment |
| :---- | :----| :----|
|ProfitSharing|申请分账(单次或多次)|multiTag标志是否是多次分账|
|QueryProfitSharing|查询分账请求的结果|非分账的结果,而是分账申请的结果|
|AddProfitSharingReceiver|添加分账接收方||
|RemoveProfitSharingReceiver|删除分账接受方||
|FinishProfitSharing|完结分账|如果订单不需要(再)分账, 且剩余待分账金额不为0时, 调用本接口将剩余金额冻结给特约商户|
|ReturnProfitSharing|分账回退|对已分账的订单进行退款时,先调用本接口将金额从分账接收方回退给商户(非异步, 同步回传回退结果)|
|QueryProfitSharingReturn|回退结果查询|用于核实回退结果|
|ProfitSharingNotify|分账动帐通知|分账或分账回退成功后, 微信会将结果发送给商户, 通知结果包含加密信息, **此处解密密钥为ApiV3密钥**。接口返回结果中忽略层级关系,对于需要的字段直接使用Get方法获取值。通知url在商户平台配置,详情参加[分账动帐通知](https://pay.weixin.qq.com/wiki/doc/api/allocation.php?chapter=27_9&index=9)|

**Notice: NewPayer()必须传入所有需要使用的微信参数, 使用过程中所有请求接口都不需要加入appid/mch_id/ApiKey/secret/sign/ApiV3Key参数**

### Usage Example:
```
package main
Expand Down

0 comments on commit d0fad3a

Please sign in to comment.