# xLink_Data_transfer

**Repository Path**: steven_666/xLink_Data_transfer

## Basic Information

- **Project Name**: xLink_Data_transfer
- **Description**: 数据转发
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2018-04-01
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文档说明


## 接口说明


### 用户接口文档说明

eg.https://xxxxx.com/api/path?a=a1&b=b1&sign_time=1222333&sign=eyryejdhr

> sign_time 为签名时间 时间戳
> sign 为验签

1. 校验   
 - 校验sign_time 时间

 - 校验sign

 	将参数按照字典的顺序排列得到数组，然后循环遍历 用 kv方式拼接 最终得到  k1v1k2v2 .....   ，
    然后进行<b style="color:red">MD5</b>加密,对比sign，
	生成验签的参数包含了业务参数，sign_time,access_token,access_token放在最前面。


### 返回数据基本类型

```json

      
{
　　"success":true, //业务正常  false  业务异常
　　"code":"00000", // 业务代码
　　"error":null,  //业务异常的原因
　　"data": null //查询的结果
}

```
    
#### 接口列表

1. 查询设备未被认领的记录 
GET /api/devices/list?deviceId=123&status=0&pageNo=1&size=10&sign_time=1212211&sign=qweereeer


|参数名     |参数类型       |必选|参数说明
|:------------|:-----------|:-----------|:------
|deviceIds   |String(字符串),可穿多个设备ID,用{,}号分开    |TRUE|设备ID 
|status   |Int（数字类型）    |TRUE|领取（1） 未被领取（0）
|pageNo   |Int（数字类型）    |TRUE|页码 第一页为1
|size   |Int（数字类型）    |TRUE|每页数量 


``` json

{
　　"success":true,
　　"code":"00000",
　　"lang":null,
　　"error":null,
　　"data":[
　　　　{
　　　　　　"id":122,
　　　　　　"msgId":"",
　　　　　　"msgCreatedTime":null,
　　　　　　"deviceId":"1111111",
　　　　　　"deviceProductId":"22222222",
　　　　　　"weight":123.65,
　　　　　　"bodyFat":1.23,
　　　　　　"reportTime":"2018-04-02 20:26:09",
　　　　　　"isAccept":true,
　　　　　　"acceptUserId":"1",
　　　　　　"acceptTime":"2018-04-03 10:42:21",
　　　　　　"feature":"{}",
　　　　　　"createTime":"2018-04-02 20:26:09",
　　　　　　"updateTime":"2018-04-03 10:42:21",
　　　　　　"updateOper":"xLink",
　　　　　　"accept":true
　　　　}
　　]
}


```



2. 查询用户已经认领的记录
GET /api/devices/user/list?userId=1&status=1&pageNo=1&size=10&sign_time=1212211&sign=qweereeer


|参数名     |参数类型       |必选|参数说明
|:------------|:-----------|:-----------|:------
|userId   |String(字符串)    |TRUE|用户ID 
|status   |Int（数字类型）    |TRUE|领取（1） 未被领取（0）
|pageNo   |Int（数字类型）    |TRUE|页码 第一页为1
|size   |Int（数字类型）    |TRUE|每页数量 

3. 用户认领记录
GET /api/device/accept?dId=1212222&userId=21232&sign_time=1212211&sign=qweereeer

|参数名     |参数类型       |必选|参数说明
|:------------|:-----------|:-----------|:------
|dId   |Integer(字符串)    |TRUE|设备记录ID 
|userId   |String(字符串)    |TRUE|用户ID 


``` json

{
　　"success":true,
　　"code":"00000",
　　"lang":null,
　　"error":null,
　　"data":[
　　　　{
　　　　　　"id":122,
　　　　　　"msgId":"",
　　　　　　"msgCreatedTime":null,
　　　　　　"deviceId":"1111111",
　　　　　　"deviceProductId":"22222222",
　　　　　　"weight":123.65,
　　　　　　"bodyFat":1.23,
　　　　　　"reportTime":"2018-04-02 20:26:09",
　　　　　　"isAccept":true,
　　　　　　"acceptUserId":"1",
　　　　　　"acceptTime":"2018-04-03 10:42:21",
　　　　　　"feature":"{}",
　　　　　　"createTime":"2018-04-02 20:26:09",
　　　　　　"updateTime":"2018-04-03 10:42:21",
　　　　　　"updateOper":"xLink",
　　　　　　"accept":true
　　　　}
　　]
}

```



4. 上传用户和设备关系
POST /api/userDevice/bind

|参数名     |参数类型       |必选|参数说明
|:------------|:-----------|:-----------|:------
|userId   |String(字符串)    |TRUE|用户ID 
|deviceId   |String(字符串)    |TRUE|设备ID 


5. 解绑用户和设备关系
POST /api/userDevice/unbind

|参数名     |参数类型       |必选|参数说明
|:------------|:-----------|:-----------|:------
|userId   |String(字符串)    |TRUE|用户ID 
|id   |Integer(字符串)    |TRUE|记录唯一id 







## xlink 保存数据接口说明

### 接口列表

1. 保存硬件上报的数据

GET /gate-way/data/save