Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions purexiao/huoban-api-suite/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Contributing to Huoban Dify Plugin

Thank you for your interest in contributing to the Huoban Dify Plugin! This document provides guidelines and instructions for contributing.

## Code of Conduct

Please be respectful and considerate of others when contributing to this project.

## How to Contribute

### Reporting Issues
1. Check if the issue already exists in the issue tracker
2. Use the issue template if available
3. Provide detailed information:
- Steps to reproduce
- Expected behavior
- Actual behavior
- Screenshots if applicable
- Dify version and environment details

### Feature Requests
1. Explain the feature and its use case
2. Describe the expected behavior
3. Consider if it aligns with the plugin's scope

### Pull Requests
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## Development Setup

### Prerequisites
- Node.js 16+ (for testing)
- Dify development environment
- Huoban API access

### Local Development
1. Clone the repository
2. Install dependencies (if any)
3. Make your changes
4. Test locally with Dify

### Testing
- Test all API endpoints with sample data
- Verify error handling
- Ensure compatibility with Dify's plugin system
- Test with different Huoban workspace configurations

## Code Guidelines

### OpenAPI Specification
- Follow OpenAPI 3.1.0 standards
- Include comprehensive descriptions for all operations
- Provide clear examples
- Document all parameters and responses

### Manifest File
- Keep `manifest.json` up to date
- Include proper localization (en_US and zh_Hans)
- Update version numbers appropriately
- Maintain accurate metadata

### Documentation
- Update README.md with new features
- Include usage examples
- Document breaking changes
- Keep changelog updated

## Release Process

1. Update version in `manifest.json`
2. Update changelog in README.md
3. Create release notes
4. Tag the release
5. Submit to Dify Marketplace

## Questions?

Feel free to open an issue for questions about contributing or development.

## License

By contributing, you agree that your contributions will be licensed under the MIT License.
142 changes: 142 additions & 0 deletions purexiao/huoban-api-suite/DIFY_MARKETPLACE_CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
# Dify Marketplace 发布检查清单

## ✅ 已完成的工作

### 1. 核心文件结构
- [x] `manifest.json` - 完整的插件清单,包含所有必需字段
- [x] `openapi.json` - 完整的OpenAPI 3.1.0规范(从原始文件复制)
- [x] `README.md` - 详细的用户文档,包含安装、使用、示例
- [x] `PRIVACY.md` - 完整的隐私政策文档
- [x] `LICENSE` - MIT许可证文件
- [x] `huoban-plugin-dify.zip` - 插件压缩包

### 2. manifest.json 配置
- [x] schema_version: "1.0"
- [x] type: "tool"
- [x] namespace: "huoban"
- [x] 多语言名称 (en_US, zh_Hans)
- [x] 多语言描述 (en_US, zh_Hans)
- [x] 图标和背景颜色
- [x] 作者信息 (author, author_url)
- [x] 版本管理 (version: "1.2.0")
- [x] 标签和分类
- [x] 主页和仓库链接
- [x] 许可证信息
- [x] OpenAPI引用
- [x] API密钥认证配置
- [x] 隐私政策链接
- [x] 支持链接
- [x] 发布说明
- [x] 数据收集声明

### 3. OpenAPI 规范
- [x] 完整的9个API端点
- [x] 工作区管理 (get_workspace_list)
- [x] 表格操作 (get_table_list, get_table_config)
- [x] 数据CRUD (create_record, query_table_data, get_item_detail, update_record, delete_record)
- [x] 成员管理 (get_space_members)
- [x] API密钥认证 (Bearer token)
- [x] 详细的参数和响应模式
- [x] 错误处理定义

### 4. 文档和用户指南
- [x] 功能概述
- [x] 安装说明 (Dify Marketplace和手动安装)
- [x] 认证配置
- [x] 工具详细说明 (9个工具)
- [x] 使用示例和最佳实践
- [x] 字段ID映射系统说明
- [x] 错误处理和故障排除
- [x] 支持资源和联系方式
- [x] 更新日志
- [x] 贡献指南

### 5. 合规性和安全性
- [x] 隐私政策文档
- [x] 数据收集声明 (不收集用户数据)
- [x] HTTPS加密传输
- [x] API密钥安全存储
- [x] 无本地数据存储
- [x] GDPR合规性考虑

## 📋 Dify Marketplace 提交要求

### 必需文件
1. **插件包** (`huoban-plugin-dify.zip`) - ✅ 已创建
2. **插件清单** (`manifest.json`) - ✅ 已配置
3. **OpenAPI规范** (`openapi.json`) - ✅ 已包含
4. **README文档** (`README.md`) - ✅ 已完善
5. **许可证文件** (`LICENSE`) - ✅ MIT许可证
6. **隐私政策** (`PRIVACY.md`) - ✅ 已创建

### 技术要求
1. **API规范**: OpenAPI 3.1.0 - ✅ 符合
2. **认证类型**: API密钥 (Bearer token) - ✅ 已实现
3. **多语言支持**: en_US, zh_Hans - ✅ 已支持
4. **错误处理**: 完整的错误响应 - ✅ 已定义
5. **版本管理**: 语义化版本控制 - ✅ 1.2.0

### 内容要求
1. **清晰的插件描述** - ✅ 中英文描述
2. **详细的使用说明** - ✅ 完整的文档
3. **安装和配置指南** - ✅ 逐步说明
4. **示例和用例** - ✅ 实际工作流示例
5. **支持信息** - ✅ 多种支持渠道

## 🚀 发布准备状态

### 插件功能完整性
- **核心功能**: 9个完整的API工具
- **用户体验**: 逐步工作流设计
- **错误处理**: 全面的错误反馈
- **安全性**: API密钥加密传输
- **性能**: 优化的API调用

### 文档完整性
- **用户文档**: 完整的README
- **开发者文档**: OpenAPI规范
- **合规文档**: 隐私政策
- **支持文档**: 故障排除指南

### 市场适应性
- **目标用户**: 企业用户、开发者、AI工程师
- **使用场景**: CRM、项目管理、数据管理、自动化
- **竞争优势**: 完整的伙伴云集成、AI自主探索能力
- **定价策略**: 免费开源插件

## 📝 提交说明

### 提交到Dify Marketplace
1. 访问 Dify Marketplace 提交页面
2. 上传 `huoban-plugin-dify.zip` 文件
3. 填写插件信息(大部分信息已包含在manifest.json中)
4. 提供联系信息用于审核
5. 提交审核

### 审核预期
1. **技术审核**: 验证OpenAPI规范、认证配置
2. **内容审核**: 检查文档完整性、隐私政策
3. **功能审核**: 测试API功能、错误处理
4. **安全审核**: 验证数据安全、合规性

### 发布后维护
1. **版本更新**: 通过GitHub发布新版本
2. **问题反馈**: 通过GitHub Issues收集反馈
3. **用户支持**: 提供文档和社区支持
4. **功能扩展**: 根据用户需求添加新功能

## 🔗 相关文件
- `huoban-plugin-dify.zip` - 插件包
- `manifest.json` - 插件清单
- `README.md` - 用户文档
- `PRIVACY.md` - 隐私政策
- `openapi.json` - API规范
- `LICENSE` - 许可证

---

**插件状态**: ✅ 准备提交到 Dify Marketplace

**最后更新**: 2025年12月23日
**版本**: 1.2.0
**作者**: Zheng Xiao
21 changes: 21 additions & 0 deletions purexiao/huoban-api-suite/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 purexiao

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
113 changes: 113 additions & 0 deletions purexiao/huoban-api-suite/PRIVACY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# 伙伴云智能SDR插件隐私政策

**生效日期**:2025年12月23日

## 1. 数据收集声明

伙伴云智能SDR插件(以下简称"本插件")**不直接收集、存储或处理任何用户个人数据**。本插件作为Dify平台与伙伴云API之间的桥梁,仅负责传输用户请求到伙伴云服务。

## 2. 数据传输说明

### 2.1 传输的数据类型
当用户使用本插件时,以下数据可能通过本插件传输到伙伴云服务:

- **API密钥**:用于身份验证的Bearer Token
- **查询参数**:用户在工作流程中输入的搜索条件、筛选参数等
- **操作指令**:创建、读取、更新、删除数据的请求内容
- **业务数据**:工作区、表格、记录等业务相关信息

### 2.2 数据流向
```
用户输入 → Dify平台 → 本插件 → 伙伴云API → 返回结果
```

所有数据传输都通过HTTPS加密通道进行。

## 3. 第三方服务数据收集

本插件集成的**伙伴云服务**可能会收集和处理数据。用户应参考伙伴云的隐私政策:

- [伙伴云隐私政策](https://www.huoban.com/privacy)

根据伙伴云隐私政策,他们可能收集以下类型的数据:

### 3.1 直接标识符(如适用)
- 姓名
- 电子邮件地址
- 电话号码
- 公司信息

### 3.2 间接标识符(如适用)
- IP地址
- 设备信息
- 使用日志
- 操作时间戳

### 3.3 业务数据
- 工作区信息
- 表格结构
- 数据记录
- 操作历史

## 4. 数据使用目的

通过本插件传输的数据仅用于:

1. **身份验证**:验证用户对伙伴云服务的访问权限
2. **API调用**:执行用户请求的操作(查询、创建、更新、删除)
3. **结果返回**:将操作结果返回给Dify平台和用户

## 5. 数据存储

本插件**不存储任何用户数据**。所有数据:
- 仅在传输过程中临时存在
- 操作完成后立即释放
- 不在本地或服务器持久化存储

## 6. 数据共享

本插件**不与任何第三方共享数据**,除了:
- 必要的API调用传输到伙伴云服务
- Dify平台用于显示结果

## 7. 用户控制

用户可以通过以下方式控制数据:

1. **API密钥管理**:用户可以随时在伙伴云平台更新或撤销API密钥
2. **操作日志**:用户可以在伙伴云平台查看操作历史
3. **数据删除**:用户可以直接在伙伴云平台删除业务数据

## 8. 安全措施

本插件实施以下安全措施:

1. **加密传输**:所有API调用都使用HTTPS加密
2. **无本地存储**:不在插件中存储敏感信息
3. **最小权限**:仅请求执行操作所需的最小数据

## 9. 儿童隐私

本插件不面向13岁以下儿童设计,也不故意收集儿童个人信息。

## 10. 隐私政策更新

本隐私政策可能会不时更新。重大变更将在插件更新时通知用户。

## 11. 联系方式

如有关于本隐私政策的问题,请联系:

- **插件开发者**:Zheng Xiao
- **支持渠道**:[GitHub Issues](https://github.com/your-repo/huoban-plugin-dify/issues)
- **伙伴云支持**:[support@huoban.com](mailto:support@huoban.com)

## 12. 法律遵从

本插件遵守适用的数据保护法律和法规,包括但不限于:
- 中华人民共和国个人信息保护法
- 通用数据保护条例(GDPR,如适用)

---

**重要提示**:本插件仅作为工具使用,用户应对通过本插件传输的数据负责。建议用户定期审查伙伴云的隐私政策和服务条款。
Loading