# GiangGai_API

**Repository Path**: maoge/GiangGai_API

## Basic Information

- **Project Name**: GiangGai_API
- **Description**: No description available
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-02-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#墙改系统(qianggai)交互API文档

----------


> APP与API的通讯基于HTTPS协议，每次请求需至少带有call_id（当前时间戳）,app_sign(接口签名具体算法见最后《app_sign生成规则》)和token（访问令牌，具体算法见最后《Token生成规则》）。
>
> 对于qianggai资源的请求需要调用qianggai API,具体内容见qianggai API文档,所有数据均以标准json格式返回.

##1、用户登录
### 手机用户登录
> 用户登录。

***URL***

`qiangai/api/login`

***Method***

`GET`

***Param***

|参数    |说明      |
|:------:|:---------:|
|call_id  |请求时间|
|token |访问令牌 |
|app_sign |签名 |
|username |手机号 |
|password |密码 |

***Return Demo***

    {
        "msg": "登录成功.",
        "data": {
            "name": "admin",
            "phone": "18522666890",
            "gender":"0",
            "token":"3c69ccff8acc065aa5618b36b74703de"
        },
        "success": true
    }
    
##2、手机用户上传工程文件或者图片
### 上传工程文件接口
> 用户工程文件上传。

***URL***

`qiangai/api/projectfile/add`

***Method***

`POST`

***Param***

|参数    |说明      |
|:------:|:---------:|
|call_id  |请求时间|
|token |访问令牌 |
|app_sign |签名 |
|projectId |工程id |
|fileId |文件id |

***Return Demo***

     {
       "msg": "上传成功!",
       "success": true,
       "timestamp": 1455763332867
  }
##3、手机用户上传文件或者图片
### 上传文件接口
> 用户文件上传。

***URL***

`qiangai/api/upload`

***Method***

`POST`

***Param***

|参数    |说明      |
|:------:|:---------:|
|call_id  |请求时间|
|token |访问令牌 |
|app_sign |签名 |
|file |文件 |
|token |token |

***Return Demo***

     {
        "success": true,
        "timestamp": 1455764613679,
        "msg":"",//msg 为空
        "data": {
                "createTime": "2016-02-18 11:03:33",
                 "storeName": "\uploads\file\2016021811033397.jar",
                "realName": "jackson-core-asl-1.9.13.jar",
                "fileid": "2016021811033397.jar",
                "contentType": "application/octet-stream",
                "suffix": "jar",
                "sizedesc": "226.8 KB",
                "size": "232248"
             }
      }
##4、获取工程接口
### 工程接口
> 用户工程接口。

***URL***

`qiangai/api/project/list`

***Method***

`GET`

***Param***

|参数    |说明      |
|:------:|:---------:|
|call_id  |请求时间|
|token |访问令牌 |
|app_sign |签名 |
|page |文件 |
|rows |行数 |

***Return Demo***

     {
        "msg": "获取数据成功!",
        "success": true,
        "timestamp": 1455774544083,
        "data": [
            {
                "id": "ff80808152c007950152c00ce3f80001",
                "name": "工程项目",
                 "address": "地址",
                "builder": "建设单位",
                "sgdanwei": "施工单位",
                "areaname": "郑州市",
                "chanpinbs": "产品标识",
                "djren": "系统管理员",
                "djtime": "2016-02-08 16:43",
                "djrenid": "402883394d88de64014d88de644b0000",
                 "areacode": "4101"
            },
             {
                "id": "ff80808152bf8cf60152bfcab5d10001",
                "name": "工程项目名称",
                "address": "工程项目地址",
                "builder": "建设单位（开发商）",
                "sgdanwei": "施工单位",
                "areaname": "郑州市",
                "chanpinbs": "产品标识",
                "djren": "系统管理员",
                 "djtime": "2016-02-08 15:31",
                 "djrenid": "402883394d88de64014d88de644b0000",
              "areacode": "4101"
              }
  ]
}
## app_sign生成规则
每次发起请求时，客户端需要将所请求参数按照 `API_SECURITY+token+call_id`方式组合成字符串，并MD5加密后，生成app_sign。
app_secret请务必保密，在APP中应采用对称加密等手段进行加密。

## token生成规则
每次发起请求时，无权限接口token=md5('qianggainoauth'),权限接口使用服务器返回的用户token