eSocial 开源项目指南

eSocial 开源项目指南

esocial O esocial é o projeto que reune as iniciativas do TST para atender às necessidades do sistema eSocial do Governo Federal. 项目地址: https://gitcode.com/gh_mirrors/es/esocial

---

1. 项目介绍

eSocial 是由TST Labs发起的一个开源项目，旨在满足巴西联邦政府eSocial系统的特定需求。该项目集合了TST的各种努力，以支持不同组织（无论是公共还是私人）适应eSocial系统的要求。核心组件esocial-jt-service接收来自源头系统的JSON数据，转换成eSocial事件，创建并签名XML文件，然后将其提交给eSocial-Gov平台，并后续查询处理结果及任何错误信息。

• 技术栈: 主要基于Java 8与Spring Boot框架构建。
• 许可: 使用BSD-3-Clause许可证。

2. 项目快速启动

环境准备

• Git
• Docker与Docker Compose
• ICP-Brasil A1有效数字证书
• 可选：Postman用于API测试

步骤

# 克隆项目
git clone https://github.com/tst-labs/esocial.git
cd esocial

# 复制并配置证书与应用设置
cp <本地证书路径>/esocial.pfx config/esocial.pfx
cp config/application.properties.example config/application.properties
# 编辑application.properties配置您的环境信息，如CNPJ、环境设置等

# 启动应用与数据库
docker-compose up

确认应用与eSocial-Gov的连接成功，通过访问以下URL检查应用健康状态：

• http://localhost:8080/esocial-jt-service/actuator/health
• http://localhost:8080/esocial-jt-service/actuator/esocialhealth

发送首个事件

1. 复制示例JSON文件并修改为您机构的信息。
2. 使用POST请求发送到http://localhost:8080/esocial-jt-service/ocorrencias，可以使用curl或Postman。

3. 应用案例和最佳实践

• 集成HR系统: 示例中，组织可以通过自定义连接器从现有的人力资源系统中提取数据，转换为JSON格式，然后利用esocial-jt-service处理和提交至eSocial-Gov。
• 持续数据流: 建议定期自动化数据推送过程，确保实时性，并减少手动干预的需要。
• 安全证书管理: 确保数字证书始终处于有效状态，并且安全存储。

4. 典型生态项目

在企业级场景中，eSocial常与其他企业服务结合使用，例如：

• ETL工具集成: 利用Apache NiFi或Talend与eSocial项目配合，自动收集和预处理数据。
• 微服务架构: 在大型系统中，将eSocial-jt-service作为处理eSocial交互的独立微服务运行，与其他业务服务解耦。
• 监控与报警: 结合Prometheus和Grafana监控应用健康状态，对关键操作设置报警机制。

---

此教程提供了一个基础框架来引导开发者快速上手和部署eSocial项目，并给出了在实际企业环境中应用该系统的一些建议。记得根据具体需求调整配置和流程。

esocial O esocial é o projeto que reune as iniciativas do TST para atender às necessidades do sistema eSocial do Governo Federal. 项目地址: https://gitcode.com/gh_mirrors/es/esocial