fernandoebert/melhorenvio

为php版本提供Melhor envio API解决方案

1.0 2021-09-06 14:17 UTC

This package is auto-updated.

Last update: 2024-09-15 18:52:11 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

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

目录

依赖

require

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

require-dev

  • phpunit/phpunit >= 5

安装

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

composer require fernandoebert/melhorenvio

初始配置

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

请记住,只有在创建token的环境与传递给参数的环境相同时才有效。

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
    );

添加额外服务

如果您想自定义,可以在报价中配置一些额外服务,它们是

  • 自取
  • 收货通知
  • 收集

请记住,添加这些服务可能会在报价时增加价格。

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

返回报价信息

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

$quotations = $calculator->calculate();

更多示例

在这里,您可以访问更多实现示例

测试

在项目内部,您将找到一些基于单元测试的测试文档

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

composer test

以及以下命令

vendor/bin/phpunit tests 

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

贡献

有关更多详细信息,请参阅 CONTRIBUTING

安全

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

鸣谢

许可证

Melhor Envio。有关更多信息,请参阅许可文件