Firebed Aade MyData 项目安装与配置指南

项目概述

Firebed Aade MyData 是一个用于与希腊财税机构 (AADE) myDATA 系统交互的 PHP 库。它提供了简单易用的接口，帮助开发者实现电子账单、收支分类等财税数据的传输与管理。

环境要求

在开始安装前，请确保您的系统满足以下最低要求：

• PHP 8.1 或更高版本
• DOM 扩展 (ext-dom)
• Guzzle HTTP 客户端 7.0.1 或更高版本

安装方式

推荐方式：通过 Composer 安装

这是最简单且推荐的安装方式，只需执行以下命令：

composer require firebed/aade-mydata

Composer 会自动处理所有依赖关系，包括 Guzzle HTTP 客户端等必要组件。

手动安装（不推荐）

虽然不推荐，但在特殊情况下您可以选择手动安装：

1. 下载项目源代码
2. 手动包含所有必需文件
3. 使用 spl_autoload_register 函数注册自动加载器

手动安装需要您自行管理所有依赖关系，可能会遇到版本冲突等问题。

配置准备

在使用该库前，您需要从希腊财税机构获取以下凭证：

1. 用户ID (User ID)：唯一标识您的账户
2. 订阅密钥 (Subscription Key)：用于API身份验证

这些凭证可以通过注册 myDATA REST API 服务获得。

初始化配置

获得凭证后，您需要初始化库配置：

基本配置方式

use Firebed\AadeMyData\Http\MyDataRequest;

// 设置环境：'dev'为测试环境，'prod'为生产环境
$env = "dev"; 

// 您的凭证
$user_id = "your-user-id";
$subscription_key = "your-subscription-key";

// 配置环境和凭证
MyDataRequest::setEnvironment($env);
MyDataRequest::setCredentials($user_id, $subscription_key);

简化配置方式

也可以使用 init 方法一次性完成所有配置：

MyDataRequest::init($user_id, $subscription_key, $env);

开发环境特殊配置

在开发环境中，如果未使用 HTTPS，可能需要禁用客户端验证：

MyDataRequest::verifyClient(false);

功能概览

该库支持 myDATA API 的所有主要功能：

1. 账单相关操作

   • 发送账单 (SendInvoices)
   • 取消账单 (CancelInvoice)
   • 请求账单 (RequestDocs)
   • 请求已传输账单 (RequestTransmittedDocs)

2. 分类信息

   • 发送收入分类 (SendIncomeClassification)
   • 发送支出分类 (SendExpensesClassification)

3. 支付方式

   • 发送支付方式 (SendPaymentsMethod)

4. 财务数据查询

   • 请求我的收入 (RequestMyIncome)
   • 请求我的支出 (RequestMyExpenses)
   • 请求增值税信息 (RequestVatInfo)

XSD 架构文件

项目包含完整的 XSD 架构文件，用于验证数据格式：

• 账单文档 (InvoicesDoc-v1.0.9.xsd)
• 收入和支出分类 (incomeClassification/expensesClassification-v1.0.9.xsd)
• 支付方式 (paymentMethods-v1.0.9.xsd)
• 各种响应格式 (response/RequestVatInfoResponse-v1.0.9.xsd 等)

这些文件对于理解数据结构和进行本地验证非常有用。

最佳实践建议

1. 环境管理：始终在开发环境中测试后再部署到生产环境
2. 错误处理：实现适当的异常捕获和处理机制
3. 日志记录：记录所有API请求和响应，便于调试和审计
4. 凭证安全：不要将凭证硬编码在代码中，使用环境变量或安全的配置管理系统

常见问题

Q: 如何判断应该使用开发环境还是生产环境？ A: 开发环境用于测试和集成，生产环境用于实际业务。在开发初期和测试阶段使用开发环境。

Q: 为什么需要禁用客户端验证？ A: 仅在开发环境中且未使用HTTPS时才需要禁用，生产环境中应始终保持启用。

Q: 如何获取测试凭证？ A: 可以通过希腊财税机构提供的测试环境注册流程获取测试用的用户ID和订阅密钥。

通过本指南，您应该能够顺利完成 Firebed Aade MyData 的安装和基本配置。如需更详细的功能使用说明，请参考各功能模块的专门文档。