yhanndaniel/php-sigep

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

0.0.1 2017-03-30 22:52 UTC

This package is auto-updated.

Last update: 2024-09-12 19:12:14 UTC


README

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

PHP SIGEP - 巴西邮政

实现巴西邮政SIGEP Web服务的接口。

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

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

  • 计算订单的价格和交货期限。
  • 获取订单的跟踪数据。
  • 检查服务类型(Sedex、PAC等)是否允许在两个地址之间。
  • 生成并发送预清单邮局列表(PLP)到巴西邮政。
  • 生成新的邮局标签号码。
  • 创建和/或验证标签验证码的有效性(通过Web服务或非Web服务)。
  • 以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服务的授权和密码。

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

如果您在尝试使用测试环境时收到以下消息,这意味着邮政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 版本问题遇到了与 Correios WebService 的连接和认证问题。为了解决这个问题,您可以选择使用更高版本的 PHP (>=5.4) 或者下载 Correios 的 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 的缓存是禁用的。
此缓存存储了一些 Correios WebService 的响应,这些响应可以在以后重复使用。除了提高请求响应速度外,还可以避免当 Correios 服务器不稳定(相信我:它经常不稳定)时,用户无法继续操作。

要启用缓存,请在创建 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