README

API文档

https://borzodelivery.com/br/business-api/doc

需求

PHP >= 7.4

开始使用

安装
认证
[可用方法](#可用方法)
- [订单价格计算](#订单价格计算)
[执行单元测试](#执行单元测试)
异常

安装

使用Composer安装包

composer require lojametastore/borzodelivery-sdk-php

认证

以下示例展示了如何创建一个带有认证的实例

use BorzoDelivery\Api\Borzo;

$borzo = new Borzo('SECRET_AUTH_TOKEN');

可用方法

订单价格计算

订单的计算价格方法用于模拟一个或多个点之间的配送价格。所有可用的请求参数可以在https://borzodelivery.com/br/business-api/doc#calculate-order中查看

$points = new Points();

$points->add([
    "address"               => 'Address 1',
    "contact_person"        => new ContactPerson([
        'name'  => 'Jem',
        'phone' => '+1-202-555-0171'
    ]),
    "is_order_payment_here" => true,
]);

$points->add([
    "address"               =>'Address 2',
    "contact_person"        => new ContactPerson([
        'name'  => 'Polly',
        'phone' => '+1-202-555-0172'
    ]),
    "client_order_id"       => $this->faker()->randomDigit(),
    "is_order_payment_here" => false,
]);

$orderRequest = new Order([
    "type"             => Order::ORDER_TYPE_STANDARD,
    "matter"           => 'Buys',
    "vehicle_type_id"  => Order::VEHICLE_TYPE_MOTORBIKE,
    "total_weight_kg"  => 5,
    "insurance_amount" => 150,
    "points"           => $points,
]);

$borzo->priceCalculation($order);

执行单元测试

要执行单元测试，您需要设置一个名为SECRET_AUTH_TOKEN的环境变量

异常

当请求返回任何失败时，将触发一个具有类BorzoDelivery\Exceptions\ApiException的异常。您可以使用以下示例简单地捕获这个异常

use BorzoDelivery\Exceptions\ApiException;

try{

    $borzo->priceCalculation($order);

} catch (ApiException $apiException) {
    $errors = $apiException->getErrors();
    $warnings = $apiException->getWarnings();
    $parametersWarnings = $apiException->getparametersWarnings();
}

lojametastore / borzodelivery-php

维护者

详情