betalabs/php-sigep

与邮局Web服务集成。生成标签、查询价格和期限、打印标签和PLP等。

0.0.5 2018-06-07 21:26 UTC

This package is auto-updated.

Last update: 2024-08-26 17:19:04 UTC


README

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

PHP SIGEP - 邮局

邮局SIGEP Web服务的实现。

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

与邮局Web服务集成。查询价格和期限、打印标签和PLP等。此API可以

  • 计算订单的价格和交付期限。
  • 获取订单的跟踪数据。
  • 检查两个地址之间是否允许服务类型(Sedex、PAC等)。
  • 生成并发送预寄递单据(PLP)到邮局。
  • 生成新的邮局标签号。
  • 创建和/或验证标签校验位的有效性(通过Web服务或不通过)。
  • 以PDF格式生成PLP报告。
  • 以PDF格式生成邮局标签。
  • 以PDF格式生成每种服务类型的印章(每种服务类型的标志)。
  • 获取邮递后的PLP数据。
  • [新功能] 暂停邮递(也称为交互式交付)
  • [新功能] 代理列表(用于点击取件)
  • [新功能] 生成点击取件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服务的授权和密码。

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

如果您在尝试使用测试环境时收到以下消息,这意味着邮局Web服务暂时不可用。创建 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 一些用户在生产环境中使用PHP版本与邮局Web服务连接和认证时遇到了问题。为了解决这个问题,您可以选择使用更高版本的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的缓存是禁用的。
此缓存存储了一些邮局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. 进行Fork
  2. 为功能创建分支(git checkout -b nova-funcionalidade
  3. 提交您的修改(git commit -am '添加新功能'
  4. 将分支推送到远程(git push origin nova-funcionalidade
  5. 创建一个新的Pull Request