gdinko/acs

Laravel ACS API 包装器

v1.0.2 2022-05-27 11:11 UTC

This package is auto-updated.

Last update: 2024-09-27 16:27:57 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

ACS JSON API 文档

ACS JSON API Swagger UI

安装

您可以通过composer安装此包

composer require gdinko/acs

如果您计划使用数据库存储品名

php artisan migrate

如果您需要导出配置文件

php artisan vendor:publish --tag=acs-config

如果您需要导出迁移

php artisan vendor:publish --tag=acs-migrations

如果您需要导出模型

php artisan vendor:publish --tag=acs-models

如果您需要导出命令

php artisan vendor:publish --tag=acs-commands

配置

ACS_API_KEY=
ACS_COMPANY_ID=
ACS_COMPANY_PASSWORD=
ACS_USER_ID=
ACS_USER_PASSWORD=
ACS_BILLING_CODE=
ACS_API_BASE_URL= #default=https://webservices.acscourier.net/ACSRestServices/api/ACSAutoRest/
ACS_API_TIMEOUT= #default=5

用法

运行时设置

Acs::setTimeout(99);
/**
 * You can call all methods from the API like this , there is no need
 * to pass company data every time. The data is injected automaticaly
 * on every request
 **/

dd(Acs::ACS_Address_Validation([
    'Address' => 'Address ...'
]));

dd(Acs::ACS_Trackingsummary([
    'Voucher_No' => '999999999'
]));

命令

#get acs api status (use -h to view options)
php artisan acs:api-status

#track parcels (use -h to view options)
php artisan acs:track

模型

CarrierAcsTracking
CarrierAcsApiStatus

事件

CarrierAcsTrackingEvent

包裹跟踪

  1. 订阅跟踪事件,如果已安排跟踪命令,您将收到最后的跟踪信息
Event::listen(function (CarrierAcsTrackingEvent $event) {
    echo $event->account;
    dd($event->tracking);
});
  1. 在使用跟踪命令之前,您需要创建自己的命令并定义setUp方法
php artisan make:command TrackCarrierAcs
  1. 在app/Console/Commands/TrackCarrierAcs中定义要跟踪的包裹的逻辑
use Gdinko\Acs\Commands\TrackCarrierAcsBase;

class TrackCarrierAcsSetup extends TrackCarrierAcsBase
{
    protected function setup()
    {
        //define parcel selection logic here
        // $this->parcels = [];
    }
}
  1. 使用此命令
php artisan acs:track

测试

composer test

变更日志

请参阅CHANGELOG以获取最近更改的更多信息。

贡献

请参阅CONTRIBUTING以获取详细信息。

安全

如果您发现任何安全问题,请通过电子邮件dinko359@gmail.com联系,而不是使用问题跟踪器。

鸣谢

许可协议

MIT许可协议(MIT)。请参阅许可文件以获取更多信息。