fossabot/ztosdk

中通开放平台SDK（非官方）

中通开放平台SDK

这是一个调用中通开放平台接口的java SDK（非官方），如果不想用本项目封装的客户端，可以参考wiki：https://git.io/vAVV6

中通开放平台：http://zop.zto.com

接入中通开放平台，可以实现以下功能

1. 查询中通物流轨迹
2. 在线预约寄件
3. 获取电子面单号（电商、仓库发货打单） 其他见中通开放平台官网

使用方法

非spring-boot项目

添加以下maven依赖

<dependency>
    <groupId>io.loli.zto</groupId>
    <artifactId>ztosdk-core</artifactId>
    <version>0.0.6</version>
</dependency>

使用示例

ZtoClientProperties ztoClientProperties = new ZtoClientProperties("http://japi.zto.cn/",
    "your companyid","your key",false , 2000L);
ZtoApiClient client = new ZtoApiClient(ztoClientProperties);
client.api().traceInterfaceNewTraces(new String[]{"12345678901"})
    .subscribe(resp->{
        if (resp.isFailure()) {
            System.out.println(resp.getCause().getMessage());
        } else {
            System.out.println(resp.get());
        }
    });

1. companyid 和 key 需要登录中通开放平台后到个人中心查看
2. 注意 url 不是中通文档中的全部url，是去掉路径之后的，一般情况下，生产环境为http://japi.zto.cn，测试环境为http://58.40.16.125:9001/，如果此处和中通开放平台上的文档上不同，请以中通开放平台的为准

中通开放平台的接口类型

中通开放平台中有三种接口类型，分别为 api，msgtype和service

目前中通开放平台上的接口类型大多为api，可以通过以下方式区分

1. msgtype: 接口地址是http://japi.zto.cn/gateway.do
2. api: 接口地址是http://japi.zto.cn/apiName
3. service: 接口地址http://japi.zto.cn/zto/api_utf8/serviceName

ZtoApiClient支持三种调用方式，见ZtoApiClient的三个方法msgtype、api和service

ZtoApiClient.msgtype()提供了以下接口调用

1. 电子面单-获取单号
2. 快件轨迹-获取快件轨迹信息
3. 快件轨迹-获取快件最新一条
4. 电子面单-集包地大头笔接口

ZtoApiClient.api()提供了以下接口调用

1. 电子面单-获取单号
2. 快件轨迹-获取快件轨迹信息
3. 快件轨迹-获取快件最新一条
4. 电子面单-集包地大头笔接口
5. 基础信息-获取时效价格
6. 订单服务-预约寄件-订单创建

使用示例

中通开放平台中，service和msgtype类型的接口，只支持content-type为application/x-www-form-urlencoded

api类型的接口，支持application/x-www-form-urlencoded和application/json两种，目前还不支持xml

以下是api的一些示例

// 当传入的请求是字符串的时候，content-type按照application/json处理
// 返回值的class写String.class，那么将直接会将http请求返回的字符串返回
ZtoClientProperties ztoClientProperties = new ZtoClientProperties("http://japi.zto.cn/",
                "your_company_id", "your_key", true, 2000L);
String requestBodyStr = "{'name':'value'}";
ZtoApiClient client = new ZtoApiClient(ztoClientProperties);
Try<String> ztoTraceResponses = client.api()
        .post("newApiName", requestBodyStr, String.class)
        .blockingFirst();
System.out.println(ztoTraceResponses.get());

// 当直接传入Map以外的数据对象的时候，在http请求发送之前，会将对象转换成json字符串，content-type也会按照application/json处理
YourDataObject requestBody = new YourDataObject();
Try<String> ztoTraceResponses = client.api()
       .post("newApiName", requestBody, String.class)
       .blockingFirst();

// 当直接传入Map时候，content-type会按照application/x-www-form-urlencoded处理
Map<String,String> requestBody = new HashMap<>();
requestBody.put("name","Tom");
Try<String> ztoTraceResponses = client.api()
       .post("newApiName", requestBody, String.class)
       .blockingFirst();

spring-boot项目

添加以下maven依赖

<dependency>
    <groupId>io.loli.zto</groupId>
    <artifactId>ztosdk-springboot-starter</artifactId>
    <version>0.0.6</version>
</dependency>

在启动类上添加 @EnableZtoClient 注解，然后注入使用

@Autowired
ZtoApiClient client;

需要在application.yml中添加以下配置

zto:
  url: http://japi.zto.cn/
  company-id: your-company-id
  key: your-key
  timeout: 2000
  async: false

日志

如果要查看基本的请求返回值耗时等日志，在application.yml里添加

logging:
  level:
    io.loli.zto.client.ZtoLoggingInterceptor: debug

会输出类似下面的日志：

url =http://japi.zto.cn/commonOrder ,header={} ,cost=100 ,code=200 ,body=>{{}} ,response={}

RxJava

ZtoApiClient的请求方法都返回Observable对象，如果想直接使用返回值，使用Observable的blockingFirst方法的返回值

异常处理

ZtoApiClient的请求方法返回值都用Try包了一层，所以无需自行try-catch

ZtoPriceAndHourRequest request = new ZtoPriceAndHourRequest();
request.setDispProv("江苏省");
request.setDispCity("南通市");
request.setSendProv("上海");
request.setSendCity("上海市");
Try<ZtoPriceAndHourResponse> respTry = apiClient
                   .api()
                   .priceAndHourInterfaceGetHourPrice(request)
                   .blockingFirst();
if (respTry.isSuccess()) {
    System.out.println(respTry.get());
} else {
    respTry.getCause().printStackTrace();
}

在出现异常时，如果要查看具体的请求日志，请调整日志级别（见上文）

异步

默认为同步调用，如果想使用异步，可以按照以下方式配置

zto.async: true

异步调用时就别用Observable的blockingFirst方法了，直接subscribe吧~

LICENSE

本项目是MIT协议，请放心fork和使用