frete-click/php-sigep

与巴西邮政Web Service集成。生成标签,查询价格和期限,打印标签和PLP等。

v1.0.2 2021-05-11 14:17 UTC

This package is not auto-updated.

Last update: 2024-10-01 15:33:37 UTC


README

帮助项目成长。发送代码源或项目文档的pull request。

PHP SIGEP - 巴西邮政

实施巴西邮政SIGEP Web Service。

在我们的页面上查看在线演示、示例和文档.

与巴西邮政Web Service集成。查询价格和期限,打印标签和PLP等。此API可以

  • 计算订单的送货价格和期限。
  • 获取订单的跟踪数据。
  • 检查两种地址之间是否允许某种服务类型(Sedex、PAC等)。
  • 生成并发送预寄递单据(PLP)的XML到巴西邮政。
  • 生成新的邮递标签号。
  • 创建和/或验证标签校验码的有效性(通过Web Service或非Web Service)。
  • 以PDF格式生成PLP报告。
  • 以PDF格式生成邮递标签。
  • 为每种服务类型(每种服务的标志)生成PDF格式盖章。
  • 获取投递后的PLP数据[由Sara处理]
  • [新] 暂停投递(也称为交互式投递)
  • [新] 机构列表(用于Clique e Retire)
  • [新] 为Clique e Retire生成PDF格式邮递标签

要求

  • PHP >= 5.4.0
  • 如果您需要打印标签和报告,请下载FPDF 1.7 www.fpdf.org
    在尝试打印报告之前,不要忘记配置FPDF以自动加载。

使用Composer安装(推荐)

  • 我们不通过标签控制版本,但只有当代码稳定时,master分支才会更新。因此,最新稳定版本总是master分支。

将以下行添加到您的composer.json文件中: "stavarengo/php-sigep": "dev-master"
"stavarengo/php-sigep-fpdf": "dev-master"

然后通过命令行执行composer update

手动安装

  • 我们不通过标签控制版本,但只有当代码稳定时,master分支才会更新。因此,最新稳定版本总是master分支。

  • 下载最新版本。

  • 要使用php-sigep类,您只需加载"php-sigep/src/PhpSigep/Bootstrap.php"文件。这将注册加载器。

常见问题

系统访问授权拒绝

在将此项目用于生产模式之前,您需要向巴西邮政的商业代表申请Web Service的授权和密码。

我在使用测试环境时遇到问题

如果您在尝试使用测试环境时收到以下消息,这意味着巴西邮政的Web Service暂时不可用。创建issue是没有用的,最好的办法是等待或尝试联系巴西邮政的技术支持。

错误信息:解析 WSDL:无法从 'https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl' 加载:无法加载外部实体 "https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsd"

PHP 5.3 的问题

此问题已在此处报告:stavarengo#35 一些用户在生产环境中遇到与邮政 WebService 连接和身份验证问题,原因是 PHP 版本。要解决这个问题,您可以或使用更高版本的 PHP (>=5.4) 或下载邮政 WSDL 并在您的服务器上使用它进行连接。如果您选择下载 WSDL,请按照以下步骤操作:

  1. 将此文件保存在您的本地环境中 https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl
  2. 更改您的生产环境配置,以指向您下载的文件。以下是一个示例。
$config = new \PhpSigep\Config();
$config->setEnv(\PhpSigep\Config::ENV_PRODUCTION);
$config->setWsdlAtendeCliente('CAMINHO-DO-SEU-ARQUIVO-LOCAL');
\PhpSigep\Bootstrap::start($config);

注意:在 Wamp、Xammp 等本地服务器上无法工作。

功能

缓存

PhpSigep 的缓存组件灵感来源于 Zend Framework 的缓存组件

默认情况下,PhpSigep 的缓存是禁用的。
此缓存存储了一些可以稍后重用的邮政 WebService 响应。除了提高请求响应速度外,还可以防止用户在邮政服务器不稳定时(相信我:它经常不稳定)无法继续操作。

要启用缓存,请使用 "cacheOptions" 键创建 PhpSigep 配置。例如:php new \PhpSigep\Config( array( 'cacheOptions' => array( 'storageOptions' => array( 'enabled' => true, 'ttl' => 60*60*24*7,// 一周 ), ), ... ), ); storageOptions 数组中,您可以使用 PhpSigep\Cache\Storage\Adapter\AdapterOptions 类的任何属性名称。

贡献

要运行测试套件,请通过命令行执行 ./vendor/bin/phpunit

  1. 创建分叉
  2. 创建功能分支(git checkout -b nova-funcionalidade
  3. 提交您的更改(git commit -am '添加新功能'
  4. 将分支推送到远程(git push origin nova-funcionalidade
  5. 创建新的 Pull Request