请求方式

请求方法规范

环能聚合API统一采用POST方法进行接口调用,所有请求数据都通过JSON格式在请求体中传输。

基本规范

请求方法: POST
Content-Type: application/json
字符编码: UTF-8
数据格式: JSON

请求示例

标准POST请求

POST /api/v1/enterprise/register HTTP/1.1
Host: api.huanengjuhe.com
Content-Type: application/json
Authorization: Bearer your_access_token

{
  "company_name": "示例企业有限公司",
  "unified_social_credit_code": "91310000MA12345678",
  "legal_person": "张三",
  "contact_phone": "13800138000",
  "business_license": "base64_encoded_image"
}

请求参数类型

参数类型 说明 示例 注意事项
String 字符串类型 "张三" 需使用UTF-8编码
Number 数字类型 100.50 金额类参数保留2位小数
Integer 整数类型 100 不能包含小数点
Boolean 布尔类型 true 只能为true或false
Array 数组类型 [1, 2, 3] 元素类型需保持一致
Object 对象类型 {"key": "value"} 嵌套层级不超过3层

特殊参数处理

日期时间参数

格式:YYYY-MM-DD HH:MM:SS

时区:UTC+8(北京时间)

示例:"2024-01-15 14:30:00"

金额参数

单位:人民币(元)

精度:保留2位小数

范围:0.01 ~ 999999999.99

示例:"amount": 100.50

文件参数

格式:Base64编码字符串

大小限制:单个文件不超过5MB

支持格式:JPG、PNG、PDF

示例:"file_data": "base64_encoded_content"

错误处理

错误码 错误信息 说明 解决方案
4001 参数格式错误 JSON格式不正确 检查JSON语法格式
4002 缺少必需参数 必填参数未提供 补充缺失的参数
4003 参数值无效 参数值不符合规范 检查参数值格式和范围
4004 数据类型错误 参数类型不匹配 确认参数数据类型

最佳实践

💡 建议

  • 使用UTF-8编码确保中文字符正确处理
  • 对特殊字符进行URL编码处理
  • 金额参数统一使用字符串类型避免精度问题
  • 日期时间参数严格遵循指定格式
  • 大文件上传建议使用分片上传接口
  • 及时验证参数有效性,减少无效请求