README

Pass Delivery：Api包库

关于API

请参阅集成页面了解Pass Delivery API的描述。

文档

请参阅文档了解Pass Delivery API的文档。

安装

composer require pass-qa/delivery

可选

服务提供商将自动注册。或者您也可以在config/app.php文件中手动添加服务提供商

'providers' => [
    // ...
    pass-qa\delivery\src\providers\PassDeliveryApiServiceProvider::class,
];

发布文件

您应该使用以下命令发布config/passdelivery.php配置文件

php artisan vendor:publish --provider="PassQa\Delivery\Providers\PassDeliveryApiServiceProvider"

之后，您应该在配置文件中放置您的api_key，您还可以将test_mode设置为true以进行开发，或设置为false以进行生产。

使用说明

第一步

您必须生成一个令牌。请参阅此页面了解如何创建令牌。

创建新对象

use PassQa\Delivery\PassOrder;

$order = new PassOrder()

在创建订单之前计算订单价格

使用起始地址和目的地地址请求报价以获取订单的确切配送费用。

此端点以{纬度，经度}坐标对的形式检索计算信息。

$priceData = [
        "pickup" =>[
            "lat" =>"25.275047",
            "long" => "51.535141"
        ],
        "dropoffs" => [
            [
                "lat" =>"25.277007", 
                "long" => "51.530034"
            ],
                 [
                "lat" =>"25.277005", 
                "long" => "51.530039"
                 ],
                 [
                "lat" =>"25.277001", 
                "long" => "51.530030"
                 ]
        ]
    ];

使用对象

use PassQa\Delivery\PassOrder;

$order = new PassOrder();

$response = $order->Price($priceData);

或使用外观

use PassQa\Delivery\Facades\PassOrder;

$response = PassOrder::Price($priceData);

创建订单

一旦您计算了订单的价格，您就可以使用此端点来创建新订单。

$orderData = [
        "addresses"=> [
            "pickup" =>[
                "lat"=> "25.275047",
                "long"=> "51.535141",
                "name"=> "majva",
                "phone"=> "+97466661234",
                "address"=> "this street",
                "description"=> "it is a sample description"
            ],
            "dropoffs" => [
                [
                    "lat"=> "25.277007",
                    "long"=> "51.530034",
                    "name"=> "majva",
                    "phone"=> "+97466661234",
                    "address"=> "that street",
                    "description"=> "it is a sample description"
                ],
                [
                    "lat"=> "25.277007",
                    "long"=> "51.530034",
                    "name"=> "majva",
                    "phone"=> "+97466661234",
                    "address"=> "other street",
                    "description"=> "it is a sample description"
                ],
                [
                    "lat"=> "25.277007",
                    "long"=> "51.530034",
                    "name"=> "majva",
                    "phone"=> "+97466661234",
                    "address"=> "another street",
                    "description"=> "it is a sample description"
                ]
            ]
        ]
    ];

使用对象

use PassQa\Delivery\PassOrder;

$order = new PassOrder();

$response = $order->Create($orderData);

或使用外观

use PassQa\Delivery\Facades\PassOrder;

$response = PassOrder::Create($orderData);

跟踪您的订单司机

一旦您成功创建订单，您将能够实时地图上观察Pass司机。

随着司机的移动，司机的位置和订单状态将会变化。

“订单ID”可在创建API响应中找到

使用对象

use PassQa\Delivery\PassOrder;

$order = new PassOrder();

$response = $order->Tracking('order id');

或使用外观

use PassQa\Delivery\Facades\PassOrder;

$response = PassOrder::Tracking('order id');

获取订单详情

调用以下端点以获取订单详情。

订单详情包括

1. 接送详情包括描述
2. 司机详情包括姓名、电话号码、头像和车辆信息
3. 订单价格和支付详情
4. 订单状态
5. 分享URL。这是一个工具，您可以使用它与您的客户分享链接以查看司机的实时状态。

“订单ID”可在创建API响应中找到

使用对象

use PassQa\Delivery\PassOrder;

$order = new PassOrder();

$response = $order->Detail('order id');

或使用外观

use PassQa\Delivery\Facades\PassOrder;

$response = PassOrder::Detail('order id');

取消订单

您可以在快递员到达之前（在取货状态之前）取消任何订单

“订单ID”可在创建API响应中找到

使用对象

use PassQa\Delivery\PassOrder;

$order = new PassOrder();

$response = $order->Cancel('order id');

或使用外观

use PassQa\Delivery\Facades\PassOrder;

$response = PassOrder::Cancel('order id');

订单列表

您提交的所有订单的列表

使用对象

use PassQa\Delivery\PassOrder;

$order = new PassOrder();

$response = $order->List();

或使用外观

use PassQa\Delivery\Facades\PassOrder;

$response = PassOrder::List();

安全

如果您发现任何安全问题，请通过security@pass.qa发送电子邮件，而不是使用问题跟踪器。

致谢

• Mostafa
• Majva

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。