docs: 完善文档

This commit is contained in:
Fu Diwei 2021-07-27 00:01:00 +08:00
parent 2062d1d3d9
commit 59787ab7e0
4 changed files with 20 additions and 12 deletions

View File

@ -4,7 +4,7 @@
验证回调通知事件签名的方法与验证响应签名的类似,请参阅[相关文档](./Advanced_ResponseSignatureVerification.md)。
同样的,你既然可以利用本库提供的 `RSAUtility` 工具类自行进行签名验证,也可以通过 `ICertificateStorer` 尝试自动完成签名验证:
同样的,你既然可以利用本库提供的 `RSAUtility` 工具类自行进行签名验证,也可以通过 `ICertificateManager` 尝试自动完成签名验证:
```csharp
bool ret = client.VerifyEventSignature(

View File

@ -328,6 +328,10 @@
- 删除分账接收方:`DeleteProfitSharingReceiver`
- 申请分账账单:`GetProfitSharingBill`
- 下载账单:`DownloadBillFile`
- 风险合规
- 消费者投诉 2.0
@ -794,6 +798,10 @@
- 删除分账接收方:`DeleteProfitSharingReceiver`
- 申请分账账单:`GetProfitSharingBill`
- 下载账单:`DownloadBillFile`
- 连锁品牌分账
- 请求分账:`CreateBrandProfitSharingOrder`

View File

@ -43,27 +43,27 @@ bool ret = RSAUtility.VerifyWithSHA256(publicKey, data, sign);
---
#### 通过 `ICertificateStorer` 接口存取平台证书信息:
#### 通过 `ICertificateManager` 接口存取平台证书信息:
微信商户平台证书需要通过 API 的方式获取、且可能同时存在多个有效证书,本库提供了一个 `ICertificateStorer` 接口可用于存取证书信息。
微信商户平台证书需要通过 API 的方式获取、且可能同时存在多个有效证书,本库提供了一个 `ICertificateManager` 接口可用于存取证书信息。
你可以在构造得到 `WechatApiClient` 对象时指定证书存取器:
你可以在构造得到 `WechatApiClient` 对象时指定证书管理器:
```csharp
var certStorer = new InMemoryCertificateStorer(); // 为便于后续使用,该对象可使用全局单例的方式声明
var options = new WechatTenpayClientOptions() { CertificateStorer = certStorer };
var certManager = new InMemoryCertificateManager(); // 为便于后续使用,该对象可使用全局单例的方式声明
var options = new WechatTenpayClientOptions() { CertificateManager = certManager };
var client = new WechatTenpayClient(options);
```
> 注:`InMemoryCertificateStorer` 是本库内置的基于内存实现的证书存取器;你也可实现 `ICertificateStorer` 接口,例如利用数据库或 Redis 等方式存取证书信息。
> 注:`InMemoryCertificateManager` 是本库内置的基于内存实现的证书管理器;你也可实现 `ICertificateManager` 接口,例如利用数据库或 Redis 等方式存取证书信息。
你应在后台周期性地调用 `QueryCertificatesAsync()` 方法,并在解密得到证书内容后,记录到证书存取器中:
你应在后台周期性地调用 `QueryCertificatesAsync()` 方法,并在解密得到证书内容后,记录到证书管理器中:
```csharp
certStorer.Set("CER 证书序列号", "CER 证书内容");
certManager.Set("CER 证书序列号", "CER 证书内容");
```
每个响应对象会包含一个名为 `WechatpayCertSerialNumber` 的公共字段,本库会根据该字段的值自动尝试在证书存取器中读取证书内容,并完成响应签名的验证:
每个响应对象会包含一个名为 `WechatpayCertSerialNumber` 的公共字段,本库会根据该字段的值自动尝试在证书管理器中读取证书内容,并完成响应签名的验证:
```csharp
bool ret = client.VerifyResponseSignature(response);

View File

@ -77,14 +77,14 @@ using SKIT.FlurlHttpClient.Wechat;
using SKIT.FlurlHttpClient.Wechat.TenpayV3;
using SKIT.FlurlHttpClient.Wechat.TenpayV3.Settings;
var certStorer = new InMemoryCertificateStorer();
var certManager = new InMemoryCertificateManager();
var options = new WechatTenpayClientOptions()
{
MerchantId = "微信商户号",
MerchantV3Secret = "微信商户 v3 API 密钥",
MerchantCertSerialNumber = "微信商户证书序列号",
MerchantCertPrivateKey = "-----BEGIN PRIVATE KEY-----微信商户证书私钥-----END PRIVATE KEY-----",
CertificateStorer = certStorer
CertificateManager = certManager
};
var client = new WechatTenpayClient(options);
```