mini项目后台接口文档

说明

1. returnCode和returnMessage返回值说明

returnCode	returnMessage	含义
0	OK	返回成功
1000	PARAM_ERROR	参数错误：仔细校验请求包参数是否完整，参数名称、参数类型、参数值是否正确
1001	DB_QUERY_ERROR	数据库查询异常
2000	USER_EXISTS	注册失败，该用户已存在
2001	USER_NOT_FOUND	登录失败，该用户不存在
3000	NO_CREDIT	取消/删除活动失败，用户信用分不够
3001	FULL_HC_ERROR	参加活动失败，人数已满
3002	DEADLINE_ERROR	参加活动失败，该活动已截止
3003	ACT_NOT_FOUND	参加活动失败，该活动不存在或已被取消

注：当未查找到相关信息时data将不会返回任何信息，但该请求判定为成功（returnCode=0，returnMessage="OK"）

2. 系统自动生成的参数不需要用户提供，但也在参数列表中列出

3. 若不特殊说明，请求方式均为 POST

4. 请求包和返回包通用格式如下

请求包：

{
    "version": "1.0",                        // 版本号，固定为1.0
    "timestamp": 1450936869,                 // 请求时间戳
    "interface": {                           // 接口详情
        "interfaceName": "...",              // 接口名称
        "para": {                            // 业务入参
              ...
         }
    }
}

返回包：

{
    "version": "1.0",                          // 版本号
    "timestamp": 1450936869,                   // 时间戳
    "returnCode": 0,                           // 请求返回码
    "returnMessage": "...",                    // 请求返回信息
    "data": {                                  // 请求返回数据
              ...
     }
}

---

一、用户接口

1. signIn 注册

• 参数

参数名称	是否必须	参数类型	备注
userName	是	string	微信自动拉取
portrait	是	string	微信自动拉取
creditScore	是	int	系统自动生成

• 请求包

{
    "version": "1.0",                       
    "timestamp": 1450936869,                 
    "interface": {                          
        "interfaceName": "user.signIn",              
        "para": {                            
             "userName": "alecpeng",
             "portrait": "用户头像url",
             "creditScore": 100
         }
    }
}

• 返回包

{
    "version": "1.0",                         
    "timestamp": 1450936869,                 
    "returnCode": 0,                          
    "returnMessage": "OK",                  
    "data": {}
}

• 涉及错误码：1000 1001 2000

 

2. login 登录

• 参数

参数名称	是否必须	参数类型	备注
userId	是	int

• 请求包

{
    "version": "1.0",                       
    "timestamp": 1450936869,                 
    "interface": {                          
        "interfaceName": "user.login",              
        "para": {                            
             "userId": "12"
         }
    }
}

• 返回包

{
    "version": "1.0",                         
    "timestamp": 1450936869,                 
    "returnCode": 0,                          
    "returnMessage": "OK",                  
    "data": {}
}

• 涉及错误码：1000 1001 2001

 

3. modifyUser 修改用户信息

• 参数

参数名称	是否必须	参数类型	备注
userId	是	int
age	否	int
height	否	int
weight	否	int
bg	否	string
signature	否	string

• 请求包

{
    "version": "1.0",                       
    "timestamp": 1450936869,                 
    "interface": {                          
        "interfaceName": "user.modi