pedroquezado/braspress

Braspress 集成 API 客户端。

1.0 2024-08-12 21:49 UTC

This package is auto-updated.

Last update: 2024-09-13 13:22:29 UTC


README

Maintainer Source Code PHP from Packagist Latest Version Software License Build Quality Score Total Downloads

这个 PHP 客户端库允许您与 Braspress API 交互,以实现货运报价和跟踪服务。该库提供了一种方便的方式访问 Braspress 的服务,包括计算运费和跟踪运输,支持陆路和空运模式。

安装

要安装此库,您可以使用 Composer

composer require pedroquezado/braspress

用法

初始化

要开始使用 Braspress 客户端,首先,使用您的凭据初始化 BraspressCliente 类。

require 'vendor/autoload.php';

use PedroQuezado\Code\Braspress\BraspressCliente;

$cliente = new BraspressCliente('your_braspress_username', 'your_braspress_password');

添加产品

在执行货运报价之前,您需要将产品(体积)添加到客户端

$cliente->inserirProduto(5.5, [
    'comprimento' => 0.67,
    'largura' => 0.67,
    'altura' => 0.46
]);

$cliente->inserirProduto(2.3, [
    'comprimento' => 0.45,
    'largura' => 0.30,
    'altura' => 0.20
]);

每次调用 inserirProduto 都会将一个新体积添加到包括在货运报价中的产品列表中。

执行货运报价

您可以为任意一种或两种模式(陆路和空运)执行货运报价

try {
    $dadosCotacao = [
        'cnpjRemetente' => '12345678000100',
        'cnpjDestinatario' => '09876543210001',
        'tipoFrete' => '1', // 1 for CIF, 2 for FOB
        'cepOrigem' => '12345000',
        'cepDestino' => '54321000',
        'vlrMercadoria' => 500.00
    ];

    $resultados = $cliente->realizarCotacao($dadosCotacao, 'json', ['R', 'A']);

    print_r($resultados);
} catch (\PedroQuezado\Code\Braspress\BraspressClienteException $e) {
    echo 'Erro: ' . $e->getMessage();
}

realizarCotacao 方法执行指定模式的货运报价(R 表示陆路,A 表示空运,或两者都是)。结果以关联数组返回,按模式分隔。

示例响应

Array
(
    [Rodoviario] => Array
        (
            [id] => 274407950
            [prazo] => 5
            [totalFrete] => 73.02
        )

    [Aereo] => Array
        (
            [id] => 274408248
            [prazo] => 2
            [totalFrete] => 631.38
        )
)

错误处理

错误通过异常处理。如果 API 请求期间发生错误,则会抛出 BraspressClienteException

try {
    // API call
} catch (\PedroQuezado\Code\Braspress\BraspressClienteException $e) {
    echo "Erro: " . $e->getMessage();
}

高级功能

设置模式

您可以在调用 realizarCotacao 方法时设置货运模式。传递包含 'R' 和/或 'A' 的数组以获取陆路和/或空运模式的报价。

处理响应

realizarCotacao 方法返回关联数组作为结果。键 RodoviarioAereo 包含相应的结果。

文档

有关更多信息,请参阅官方 Braspress API 文档。

许可证

此库为开源,可在 MIT 许可证下使用。有关更多信息,请参阅 LICENSE 文件。

贡献

欢迎贡献!请提交拉取请求或打开一个问题来为此项目做出贡献。