🚀 连接器使用说明
本项目是一个与ConnectWise平台集成的连接器，能够实现自动化数据同步、智能查询优化等功能，帮助用户高效地与ConnectWise平台进行交互。
🚀 快速开始
要将此连接器与ConnectWise平台集成，请按照以下步骤操作：
📦 安装指南
安装必要的软件包
确保您已安装Python 3.x版本，并运行以下命令安装所需依赖项：
pip install requests jsonschema
设置环境变量
在系统环境中设置以下变量：
CONNECTWISE_COMPANY_ID=your_company_id
CONNECTWISE_PUBLIC_KEY=your_public_key
CONNECTWISE_PRIVATE_KEY=your_private_key
CONNECTWISE_AUTH_PREFIX=your_auth_prefix
配置数据库连接
确保api_gateway.db文件存在于项目目录中。如果文件不存在，请运行以下命令生成初始数据库：
python build_database.py
启动服务
在终端或命令提示符下，运行以下命令启动连接器：
python api_gateway.py
访问接口
- 打开浏览器并导航到
http://localhost:8080。 - 使用您的ConnectWise凭证登录。
✨ 主要特性
自动化数据同步
- 实时更新：系统会自动检测和同步ConnectWise中的最新数据。
- 批处理操作：支持大量数据的高效处理，减少API调用次数。
- 错误恢复：具备断点续传功能，确保数据传输的完整性。
智能查询优化
- 自适应过滤器：根据历史查询行为动态调整搜索条件。
- 字段选择：仅请求相关字段，提升响应速度和减少带宽使用。
- 结果分页：支持大容量数据集的高效处理，通过
page和pageSize参数控制返回的数据量。
快速故障排除
数据库连接问题
sqlite3.OperationalError: unable to open database file
解决方法：
- 确保
api_gateway.db文件位于正确的位置。 - 检查文件权限，确保服务有读写权限。
认证失败
Unauthorized Error 401
解决方法：
- 验证所有环境变量是否正确设置：
CONNECTWISE_COMPANY_ID、CONNECTWISE_PUBLIC_KEY和CONNECTWISE_PRIVATE_KEY。
- 确认API密钥具有正确的权限。
- 检查
CONNECTWISE_AUTH_PREFIX是否为有效的前缀。
连接超时
Request timed out
解决方法：
- 优化网络连接，确保互联网稳定。
- 减少请求数据量，使用过滤和分页功能。
- 在非高峰时段进行大量数据操作。
📚 详细文档
系统要求
操作系统
- 支持的平台：Linux、Windows、macOS。
- 最低版本：Python 3.6或更高版本。
硬件需求
- 处理器：1 GHz或更快。
- 内存：至少2 GB RAM。
- 存储：至少500 MB的可用空间。
安全注意事项
- 数据加密：所有API请求和响应均使用SSL/TLS加密。
- 访问控制：通过IP白名单限制对管理接口的访问。
- 日志记录：详细记录所有操作，便于审计和故障排除。
文档更新历史
版本 1.0 (2023年1月15日)
- 初始版本发布。
版本 2.0 (2023年6月10日)
- 新增功能：智能查询优化和断点续传。
- 修复问题：解决数据库连接超时和认证失败的问题。
联系支持
如需帮助或报告问题，请联系我们的支持团队：
- 电子邮件：support@connectwise.com
- 电话：+1 (800) 123-4567