lstonon/php-sigep

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

0.0.3 2020-02-19 23:30 UTC

This package is auto-updated.

Last update: 2024-09-10 04:09:58 UTC


README

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

PHP SIGEP - Correios

实现Correios SIGEP Web Service。

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

与Correios Web Service集成。查询价格和期限,打印标签和PLP等。这个API可以

  • 计算订单的价格和配送期限。
  • 获取订单的跟踪数据。
  • 检查两种地址之间是否允许某种服务类型(Sedex, PAC, ...)。
  • 生成并发送预列邮局单据(PLP)给Correios。
  • 生成新的邮局标签号。
  • 创建和/或验证标签的校验码的有效性(通过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"文件。这会将加载器注册。

常见问题

系统访问授权被拒绝

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

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

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

错误信息:解析 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服务的响应。除了增加请求响应速度外,还可以防止用户在邮政服务器不稳定时(相信我:它经常不稳定)无法继续操作。

要启用缓存,请使用"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