README

简介

使用 SuperShip SDK for PHP，开发者可以轻松地将 SuperShip APIs 集成到他们的PHP代码库中，使企业能够自动化和扩展他们的运输操作。

功能

SuperShip API中的一些可用功能包括

区域API：此API允许开发者检索SuperShip支持的省、区和乡镇的列表，用于货物的提货、交付和退货。
认证API：此API允许开发者通过用户名和密码注册新用户并获取令牌。
订单API：此API允许开发者检索运费、创建新订单、检索订单信息、获取订单状态列表以及生成运单。
仓库API：此API允许开发者创建新仓库、编辑当前仓库并检索所有仓库的信息。
Webhooks API：此API允许开发者注册新webhook、编辑当前webhook以及检索已注册的webhook。

请查看 SuperShip API文档以获取更多详细信息。

API文档

SuperShip API的文档可以在 API文档网站上找到。

安装

您可以通过composer安装此包

composer require supershipvn/supership-sdk-php

用法

订单API

创建订单

要创建新订单，使用以下语法调用 createOrder 方法

use SuperShip\SuperShipClient;

$supership = new SuperShipClient('YOUR_API_TOKEN');

$params = [
    'pickup_phone' => '0989999999',
    'pickup_address' => '45 Nguyễn Chí Thanh',
    'pickup_commune' => 'Phường Ngọc Khánh',
    'pickup_district' => 'Quận Ba Đình',
    'pickup_province' => 'Thành phố Hà Nội',
    'name' => 'Trương Thế Ngọc',
    'phone' => '0945900350',
    'email' => null,
    'address' => '35 Trương Định',
    'province' => 'Thành phố Hồ Chí Minh',
    'district' => 'Quận 3',
    'commune' => 'Phường 6',
    'amount' => '220000',
    'value' => null,
    'weight' => '200',
    'payer' => '1',
    'service' => '1',
    'config' => '1',
    'soc' => 'KAN7453535',
    'note' => 'Giao giờ hành chính',
    'product_type' => '2',
    'products' => [
        [
            'sku' => 'P899234',
            'name' => 'Tên Sản Phẩm 1',
            'price' => 200000,
            'weight' => 200,
            'quantity' => 1,
        ],
        [
            'sku' => 'P899789',
            'name' => 'Tên Sản Phẩm 2',
            'price' => 250000,
            'weight' => 300,
            'quantity' => 2,
        ],
    ]
];

$supership->createOrder($params);

可选地，您可以使用以下方法检索订单代码

$order = $supership->createOrder($params);
echo $order['results']['code'];

获取单个订单信息

要检索单个订单，使用以下语法调用 getOrderInfo 方法

$supershipOrderCode = 'SUPERSHIP_ORDER_CODE';
$supership->getOrderInfo($supershipOrderCode);

获取所有订单状态

要检索所有订单状态，使用以下语法调用 getOrderStatuses 方法

$supership->getOrderStatuses();

创建打印令牌

要获取用于标签打印的新令牌，使用以下语法调用 createPrintToken 方法

$params = [
    'code' => [
        'SUPERSHIP_ORDER_CODE_1',
        'SUPERSHIP_ORDER_CODE_2'
    ]
];

$supership->createPrintToken($params);

获取打印链接

要获取打印令牌的打印链接，使用以下语法调用 getOrderInfo 方法

$printToken = '49ef6620-423e-11e9-b019-b71407a43f47';
$labelSize = 'K46';

$supership->getPrintLink($printToken, $labelSize);

仓库API

获取所有仓库

要检索所有仓库，使用以下语法调用 getWarehouses 方法

$supership->getWarehouses();

创建仓库

要创建新仓库，使用以下语法调用 createWarehouse 方法

$params = [
    'name' => 'Kho HBT',
    'phone' => '0989999888',
    'contact' => 'Trần Cao Cường',
    'address' => '47 Lê Lợi',
    'province' => 'Thành phố Hồ Chí Minh',
    'district' => 'Quận Tân Bình',
    'district' => 'Phường 13',
    'primary' => '1'
];

$supership->createWarehouse($params);

更新仓库

要编辑当前仓库，使用以下语法调用 editWarehouse 方法

$params = [
    'code' => 'WLKGT07050',
    'name' => 'Kho Hai Bà Trưng',
    'phone' => '0989999888',
    'contact' => 'Dương Mạnh Quân'
];

$supership->editWarehouse($params);

Webhooks API

获取所有Webhooks

要检索所有webhook，使用以下语法调用 getWebhooks 方法

$supership->getWebhooks();

注册Webhook

要注册新webhook，使用以下语法调用 registerWebhook 方法

$partnerUrl = 'https://example.com/listen/supership';

$supership->registerWebhook($partnerUrl);

认证API

创建用户

要创建新用户，使用以下语法调用 createUser 方法

$params = [
    'project' => 'HMN Store',
    'name' => 'Hoàng Mạnh Nam',
    'phone' => '0989998888',
    'email' => 'hmn.store@gmail.com',
    'password' => '323423',
    'partner' => 'lPxLuxfiTotCyZ1ZnQjMepUL24HLd05ybNBhVGFN'
];

$supership->createUser($params);

检索令牌

要使用用户名和密码检索令牌，使用以下语法调用 retrieveToken 方法

$params = [
    'client_id' => 'AZN6QUo40w',
    'client_secret' => 'C4fFVeFPkISEDQ8acNo9oSHUd8yIGuvoLWJdX9zY',
    'username' => 'hmn.store@gmail.com',
    'password' => '323423',
    'partner' => 'lPxLuxfiTotCyZ1ZnQjMepUL24HLd05ybNBhVGFN'
];

$supership->retrieveToken($params);

区域API

获取所有省份

要检索所有省份，使用以下语法调用 getProvinces 方法

$supership->getProvinces();

获取所有区

要检索所有区，使用以下语法调用 getDistricts 方法

$provinceCode = '79';

$supership->getDistricts($provinceCode);

获取所有乡镇

要检索所有乡镇，使用以下语法调用 getCommunes 方法

$districtCode = '777';

$supership->getCommunes($districtCode);

变更日志

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

贡献

感谢您考虑为SuperShip SDK for PHP做出贡献！贡献指南可在我们的贡献指南中找到。

安全

如果您发现了关于安全性的bug，请通过邮件supertek@supership.vn联系，而不是使用问题跟踪器。

鸣谢

SuperShip

许可证

SuperShip SDK for PHP是开源软件，受MIT许可证许可。

supershipvn / supership-sdk-php

维护者

详细信息