README

SHIPPO APIs客户端库（PHP版）

PHP版的Shippo API客户端库允许您使用Shippo的公开API。这些库由Shippo官方支持。

公开API

是Shippo的公开API，为开发者或合作伙伴提供程序化访问Shippo系统的途径。更多详情这里。

API文档

https://open-api.shippo.vn/

安装

要求

PHP 7+

Composer

要安装，运行 composer require shippodeveloper/shippo-sdk-php-client

##使用

配置

配置通过ShippoSDK\Client的一个实例使用ShippoSDK\Config完成。

$config = new \ShippoSDK\Config([
    'access_token' => 'your access token',
    'base_uri' => 'https://apix.shippo.vn', // or https://sandbox-apix.shippo.vn for sandbox mode
]);
$client = new \ShippoSDK\Client($config);

API端点

每个API都实现为API端点类。

此示例使用配送订单

$deliveryOrderEP = new \ShippoSDK\Endpoints\DeliveryOrderEndpoint($client);
$param = [
    'pickupAddressId' => 100022031,
    'services' => [
        'insurance' => [
            'amount' => 1000000, //bảo hiểm với số tiền 1 triệu đồng
        ]
    ],
    'goods' => [],
    'chargeType' => 'SENDER',
    'deliveryPackage' => 'STC',
    'merchantOrderCode' => 'MOC_0001',
    'merchantPrivateNote' => 'Freddie Mercury is gay',
    'code' => '380000',
    'deliveryNote' => '',
    'receiverPhone' => '0380987654',
    'receiverName' => 'Brian May',
    'deliverDetailAddress' => 'Fist Aid 1985',
    'deliverLocationId' => 18, //Ba Đình
    'pickupNote' => 'Đến gọi cho Mary Austin'
];
$order = $deliveryOrderEP->create($param);

请参阅tests目录中的测试脚本以了解其工作原理

成为贡献者

我们欢迎开发者为Shippo的开发者库做出贡献。除了PHP，开发者还可以使用Shippo的公开API为NodeJS、Java、Ruby和Python开发集成库。

Shippo感谢您的帮助！

版权和许可证

许可协议：Apache License 2.0（“许可证”）；除非遵守许可证的规定，否则不得使用此文件。您可以在以下位置获得许可证的副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则在许可证下分发的软件按“原样”提供，不提供任何明示或暗示的保证或条件。有关许可证的具体语言、权限和限制，请参阅许可证。

shippodeveloper / shippo-sdk-php-client

维护者

详细信息