关于调用三方平台接口与推送接口的总结<二>（2020.7.27）

前言：本篇博客是接着上篇总结写的，想了解怎么对接第三方平台接口的同学可以看我上一篇博客，地址是  https://www.cnblogs.com/alanturingson/p/13377500.html ，本篇将介绍如何封装接口给第三方平台来调用。

正文开始：

既然是对接快递平台，那么无非就有两种对接的模式。第一种，是本方去调用第三方的接口，例如快递查询接口、路由查询接口、路由订阅接口等。这些都需要本方主动去请求三方提供的url，按照三方要去的请求参数来推送参数获得数据。第二种，与第一种相反，是三方调我们的接口。例如路由推送接口等。这种模式需要本方封装一个接口，并提供地址给第三方，然后第三方来调我们自己的接口从而实现我们封装的接口实现的逻辑。

今天我们说说第二种，三方调用本方接口。

二、三方来调用本方接口（注：本文以申通路由推送接口为例，可以参照申通官方文档 https://open.sto.cn/#/apiDocument/STO_TRACE_PLATFORM_PUSH ，以便理解）

在上一篇中，我们介绍调用三方接口的时候，是我们按照三方的要求来，按照他给的参数进行入参请求。那么我们写接口给三方来调，是不是就需要三方完全按照我们的要求来呢？其实并不是，为了让三方调用我们接口，我们需要首先去与三方沟通，拿到他们的请求参数格式，按照他们请求参数的格式，来设计我们的接口（ps：没错，就是这么的卑微，毕竟三方才是爸爸0^0）。在拿到三方的标准格式后，我们就可以设计接口了。与主动调用在manager层写代码不同，被动接受调用，需要从manager层到service层再到controller层，三层设计封装然后接口才算完成。

1.manager层

在manager层，我们依然可以使用调用三方接口的apimanager类，以及三层请求与三层返回类，这里需要改的是请求与返回的第三层类，具体代码如下：

1.1申通路由推送接口请求类：

@EqualsAndHashCode(callSuper = true)
@Data
public class StoTracePushRequest extends BaseStoRequest<StoTracePushResponse> {

    @Override
    public String apiName() {
        return getApiName();
    }

    public static String getApiName() {
        return "STO_TRACE_PLATFORM_PUSH";
    }

    @Override
    public String toAppKey() {
        return null;
    }

    @Override
    public Class<StoTracePushResponse> getResponseClass() {
        return StoTracePushResponse.class;
    }

    /**
     * 运单号
     */
    private String waybillNo;

    /**
     * 订单号
     */
    private String linkCode;

    /**
     * 轨迹信息
     */
    private StoTracePushInfo trace;
}

1.2 申通路由推送接口返回类：

public class StoTracePushResponse extends BaseStoResponse<StoTracePushDTO> {
}

这里的 StoTracePushDTO 类，是申通api文档里注明的响应参数，大家可以依据具体的规范设计，代码我也放出来吧：

@Data
public class StoTracePushDTO {

    /**
     * 运单号
     */
    private String waybillNo;

    /**
     * 是否需要重试: 用于正常收到请求，但程序处理异常时，可以传true，不管success是true还是false，申通侧都会重新推送；
     */
    private Boolean needRetry;
}

那么manager层的设计就到这里了，apiManeger类的话在上一篇博客里面有发出来，这里不做任何改动可以直接调用。

2.Service层  （任务来了，下次在更）