itlab-br/php-sigep

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

v1.0.0 2023-03-22 19:10 UTC

This package is not auto-updated.

Last update: 2024-09-20 00:21:07 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处理]
  • [新功能] 暂停邮递(也称为互动投递)
  • [新功能] 代理机构列表(用于点击和取件)
  • [新功能] 为点击和取件生成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"文件。这将注册loader。

常见问题

系统访问授权被拒绝

在将此项目用于生产之前,您需要向巴西邮政的商业代表申请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/php-sigep#35](https://github.com/stavarengo/php-sigep/issues/35)。一些用户在生产环境中遇到了与邮政Web服务的连接和认证问题,原因是PHP版本问题。为了解决这个问题,您可以选择使用更高版本的PHP(>=5.4)或下载邮政的WSDL并在您的服务器上使用它来建立连接。如果您选择下载WSDL,请按照以下步骤操作:

  1. 将此文件保存在您的本地环境:[https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl](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的缓存是禁用的。
此缓存存储了一些邮政Web服务的响应,可以在以后重用。除了提高请求的响应速度外,还可以防止用户在邮政服务器不稳定(相信我:它经常不稳定)时无法继续操作。

要启用缓存,请在创建PhpSigep配置时使用“cacheOptions”键。例如: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