open-soft / sdk2.0
PHP SDK,用于СДЭК公司集成服务API v2.0
1.0.1
2023-05-05 12:50 UTC
Requires
- php: ^7.1
- ext-json: *
- jms/serializer: >=1.14.0
- nyholm/psr7: ^1.2
- psr/http-client: ^1.0
- rakit/validation: ^1.1
Requires (Dev)
- 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: ^6.5 || ^7.4
- squizlabs/php_codesniffer: *
- symfony/http-client: ^4.3
- vimeo/psalm: >=3.0.16
This package is auto-updated.
Last update: 2024-09-05 16:16:38 UTC
README
实现API v2.0与СДЭК物流服务集成。本SDK可以帮助您更快地将СДЭК物流服务集成到项目中。
SDK功能
- 创建订单
- 订单信息
- 删除订单
- 订阅Webhook(订单状态和打印表单状态)
- Webhook订阅信息
- 删除Webhook订阅
- 获取快递点列表
- 创建派送员上门请求
- 派送员上门请求信息
- 删除派送员上门请求
- 创建打印运单请求
- 创建打印条形码位置打印请求
- 获取城市列表
- 获取地区列表
要使用所有API方法,必须具备集成服务访问权限,这些权限仅在签订СДЭК公司合同后提供。
要求
要求非常简单。需要PHP 7.1或更高版本。
该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()) { // Обрабатываем ошибки foreach ($res->getErrors() as $error) { //считываем ошибки } } if ($res->isOk()) { $cdek_order = $cdek->formatResponse($res, \CdekSDK2\BaseTypes\Order::class); // $cdek_order->entity->uuid; } // получение информации о заказе $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许可证发布。