PHPackages                             sudiyi/sudiyi-open-php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. sudiyi/sudiyi-open-php-sdk

ActiveLibrary[API Development](/categories/api)

sudiyi/sudiyi-open-php-sdk
==========================

Sudiyi Open Platform SDK for PHP

1.0.1(9y ago)214MITPHPPHP >=5.3

Since Jul 19Pushed 9y ago1 watchersCompare

[ Source](https://github.com/sudiyi/sudiyi-open-php-sdk)[ Packagist](https://packagist.org/packages/sudiyi/sudiyi-open-php-sdk)[ Docs](http://open.sudiyi.cn/)[ RSS](/packages/sudiyi-sudiyi-open-php-sdk/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (2)Versions (3)Used By (0)

Sudiyi Open Platform SDK for PHP
================================

[](#sudiyi-open-platform-sdk-for-php)

[![Latest Stable Version](https://camo.githubusercontent.com/b901f9d8f7dfca790a08ff522252b224bbcf9981bfccc3ef1e61375c554493e6/68747470733a2f2f706f7365722e707567782e6f72672f7375646979692f7375646979692d6f70656e2d7068702d73646b2f76657273696f6e)](https://packagist.org/packages/sudiyi/sudiyi-open-php-sdk)[![Build Status](https://camo.githubusercontent.com/004da05065f13a3c595d96ffbc3b768e39f9c24466c053f61d6a703bc41d914d/68747470733a2f2f7472617669732d63692e6f72672f7375646979692f7375646979692d6f70656e2d7068702d73646b2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/sudiyi/sudiyi-open-php-sdk)[![Coverage Status](https://camo.githubusercontent.com/7b1888e42c1e2a78713ea5da4c7b8f229bdf745d6713845cee6415ff333d4fd4/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f7375646979692f7375646979692d6f70656e2d7068702d73646b2f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/sudiyi/sudiyi-open-php-sdk?branch=master)

概述
--

[](#概述)

速递易开放平台是速递易为企业或商户开通的速递易箱格接口，无缝对接PC网站、微信公众号、APP，帮助商家提升配送效率，降低配送成本，解决快件最后100米难题。

运行环境
----

[](#运行环境)

- PHP 5.3+
- cURL extension

安装方法
----

[](#安装方法)

1. 如果您通过composer管理您的项目依赖，可以在你的项目根目录运行：

    ```
     $ composer require sudiyi/sudiyi-open-php-sdk

    ```

    或者在你的`composer.json`中声明对速递易开放平台 SDK 的依赖：

    ```
     "require": {
         "sudiyi/sudiyi-open-php-sdk": "~1.0"
     }

    ```

    然后通过`composer install`安装依赖。
2. 下载SDK源码，在您的代码中引入 SDK 目录下的`autoload.php`文件：

    ```
     require_once '/path/to/sudiyi-open-php-sdk/autoload.php';

    ```

SDK 主要目录结构
----------

[](#sdk-主要目录结构)

```
|-- example
|   |-- api_use_demo.php        案例程序代码
|   `-- notify_demo.php         商户回调处理
|-- src
|   |-- Core
|   |    |-- Base.php           基础类
|   |    |-- Config.php         常量配置
|   |    |-- Http.php           Http请求处理类
|   |    `-- SdyException.php   异常类
|   `-- Api.php                 接口封装类
|-- tests/                      测试文件
|-- autoload.php                PSR-4 自动加载
`-- composer.json

```

快速使用
----

[](#快速使用)

`Sudiyi\Open\Api` 是对速递易开方平台的接口封装,用户通过 Api 的实例来执行各种操作

### 初始化

[](#初始化)

```
require_once'/path/to/sudiyi-open-php-sdk/autoload.php';

use Sudiyi\Open\Api;

$partner_id = "";
$partner_key = "";

$sdyClient = new Api($partner_id, $partner_key);
```

### 调用接口

[](#调用接口)

```
$data = array(
    'device_id'         => 1000149,                         // 速递易设备ID
    'box_type'          => 2,                               // 箱格类型 0:大箱 1:中箱 2:小箱 3:冰箱
    'notify_url'        => 'http://your.url/to/notify.php', // 回调第三方系统的地址
    'auto_upgd'         => true,                            // 选填，是否可以自动升箱
    'sender_name'       => 'Stefans',                       // 选填，投递人姓名
    'sender_mobile'     => '18612345678',                   // 选填，投递人手机
    'order_no'          => '2015000001',                    // 第三方订单号,即自己平台的订单号
    'consignee_name'    => 'demon',                         // 收货人姓名
    'consignee_mobile'  => '15887654321',                   // 收货人手机号
    'payment'           => 0,                               // 选填，到付金额，如果不是到付件则为0
    'pay_type'          => 0,                               // 选填，超期付费方式 0:快递柜付费 1:从商户账户扣除
    'duration'          => 60                               // 选填，预约时长，单位分钟，默认240分钟
);

// 预约速递易箱格
$result = $sdyClient->resv($data);
echo "预约成功: \n";
var_dump($result);

$resv_order_no = $result['resv_order_no'];

// 查询预约状态
$result = $sdyClient->getResv($resv_order_no);
echo "查询预约状态: \n";
var_dump($result);
```

更多接口的调用方式，请参见 example 或参看[官方文档](http://opendoc.sudiyi.cn/api.html)。

### 返回结果

[](#返回结果)

- GET、POST 类接口, 默认返回一个 Array 对象
- PUT、DELETE 类接口, 若操作成功, 返回 Array 对象, 操作失败, 返回 NULL 或 Array
- 请求错误, 抛出 SdyException 异常

```
预约成功:
array(1) {
  'resv_order_no' =>
  int(20160719000001)
}

查询预约状态:
array(3) {
  'status' =>
  int(1)
  'resv_order_no' =>
  int(20160719000001)
  'open_code' =>
  NULL
}

```

### 异常处理

[](#异常处理)

SDK 执行过程中若遇到异常，将会抛出一个 SdyException 异常，用户可自行捕获并处理。

```
use Sudiyi\Open\Api;
use Sudiyi\Open\Core\SdyException;

try {
    // 预约速递易箱格
    $result = $sdyClient->resv($data);
    $resv_order_no = $result['resv_order_no'];

    // 取消预约箱格
    $result = $sdyClient->cancelResv($resv_order_no);
    echo "取消预约箱格: \n";
    var_dump($result);

} catch (SdyException $e) {
    echo "============== ERROR ==============\n";
    echo $e->getMessage() . "\n";
    var_dump($e->getErrorBody());
    echo "===================================\n";
}
```

### 运行Sample程序

[](#运行sample程序)

1. 修改 `example/api_use_demo.php`， 补充配置信息
2. 执行 `php ./example/api_use_demo.php`

### 运行单元测试

[](#运行单元测试)

1. 执行`composer install`下载依赖的库
2. 设置环境变量

    ```
     export SDY_PARTNER_ID=partner_id
     export SDY_PARTNER_KEY=partner_key

    ```
3. 执行 `php vendor/bin/phpunit`

问题反馈
----

[](#问题反馈)

Goto: [ISSUES](https://github.com/sudiyi/sudiyi-open-php-sdk/issues)

开源协议
----

[](#开源协议)

MIT

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

3584d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/433fbabdac4ec1fa9d36a5b790686eac83bd29d7f7d49dfe0841cb0d62d1f870?d=identicon)[sudiyi](/maintainers/sudiyi)

---

Top Contributors

[![yiichou](https://avatars.githubusercontent.com/u/2182089?v=4)](https://github.com/yiichou "yiichou (6 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/sudiyi-sudiyi-open-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/sudiyi-sudiyi-open-php-sdk/health.svg)](https://phpackages.com/packages/sudiyi-sudiyi-open-php-sdk)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)