README

现在在您的电子商务项目中获取Melhor Envio的报价服务变得更简单了。

索引

安装
初始配置
使用示例
更多示例
测试
变更日志
贡献
安全
致谢
许可证

依赖

require

PHP >= 5.6
Ext-json = *
Guzzlehttp/guzzle >= 6.5

require-dev

phpunit/phpunit >= 5

安装

您可以通过运行以下命令通过composer安装此包：

composer require melhorenvio/shipment-sdk-php

初始配置

创建的Shipment实例允许您通过参数传递您的token和您将工作的环境，这样您就有现成的认证了。

请注意，只有当token的创建属于与参数中传入的环境相同的参数时，它才是有效的。

如果您还没有完成授权流程，Melhor Envio还有一个包可以简化此过程。您可以点击此处访问它。

require "vendor/autoload.php";

use MelhorEnvio\Shipment;
use MelhorEnvio\Resources\Shipment\Package;
use MelhorEnvio\Enums\Service;
use MelhorEnvio\Enums\Environment;

// Create Shipment Instance
$shipment = new Shipment('your-token', Environment::PRODUCTION);

创建计算器实例

在这个例子中，您将在代码中创建一个计算器实例。

// Create Calculator Instance
    $calculator = $shipment->calculator();

构建计算器的有效载荷

添加起点和终点的CEP

在这个部分，您必须分别定义起点和终点的CEP。

//Builds calculator payload
$calculator->postalCode('01010010', '20271130');

产品

添加用于报价的产品

在这个部分，您将定义用于报价的产品，应传递的参数信息如下

高度
宽度
长度
重量
保险价值
数量

请注意，默认保险价值应该是产品价值。

$calculator->addProducts(
        new Product(uniqid(), 40, 30, 50, 10.00, 100.0, 1),
        new Product(uniqid(), 5, 1, 10, 0.1, 50.0, 1)
    );

包裹

添加用于报价的包裹

在这个部分，您将定义用于报价的包裹，应传递的参数信息如下

高度
宽度
长度
重量
保险价值

尺寸总是以厘米为单位传递，重量以千克为单位。这是Melhor Envio操作的单位。

请注意，默认保险价值应该是产品价值（以雷亚尔为单位）。

 $calculator->addPackages(
        new Package(12, 4, 17, 0.1, 6.0),
        new Package(12, 4, 17, 0.1, 6.0),
        new Package(12, 4, 17, 0.1, 6.0),
        new Package(12, 4, 17, 0.1, 6.0)
    );

重要的是要强调，PACOTES和PRODUTOS方法不能同时使用，只能使用其中一个或另一个。

添加运输公司的服务

如果您想自定义，在这个部分将选择您想使用的运输公司的服务。今天，在Melhor Envio中，有

Correios
Jadlog
Via Brasil
Azul Cargo
Latam Cargo

$calculator->addServices(
        Service::CORREIOS_PAC, 
        Service::CORREIOS_SEDEX,
        Service::CORREIOS_MINI,
        Service::JADLOG_PACKAGE, 
        Service::JADLOG_COM, 
        Service::AZULCARGO_AMANHA,
        Service::AZULCARGO_ECOMMERCE,
        Service::LATAMCARGO_JUNTOS,
        Service::VIABRASIL_RODOVIARIO
    );

添加附加服务

如果您想自定义，可以在报价中配置一些附加服务，它们是

Mão própria
Aviso de recebimento
Coleta

请注意，添加这些服务可能会在报价时增加价格。

$calculator->setOwnHand();
$calculator->setReceipt();
$calculator->setCollect();

返回报价信息

这里您将返回构建的有效载荷信息。

$quotations = $calculator->calculate();

测试

在项目中，您将找到一些基于单元测试的测试文档

您可以在应用程序中使用以下命令

composer test

或命令

vendor/bin/phpunit tests

变更日志

请参阅变更日志获取最新的更改信息。

贡献

请参阅贡献指南获取更多详细信息。

安全

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

致谢

许可证

Melhor Envio。请参阅许可文件获取更多信息。

kayooliveira / shipment-sdk-php

维护者

详细信息