Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uuk020/logistics

PHP 多接口获取快递物流信息包
https://github.com/uuk020/logistics

composer logistics php

Last synced: 2 months ago
JSON representation

PHP 多接口获取快递物流信息包

Host: GitHub
URL: https://github.com/uuk020/logistics
Owner: uuk020
Created: 2018-12-25T13:36:13.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-03-17T13:23:27.000Z (almost 2 years ago)
Last Synced: 2024-06-19T18:09:14.506Z (7 months ago)
Topics: composer, logistics, php
Language: PHP
Homepage:
Size: 99.6 KB
Stars: 299
Watchers: 11
Forks: 32
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        
 Logistics 


简单便捷查询运单快递信息


[![Build Status](https://travis-ci.org/uuk020/logistics.svg?branch=master)](https://travis-ci.org/uuk020/logistics)

![StyleCI build status](https://github.styleci.io/repos/163085695/shield)

[![Latest Stable Version](https://poser.pugx.org/wythe/logistics/v/stable)](https://packagist.org/packages/wythe/logistics)

[![Total Downloads](https://poser.pugx.org/wythe/logistics/downloads)](https://packagist.org/packages/wythe/logistics)

[![Latest Unstable Version](https://poser.pugx.org/wythe/logistics/v/unstable)](https://packagist.org/packages/wythe/logistics)

[![License](https://poser.pugx.org/wythe/logistics/license)](https://packagist.org/packages/wythe/logistics)

### 支持查询接口平台

| 平台 | 次数 | 是否需要快递公司编码 | 免费版支持的快递公司 |

| :-----: | :----: | :----: | :----: |

| [快递100](https://www.kuaidi100.com/openapi/applyapi.shtml) | 100次(首次申请) | Y | |

| [快递鸟](http://www.kdniao.com/api-all) | 500单/天(免费) | Y | 支持申通、圆通、百世、天天，其他快递公司可自行尝试，不支持顺丰 |

| [聚合数据](https://www.juhe.cn/docs/api/id/43) | 100次(首次申请) | Y | |

| [极速数据](https://www.jisuapi.com/api/express) | 1000次(免费) | N | |

| [数据智汇](http://www.shujuzhihui.cn/apiDetails?id=1867) | 100次(免费) | N | |

### 配置须知

* 只有快递鸟申请后会有两个,一个是用户ID, 填入到app_secret,另外一个则是api_key, 填入app_key, 其他则把申请的key填入到app_key 

### 环境需求

* PHP >= 7.0

### 安装

```shell

$ composer require wythe/logistics -vvv

```

### 使用

```php

use Wythe\Logistics\Logistics;

$config = [

    'juhe' => ['app_key' => 'app_key', 'vip' => false],

    'shujuzhihui' => ['app_key' => 'app_key', 'vip' => false],

    'jisu' => ['app_key' => 'app_key', 'vip' => false],

    'kuaidibird' => ['app_key' => 'app_key', 'app_secret' =>  'app_secret', 'vip' =>

            false],

    'kuaidi100' => ['app_key' => '']

];

$logistics = new Logistics($config);

```

### 参数说明

```

array query(string $code, $channels = ['kuaidi100'], string $company = '')

array queryByProxy(array $proxy, string $code, $channels = ['kuaidi100'], string $company = '')

```

* query 与 queryByProxy 返回数组结构是一样, 只是多了一个参数代理IP

* $proxy - 代理地址 结构: ['proxy' => '代理IP:代理端口']

* $code - 运单号

* $channel - 渠道名称, 可选参数,默认快递鸟.

* $company - 快递公司 具体看 SupportLogistics 文件

### 快递 100 接口获取物流信息 所有接口返回格式是统一

```php

use Wythe\Logistics\Logistics;

$config = [

    'juhe' => ['app_key' => 'app_key', 'vip' => false],

    'shujuzhihui' => ['app_key' => 'app_key', 'vip' => false],

    'jisu' => ['app_key' => 'app_key', 'vip' => false],

    'kuaidibird' => ['app_key' => 'app_key', 'app_secret' =>  'app_secret', 'vip' =>

            false],

    'kuaidi100' => ['app_key' => '']

];

$logistics = new Logistics($config);

$logistics->query('12313131231', ''); // 第二参数选填,可以为字符串或数组, 默认快递鸟

$logistics->query('12313131231', 'kuaidi100');

$logistics->query('12313131231', ['kuaidi100']);

```

示例:

```php 

[

   'kuaidi100' => [

       'channel' => 'kuaidi100',

       'status' => 'success',

       'result' => [

           [

               'status' => 200,

               'message'  => 'OK',

               'error_code' => 0,

               'data' => [

                   ['time' => '2019-01-09 12:11', 'description' => '仓库-已签收'],

                   ['time' => '2019-01-07 12:11', 'description' => '广东XX服务点'],

                   ['time' => '2019-01-06 12:11', 'description' => '广东XX转运中心']

               ],

               'logistics_company' => '申通快递',

               'logistics_bill_no' => '12312211'

           ],

           [

               'status' => 201,

               'message' => '快递公司参数异常：单号不存在或者已经过期',

               'error_code' => 0,

               'data' => '',

               'logistics_company' => '',

               'logistics_bill_no' => ''

           ]

       ]

   ]

]

```

### 多接口获取物流信息

```php

use Wythe\Logistics\Logistics;

$config = [

    'juhe' => ['app_key' => 'app_key', 'vip' => false],

    'shujuzhihui' => ['app_key' => 'app_key', 'vip' => false],

    'jisu' => ['app_key' => 'app_key', 'vip' => false],

    'kuaidibird' => ['app_key' => 'app_key', 'app_secret' =>  'app_secret', 'vip' =>

            false],

    'kuaidi100' => ['app_key' => '']

];

$logistics = new Logistics($config);

$logistics->query('12313131231');

$logistics->query('12313131231', ['kuaidi100', 'ickd']);

```

示例:

```php 

[

   'kuaidi100' => [

       'channel' => 'kuaidi100',

       'status' => 'success',

       'result' => [

           [

               'status' => 200,

               'message'  => 'OK',

               'error_code' => 0,

               'data' => [

                   ['time' => '2019-01-09 12:11', 'description' => '仓库-已签收'],

                   ['time' => '2019-01-07 12:11', 'description' => '广东XX服务点'],

                   ['time' => '2019-01-06 12:11', 'description' => '广东XX转运中心']

               ],

               'logistics_company' => '申通快递',

               'logistics_bill_no' => '12312211'

           ],

           [

               'status' => 201,

               'message' => '快递公司参数异常：单号不存在或者已经过期',

               'error_code' => 0,

               'data' => '',

               'logistics_company' => '',

               'logistics_bill_no' => ''

           ]

       ]

   ],

   'ickd' => [

       'channel' => 'ickd',

       'status' => 'success',

       'result' => [

           [

               'status' => 200,

               'message'  => 'OK',

               'error_code' => 0,

                'data' => [

                    ['time' => '2019-01-09 12:11', 'description' => '仓库-已签收'],

                    ['time' => '2019-01-07 12:11', 'description' => '广东XX服务点'],

                    ['time' => '2019-01-06 12:11', 'description' => '广东XX转运中心']

                ],

                'logistics_company' => '申通快递',

                'logistics_bill_no' => '12312211'

           ]

       ]

   ]

]

```

## 参考

* [PHP 扩展包实战教程 - 从入门到发布](https://laravel-china.org/courses/creating-package)

* [高德开放平台接口的 PHP 天气信息组件(weather)](https://github.com/overtrue/weather)

* [满足你的多种发送需求的短信发送组件(easy-sms)](https://github.com/overtrue/easy-sms)

## 最后

欢迎提出 issue 和 pull request

## License

MIT