BootsShu / open-pdd-net-sdk

拼多多开放平台DotNet SDK

说明文档

open-pdd-net-sdk，拼多多开放平台 DotNet SDK。

特别说明

• 遇到任何问题可通过底部联系方式反馈，作者会第一时间进行处理！
• 2.2.0 版本开始，将提供多商户支持，同时将目标框架统一调整到.net5.0。
• 2.3.0 提供消息服务支持，核心类库不再支持 .net framework.

更新说明

更新文档已经迁移到CHANGELOG.md。

类库说明

核心类库 MSDev.PddOpenSdk 支持基于 .Net Standardv2.0 的项目，支持 .NetFramework 4.5.2+，C#8.0。 控制台、客户端等类型项目可使用。

ASP.NET Core 项目请使用 Nuget 包 MSDev.PddOpenSdk.AspNetCore，可直接通过注入服务的方式使用。

Console项目

该项目是通过官方接口获取并自动生成所有请求模型类、返回模型类以及请求服务类，生成后部分类名会有重名,更改成不同的类名即可。

执行方法，打开Console目录，然后执行dotnet run命令即可。

执行成功后，可使用Visual Studio自带的代码清理，对所有文件进行代码格式化操作。

使用说明

PddOpenSdk 核心类库使用

适用于客户端、控制台等程序，Web应用请使用Nuget包 MSDev.PddOpenSdk.AspNetCore。

支持 .Net Framework4.5.2 及Net Standard 2.0 ，安装 Nuget 包 MSDev.PddOpenSdk。

使用示例:

2.2.0及以后版本

var service = new PddService(new PddOptions
{
    ClientId = "",
    ClientSecret = "",
    CallbackUrl = ""，
});
// 获取token
await service.GetAccessTokenAsync(code: "");
// 接口请求
var result = await service.DdkApi.GetDdkGoodsRecommendAsync(
    new GetDdkGoodsRecommendRequestModel
    {
        CatId = 20100
    });

2.1.0及以前版本：

• 基本请求及错误信息

class Program
{
    static async Task Main(string[] args)
    {
        // 设置ClientId与ClientSecret
        PddCommonApi.ClientId = "ID";
        PddCommonApi.ClientSecret = "Secret";
        // 先使用code换取token
        string code = "";
        var authApi = new AuthApi();
        await authApi.GetAccessTokenAsync(code);
    
        // 构造请求内容
        var model = new GenDdkWeappQrcodeUrlRequestModel
        {
            PId = "123133",
            GoodsIdList = new System.Collections.Generic.List<long> { 1122, 331323 }
        };
        var api = new DdkApi();
        var result = await api.GenDdkWeappQrcodeUrlAsync(model);

        // 获取Pdd官方返回的错误信息
        var errorResponse = _pdd.DdkApi.ErrorResponse.Value;
        Console.WriteLine(errorResponse.Error_msg);

    }
}

• 图片上传示例

    var filePath = Path.Combine("images", "logo.png");
    byte[] bytes = System.IO.File.ReadAllBytes(filePath);

    // 构造图片上传内容
    string base64 = "data:image/png;base64," + Convert.ToBase64String(bytes);
    var model = new UploadGoodsImageRequestModel
    {
        Image = base64
    };
    var result = await _pdd.GoodsApi.UploadGoodsImageAsync(model)

ASP.NET Core 项目使用

先安装Nuget 包 MSDev.PddOpenSdk.AspNetCore。

最新示例代码。

• 在 Startup.cs 中注入服务

services.Configure<PddOptions>(Configuration.GetSection("Pdd"));
services.AddPdd();

• appsettings.json 配置项参考:

"Pdd": {
    "ClientId": "",
    "ClientSecret": "",
    "RedirectUri": "",
    // 心跳间隔
    "HeartBeatSeconds": 5
}

• 然后在控制器使用注入服务

readonly PddService _pdd;
public YourController(PddService pdd)
{
    _pdd = pdd;
}

2.2.0及以后版本

/// <summary>
/// 测试获取token
/// </summary>
/// <param name="code"></param>
/// <returns></returns>
public async Task<IActionResult> Callback(string code)
{
    var token = await _pdd.GetAccessTokenAsync(code);
    return Content(token.AccessToken);
}

/// <summary>
/// 多租户测试
/// </summary>
/// <returns></returns>
public async Task<ActionResult> MultiTenantAsync()
{
    var service = new PddService(new PddOptions
    {
        ClientId = "",
        ClientSecret = "",
        CallbackUrl = "",
        // 也可直接将token
        // AccessToken=""

    });
    // 如果没有token，可通过该方法获取token
    await service.GetAccessTokenAsync(code: "");
    var result = await service.DdkApi.GetDdkGoodsRecommendAsync(
        new GetDdkGoodsRecommendRequestModel
        {
            CatId = 20100
        });
    return Json(result);
}

使用socket消息订阅服务

• 在StartUp.cs添加PddOption选项。

      // 获取选项
      services.Configure<PddOptions>(Configuration.GetSection("Pdd"));

• 创建一个XXXHostService类，继承PddSocketHostServiceBase。
• 重写XXXHostService的OnMessage方法，以进行消息的自定义处理。
• 在Program.cs中添加启用服务的代码，如：

  public static IHostBuilder CreateHostBuilder(string[] args) =>
      Host.CreateDefaultBuilder(args)
          .ConfigureWebHostDefaults(webBuilder =>
          {
              webBuilder.UseStartup<Startup>();
          }).ConfigureServices(services =>
          {
              services.AddHostedService<XXXHostService>();
          });

XXXHostService 类可参考Sample项目。

• 心跳检测间隔可在appsetting.json配置中进行配置，可参考Sample项目中的配置。 此外可在自定义的XXXHostService类中的构造方法中设置HeartBeartSeconds值，会覆盖配置中的值。

2.1.0及以前版本

• 获取 AccessToken

/// <summary>
/// 测试获取token
/// </summary>
/// <param name="code"></param>
/// <returns></returns>
public async Task<IActionResult> Callback(string code)
{
    var token = await _pdd.AuthApi.GetAccessTokenAsync(code);
    // 自行维护Token过期时间
    return Content(token.AccessToken);
}

• 调用其他接口

  获取 AccessToken 之后才能正常调用其他接口。

public async Task<ActionResult> Test()
{
    // 构造请求模型
    var requestModel = new SearchDdkGoodsRequestModel
    {
        SortType = 0,
        WithCoupon = false
    };
    // 调用相应接口方法
    var result = await _pdd.DdkApi.SearchDdkGoodsAsync(requestModel);
    return Content(JsonConvert.SerializeObject(result));
}

所有方法名与官方文档保持一致，并有中文注释提醒，只是更改了命名规范，非常容易查找使用。

已知问题

问题反馈

欢迎通过以下方式反馈问题:

• 提交 GitHub Issues
• Email： [e-mail]（优先处理）
• QQ 群：737822525