传输协议

协议概述

环能聚合API采用HTTPS协议进行数据传输，确保数据传输的安全性和完整性。所有接口调用都必须通过HTTPS加密通道进行。

基本规范

协议类型： HTTPS
请求方法： POST
数据格式： JSON
字符编码： UTF-8
Content-Type： application/json

请求URL格式

https://api.huanengjuhe.com/api/v1/{接口路径}

请求头规范

所有请求必须包含以下标准HTTP头信息：

Header名称 是否必需 说明 示例
Content-Type 是 指定请求体的数据格式 application/json
Accept 是 指定客户端可接受的响应格式 application/json
User-Agent 否 客户端软件信息 Mozilla/5.0
Authorization 是（需认证的接口） 身份认证token Bearer eyJhbGciOiJIUzI1NiIs...

响应格式规范

所有API响应都采用统一的JSON格式：

{
  "code": 0,
  "message": "操作成功",
  "data": {
    // 具体业务数据
  },
  "timestamp": 1640995200000,
  "request_id": "uuid-string"
}

响应状态码

HTTP状态码 含义 说明
200 成功 请求成功处理
400 请求错误 请求参数错误或格式不正确
401 未授权 身份认证失败或token无效
403 权限不足 没有访问该资源的权限
404 资源不存在 请求的接口或资源不存在
429 请求过于频繁 触发接口限流策略
500 服务器错误 服务器内部错误

超时设置

连接超时：5秒

读取超时：30秒

写入超时：30秒

建议：客户端设置超时时间不少于30秒