README

#AfterShip API PHP SDK aftership-php 是 AfterShip API 的 PHP SDK (模块)，提供了访问 API 端点的简洁和优雅的方式。**与 AfterShip API 兼容**

联系方式：support@aftership.com

安装

下载并安装 Composer。 https://getcomposer.org.cn/download/

然后，你有两种方式下载 AfterShip PHP SDK

1. 运行以下命令以引入 AfterShip PHP SDK

composer require mhabibi/aftership-php-sdk

或 2. 从 git pull 此存储库并运行以下命令

composer install

请确保已安装 PHP 扩展 CURL，您可以使用以下命令安装它

sudo apt-get install php5-curl

然后重新启动 Web 服务器和 PHP 进程。

测试

1. 在浏览器中执行文件：test/testing.php
2. 插入您的 AfterShip API 密钥。 如何生成 AfterShip API 密钥
3. 单击“请求全部”按钮或表示的请求按钮

单元测试

vendor/bin/phpunit

快递公司

获取您选择的快递公司列表

https://www.aftership.com/docs/api/4/couriers/get-couriers

require 'vendor/autoload.php';

$couriers = new AfterShip\Couriers('AFTERSHIP_API_KEY');
$response = $couriers->get();

获取我们支持的所有快递公司列表

https://www.aftership.com/docs/api/4/couriers/get-couriers-all

require 'vendor/autoload.php';

$couriers = new AfterShip\Couriers('AFTERSHIP_API_KEY');
$response = $couriers->get_all();

通过追踪号检测快递公司

https://www.aftership.com/docs/api/4/couriers/post-couriers-detect

require 'vendor/autoload.php';

$courier = new AfterShip\Couriers('AFTERSHIP_API_KEY');
$response = $courier->detect('1234567890Z');

跟踪

创建新的跟踪

https://www.aftership.com/docs/api/4/trackings/post-trackings

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$tracking_info = array(
    'slug'    => 'dhl',
    'title'   => 'My Title',
);
$response = $trackings->create('RA123456789US', $tracking_info);

创建多个跟踪

(即将推出)

通过 slug 和跟踪号删除跟踪

https://www.aftership.com/docs/api/4/trackings/delete-trackings

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->delete('dhl', 'RA123456789US');

通过跟踪 ID 删除跟踪

https://www.aftership.com/docs/api/4/trackings/delete-trackings

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->delete_by_id('53df4a90868a6df243b6efd8');

获取多个跟踪的结果

https://www.aftership.com/docs/api/4/trackings/get-trackings

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$options = array(
    'page'=>1,
    'limit'=>10
);
$response = $trackings->get_all($options)

通过 slug 和跟踪号获取单个跟踪的结果

https://www.aftership.com/docs/api/4/trackings/get-trackings-slug-tracking_number

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->get('dhl', 'RA123456789US', array('title','order_id'));

通过跟踪 ID 获取单个跟踪的结果

https://www.aftership.com/docs/api/4/trackings/get-trackings-slug-tracking_number

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->get_by_id('53df4a90868a6df243b6efd8', array('title','order_id'));

通过 slug 和跟踪号更新跟踪

https://www.aftership.com/docs/api/4/trackings/put-trackings-slug-tracking_number

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$params = array(
    'smses'             => array(),
    'emails'            => array(),
    'title'             => '',
    'customer_name'     => '',
    'order_id'          => '',
    'order_id_path'     => '',
    'custom_fields'     => array()
);
$response = $trackings->update('dhl', 'RA123456789US', $params);

通过跟踪 ID 更新跟踪

https://www.aftership.com/docs/api/4/trackings/put-trackings-slug-tracking_number

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$params = array(
    'smses'             => array(),
    'emails'            => array(),
    'title'             => '',
    'customer_name'     => '',
    'order_id'          => '',
    'order_id_path'     => '',
    'custom_fields'     => array()
);
$response = $trackings->update_by_id('53df4a90868a6df243b6efd8', $params);

通过 slug 和跟踪号重新激活跟踪

https://www.aftership.com/docs/api/4/trackings/post-trackings-slug-tracking_number-retrack

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->retrack('dhl','RA123456789US');

通过跟踪 ID 重新激活跟踪

https://www.aftership.com/docs/api/4/trackings/post-trackings-slug-tracking_number-retrack

require 'vendor/autoload.php';

$trackings = new AfterShip\Trackings('AFTERSHIP_API_KEY');
$response = $trackings->retrack_by_id('53df4a90868a6df243b6efd8');

最后检查点

通过 slug 和跟踪号返回单个跟踪的最后检查点信息

https://www.aftership.com/docs/api/4/last_checkpoint/get-last_checkpoint-slug-tracking_number

require 'vendor/autoload.php';

$last_check_point = new AfterShip\LastCheckPoint('AFTERSHIP_API_KEY');
$response = $last_check_point->get('dhl','RA123456789US');

通过跟踪 ID 返回单个跟踪的最后检查点信息

https://www.aftership.com/docs/api/4/last_checkpoint/get-last_checkpoint-slug-tracking_number

require 'vendor/autoload.php';

$last_check_point = new AfterShip\LastCheckPoint('AFTERSHIP_API_KEY');
$response = $last_check_point->get_by_id('53df4a90868a6df243b6efd8');

通知

通过 slug 和跟踪号创建新的通知

https://www.aftership.com/docs/api/4/notifications/post-add-notifications

require 'vendor/autoload.php';

$notifications = new AfterShip\Notifications('AFTERSHIP_API_KEY');
$response = $notifications->create('ups', '1ZV90R483A33906706', array(
                'emails' => ['youremail@yourdomain.com']
            ))

通过跟踪 ID 创建新的通知

https://www.aftership.com/docs/api/4/notifications/post-add-notifications

require 'vendor/autoload.php';

$notifications = new AfterShip\Notifications('AFTERSHIP_API_KEY');
$response = $notifications->create_by_id('53df4a90868a6df243b6efd8');

通过 slug 和跟踪号删除通知。

https://www.aftership.com/docs/api/4/notifications/post-remove-notifications

require 'vendor/autoload.php';

$notifications = new AfterShip\Notifications('AFTERSHIP_API_KEY');
$response = $notifications->delete('ups', '1ZV90R483A33906706', array(
                  'emails' => ['youremail@yourdomain.com']
              )));

通过跟踪 ID 删除通知。

https://www.aftership.com/docs/api/4/notifications/post-remove-notifications

require 'vendor/autoload.php';

$notifications = new AfterShip\Notifications('AFTERSHIP_API_KEY');
$response = $notifications->delete_by_id('53df4d66868a6df243b6f882'));

通过 slug 和跟踪号获取单个跟踪的通知

https://www.aftership.com/docs/api/4/notifications/get-notifications

require 'vendor/autoload.php';

$notifications = new AfterShip\Notifications('AFTERSHIP_API_KEY');
$response = $notifications->get('dhl', '2254095771'));

通过跟踪 ID 获取单个跟踪的通知

https://www.aftership.com/docs/api/4/notifications/get-notifications

require 'vendor/autoload.php';

$notifications = new AfterShip\Notifications('AFTERSHIP_API_KEY');
$response = $notifications->get_by_id('53df4a90868a6df243b6efd8', array('fields' => 'customer_name'));