jonas-anastacio/php-sigep

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

1.0.3 2021-01-29 16:47 UTC

This package is auto-updated.

Last update: 2024-09-29 05:48:42 UTC


README

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

PHP SIGEP - 邮局

邮局 SIGEP Web Service 实现。

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

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

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

常见问题

系统访问授权拒绝

在将此项目用于生产之前,需要向邮局商务代表申请 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 一些用户在生产环境中使用 PHP 版本遇到了与邮政 WebService 的连接和认证问题。为了解决这个问题,您可以选择使用更高版本的 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 的响应,这些响应可以稍后重用。除了提高请求的响应速度外,还可以防止用户在邮政服务器不稳定时(相信我:它经常不稳定)无法继续操作。

要启用缓存,请在创建 PhpSigep 配置时使用 "cacheOptions" 键。例如:php new \PhpSigep\Config( array( 'cacheOptions' => array( 'storageOptions' => array( 'enabled' => true, 'ttl' => 60*60*24*7,// 一周 ), ), ... ), ); array 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