README

shyplite.com

安装

Composer 是安装任何 PHP 库/依赖项及其依赖项的最佳选择。如果您尚未安装，请点击Composer

然后在您的终端/命令提示符中运行以下命令，其中包含您的应用程序安装位置。

composer require md-adil/shyplite dev-master

登录

在发出任何请求之前，您需要首先设置令牌。

获取令牌

use Adil\Shyplite\Shyplite;

$congis = [
    'username'=> '<email-id>',
    'password' => '<password>',
    'app_id' => '<app-id>', // Your app's ID
    'seller_id' => '<seller-id>',   // Your seller ID
    'key' => '<key>'
];

$shyplite = new Shyplite($configs); // Constructor takes config array as argument
$response = $shyplite->login();
$shyplite->setToken($response->userToken);

订单

创建订单

$orders = $shyplite->order()->add([/*order array provided in official doc*/])
    ->add([/*Add more order not more than 25*/])
    ->create() // finally create order and return array of Order model which hold the values you provided with response id and success status
    // or

foreach($orders as $order) {
    echo $order->id; // response success id
    echo $order->getError(); // if error on particular order
    echo $order->hasError(); // true or false
}

取消订单

$shyplite->order()->cancel([/* array of order id */])

货运

获取运单

$slip = $shyplite->shipment()->getSlip(/* order id */);

echo $slip->name; // name of slip

echo $slip->download(/* download location */);

获取货单

$menifest = $shyplite->shipment()->menifest(/* menifest id provided by getSlip function */);
echo $menifest->name; // name of menifest
echo $menifest->path // path to download menifest
$menifest->download(/*path to download*/);

服务

检查服务可用性。

$available = $shyplite->service()->availability($sourcePincode, $destinationPincode);

print_r($avaialable);

配置

必需

$config = [
    'username'=> '<email-id>',
    'password' => '<password>',
    'app_id' => '<app-id>', // Your app's ID
    'seller_id' => '<seller-id>',   // Your seller ID
    'key' => '<key>'
];

默认值

protected $configs = [
    'verified_request' => false,
    'base_uri' => 'https://api.shyplite.com',
    'order_uri' => 'order',
    'get_slip_uri' => 'getSlip',
    'availablity_uri' => 'getserviceability',
    'track_uri' => 'track',
    'manifest_uri' => 'getManifestPDF',
    'ordercancel_uri' => 'ordercancel'
];

您可以通过提供自己的配置键来覆盖默认配置，例如

$configs = [
    /* our configs */,
    'verified_request' => true, // Now you need to add certificate to make verified reques.
    'order_uri' => 'orders', // If later on shyplite decide to change their uri.
]

Laravel集成

让laravel了解您的插件。

configs/app.php

    return [

        // providers section.
      
        'providers' => [
            // ...,
            Adil\Shyplite\Laravel\ShypliteServiceProvider::class
        ],

        'aliases' => [

            // ...
            'Shyplite' => Adil\Shyplite\Laravel\Facade\Shyplite::class

        ]
      
    ];

    // use it in your app

Shyplite::setToken($yourtoken);
Shyplite::order()->add()->create();

现在在您的配置目录中添加shyplite特定设置。

configs/shyplite.php

return [
    'username'=> '<email-id>',
    'password' => '<password>',
    'app_id' => '<app-id>', // Your app's ID
    'seller_id' => '<seller-id>',   // Your seller ID
    'key' => '<key>'
];

这是非官方的php/laravel shyplite SDK。

感谢您的反馈。如果您发现任何问题，请不要忘记告诉我，无论是通过邮件还是创建GitHub问题。如果您喜欢我的努力，请不要忘记给我星星。

谢谢 :)