概述
环能聚合API提供完整的企业级接口服务，涵盖用户管理、订单处理、数据查询、文件上传等核心功能。所有接口均支持RESTful设计，提供统一的响应格式和错误处理机制。
接口分类
1. 用户管理接口
| 接口名称 |
请求方式 |
请求路径 |
描述 |
状态 |
| 用户注册 |
POST |
/api/v1/user/register |
新用户注册接口 |
✓ 可用 |
| 用户登录 |
POST |
/api/v1/user/login |
用户登录认证 |
✓ 可用 |
| 用户信息查询 |
GET |
/api/v1/user/info |
获取用户基本信息 |
✓ 可用 |
| 用户信息更新 |
PUT |
/api/v1/user/update |
更新用户个人信息 |
✓ 可用 |
| 密码重置 |
POST |
/api/v1/user/reset-password |
重置用户密码 |
✓ 可用 |
| 用户注销 |
DELETE |
/api/v1/user/delete |
注销用户账户 |
⚠ 开发中 |
2. 订单管理接口
| 接口名称 |
请求方式 |
请求路径 |
描述 |
状态 |
| 创建订单 |
POST |
/api/v1/order/create |
创建新订单 |
✓ 可用 |
| 订单查询 |
GET |
/api/v1/order/query |
查询订单详情 |
✓ 可用 |
| 订单列表 |
GET |
/api/v1/order/list |
获取用户订单列表 |
✓ 可用 |
| 订单取消 |
PUT |
/api/v1/order/cancel |
取消未支付订单 |
✓ 可用 |
| 订单支付 |
POST |
/api/v1/order/pay |
订单支付接口 |
✓ 可用 |
| 订单退款 |
POST |
/api/v1/order/refund |
申请订单退款 |
✓ 可用 |
| 订单状态更新 |
PUT |
/api/v1/order/status |
更新订单状态 |
✓ 可用 |
3. 数据查询接口
| 接口名称 |
请求方式 |
请求路径 |
描述 |
状态 |
| 企业信息查询 |
GET |
/api/v1/company/info |
查询企业基本信息 |
✓ 可用 |
| 企业列表查询 |
GET |
/api/v1/company/list |
分页查询企业列表 |
✓ 可用 |
| 企业认证状态 |
GET |
/api/v1/company/auth-status |
查询企业认证状态 |
✓ 可用 |
| 数据统计查询 |
GET |
/api/v1/statistics/summary |
获取业务数据统计 |
✓ 可用 |
| 实时数据查询 |
GET |
/api/v1/data/realtime |
查询实时业务数据 |
✓ 可用 |
| 历史数据查询 |
GET |
/api/v1/data/history |
查询历史业务数据 |
✓ 可用 |
4. 文件上传接口
| 接口名称 |
请求方式 |
请求路径 |
描述 |
状态 |
| 文件上传 |
POST |
/api/v1/file/upload |
单文件上传接口 |
✓ 可用 |
| 批量文件上传 |
POST |
/api/v1/file/batch-upload |
多文件批量上传 |
✓ 可用 |
| 文件下载 |
GET |
/api/v1/file/download |
文件下载接口 |
✓ 可用 |
| 文件列表查询 |
GET |
/api/v1/file/list |
查询用户文件列表 |
✓ 可用 |
| 文件删除 |
DELETE |
/api/v1/file/delete |
删除已上传文件 |
✓ 可用 |
| 图片处理 |
POST |
/api/v1/image/process |
图片压缩和格式转换 |
⚠ 开发中 |
5. 支付接口
| 接口名称 |
请求方式 |
请求路径 |
描述 |
状态 |
| 支付预创建 |
POST |
/api/v1/payment/pre-create |
创建支付订单 |
✓ 可用 |
| 支付查询 |
GET |
/api/v1/payment/query |
查询支付状态 |
✓ 可用 |
| 支付回调 |
POST |
/api/v1/payment/notify |
支付结果通知 |
✓ 可用 |
| 退款申请 |
POST |
/api/v1/payment/refund |
申请退款 |
✓ 可用 |
| 退款查询 |
GET |
/api/v1/payment/refund-query |
查询退款状态 |
✓ 可用 |
6. 通知接口
| 接口名称 |
请求方式 |
请求路径 |
描述 |
状态 |
| 短信发送 |
POST |
/api/v1/notification/sms |
发送短信通知 |
✓ 可用 |
| 邮件发送 |
POST |
/api/v1/notification/email |
发送邮件通知 |
✓ 可用 |
| 推送通知 |
POST |
/api/v1/notification/push |
APP推送通知 |
⚠ 开发中 |
接口版本管理
版本控制策略
| 版本号 |
状态 |
支持期限 |
说明 |
| v1.0 |
当前版本 |
长期支持 |
稳定版本，推荐生产使用 |
| v1.1 |
预览版本 |
6个月 |
新增功能，测试中 |
| v2.0 |
规划中 |
- |
重大更新，计划中 |
接口调用频率限制
限流规则
| 接口类型 |
频率限制 |
时间窗口 |
错误码 |
| 用户注册/登录 |
10次/分钟 |
60秒 |
429 |
| 数据查询 |
100次/分钟 |
60秒 |
429 |
| 文件上传 |
5次/分钟 |
60秒 |
429 |
| 支付接口 |
20次/分钟 |
60秒 |
429 |
错误码说明
通用错误码
| 错误码 |
错误描述 |
HTTP状态码 |
说明 |
| 400 |
Bad Request |
400 |
请求参数错误 |
| 401 |
Unauthorized |
401 |
认证失败 |
| 403 |
Forbidden |
403 |
权限不足 |
| 404 |
Not Found |
404 |
资源不存在 |
| 429 |
Too Many Requests |
429 |
请求频率超限 |
| 500 |
Internal Server Error |
500 |
服务器内部错误 |
SDK下载
官方SDK
测试环境
沙箱环境
测试域名：
https://sandbox-api.huaneng.com
测试AppKey：
test_app_key_123456
测试AppSecret：
test_secret_key_abcdef
测试数据：
提供完整测试数据集