antonmaslennikov / cdek-sdk2.0
PHP SDK,用于СДЭК公司集成服务API v2.0
dev-master / 0.0.1.x-dev
2024-02-28 13:02 UTC
Requires
- php: ^7.1 || 8.*
- ext-json: *
- jms/serializer: ^3
- nyholm/psr7: ^1.2
- psr/http-client: ^1.0
- rakit/validation: ^1.1
Requires (Dev)
- doctrine/annotations: ^1.14.3
- phan/phan: ^1 <1.3 || >1.3.0
- php-coveralls/php-coveralls: ^2.1
- php-http/mock-client: ^1.3
- phpmd/phpmd: ^2.7
- phpstan/phpstan: >=0.10
- phpunit/phpunit: ^8.5 || ^9.3
- squizlabs/php_codesniffer: *
- symfony/http-client: ^5.4.22
- vimeo/psalm: >=3.0.16
This package is auto-updated.
Last update: 2024-09-28 14:12:18 UTC
README
来自TTATPuOT的库更新列表
- 增加了对PHP 8.0+的支持
- 修正了PHPDoc中的小错误,以提供更准确的IDE提示
- 改进并添加了新的单元测试
- 添加了
Client::calculator()
方法,用于根据可用运费和运费代码计算运输成本(点击查看)和(点击查看) - 改进了文档
- 修正了原始库的票证
实现了API v2.0,用于与СДЭК运输服务集成。此SDK可以帮助更快地将СДЭК运输服务集成到您的项目中。
SDK功能
- 创建订单
- 订单信息
- 删除订单
- 订阅webhooks(订单状态和打印表单状态)
- 订阅webhooks信息
- 删除webhooks订阅
- 获取PВЗ列表
- 创建调用快递员的申请
- 调用快递员申请信息
- 删除调用快递员申请
- 创建生成运单打印表的请求
- 创建生成货签打印表的请求
- 获取城市列表
- 获取区域列表
要使用所有API方法,必须拥有集成服务的访问权限,这些权限仅在签订与СДЭК公司的合同后才能获得。
要求
要求很简单。需要PHP 7.1/8.0或更高版本。
此SDK使用PSR-18 (HTTP-client)规范。这意味着可以使用任何支持此规范的HTTP客户端作为HTTP客户端。如果您的客户端不支持此规范,可以查看大多数流行HTTP客户端的现有适配器
安装
使用Composer包管理器进行安装
composer require cdek-it/sdk2.0
文档
使用示例
$client = new Psr18Client(); $cdek = new \CdekSDK2\Client($client); $cdek->setAccount('account'); $cdek->setSecure('secure'); // создание заказа $order = \CdekSDK2\BaseTypes\Order::create([...]); $res = $cdek->orders()->add($order); if ($res->hasErrors()) { // Обрабатываем ошибки // Если этого не сделать, в будущем будет ошибка RequestException foreach ($res->getErrors() as $error) { //считываем ошибки } } if ($res->isOk()) { $cdek_order = $cdek->formatResponse($res, \CdekSDK2\BaseTypes\Order::class); // $cdek_order->entity->uuid; // Если попытаться обработать ответ без проверки $res->isOk() // и при этом в ответе будут ошибки, то здесь выбросится исключение RequestException } // получение информации о заказе $res = $cdek->orders()->get($cdek_order->entity->uuid); if ($res->isOk()) { $cdek_order = $cdek->formatResponse($res, \CdekSDK2\Dto\OrderInfo::class); } //получить список офисов $res = $cdek->offices()->getFiltered(['country_code' => 'kz']); if ($res->isOk()) { $pvzlist = $cdek->formatResponseList($res, \CdekSDK2\Dto\PickupPointList::class); // $pvzlist->items; }
测试
运行测试
$ composer test
许可协议
本项目以MIT许可证分发。