# integral document

**Repository Path**: mhaoxyz_project/integral_document

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-09-10
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 积分系统后台


## 手机端 api

### 发送短信验证码

method: post

path: sms

params:

```angular2html
phone: 手机号码,传参数KEY时可空
key: 手机或邮箱,后台自动识别
```

response:

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为该操作执行失败
  err_msg: "success" // 错误信息，操作失败时可将该信息展示给用户
}
```

### 短信登录/注册

method: post

path: sms_login

params:

```angular2html
phone: 手机号码,传参数KEY时可空
key: 手机或邮箱,后台自动识别
sms_code: 短信/邮箱验证码
```

response

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  api_token: "string", // 登录凭证，若执行请求是携带该数据作为参数，则视为用户已登录
  "user": { // 用户详细信息
    "phone": "phone", // 用户手机号
    "email": "email@google.com", // 用户邮箱
    "nickname": "ttt", // 用户昵称
    "avatar": "http://xxx", // 头像链接
    "created_at": "YYYY-mm-dd HH:ii:ss", // 用户账号创建时间
    "integral": 1000, // 用户可用积分, integer
    "releasing_integral": 500 // 待释放积分 integer
  },
  "config": [ // 项目配置
    {
      "key" => "detail_integral",
      "value" => "off" // on/off, on为显示详细积分信息
    }
  ]
}
```

### 邮箱登录(不用)

method: post

path: login

params:

```angular2html
email: 邮箱
password: 密码
```

response:
```angular2html

{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  api_token: "string", // 登录凭证，若执行请求是携带该数据作为参数，则视为用户已登录
  "user": { // 用户详细信息
    "phone": "phone", // 用户手机号
    "created_at": "YYYY-mm-dd HH:ii:ss", // 用户账号创建时间
    "integral": 1000, // 用户可用积分, integer
    "releasing_integral": 500 // 待释放积分 integer
  },
  "config": [ // 项目配置
    {
      "key" => "detail_integral",
      "value" => "off" // on/off, on为显示详细积分信息
    }
  ]
}
```

### --邮箱注册(不用)

method: post

path: register

params:

```angular2html
email: 邮箱
password: 密码
```

response:
```angular2html

{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  api_token: "string", // 登录凭证，若执行请求是携带该数据作为参数，则视为用户已登录
  "user": { // 用户详细信息
    "phone": "phone", // 用户手机号
    "email": "email@google.com", // 用户邮箱
    "nickname": "ttt", // 用户昵称
    "created_at": "YYYY-mm-dd HH:ii:ss", // 用户账号创建时间
    "integral": 1000, // 用户可用积分, integer
    "releasing_integral": 500 // 待释放积分 integer
  },
  "config": [ // 项目配置
    {
      "key" => "detail_integral",
      "value" => "off" // on/off, on为显示详细积分信息
    }
  ]
}
```

### 配置信息

method: get

path: config

response:

```$xslt
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "key" => "detail_integral",
      "value" => "off" // on/off, on为显示详细积分信息
    }
  ]
}
```

### 获取当前登录用户信息

method: get

path: personal/user

params:

```$xslt
api_token: 用户登录凭证，登录接口获取
```

response

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data": { // 用户详细信息
    "phone": "phone", // 用户手机号
    "email": "email@google.com", // 用户邮箱
    "nickname": "ttt", // 用户昵称
    "avatar": "http://xxx", // 头像链接
    "created_at": "YYYY-mm-dd HH:ii:ss", // 用户账号创建时间
    "integral": 1000, // 用户可用积分, integer
    "releasing_integral": 500 // 待释放积分 integer
  }
}
```

### 修改当前登录用户信息

method: put

path: personal/user

params:

```$xslt
nickname: 用户昵称，全局唯一
api_token: 用户登录凭证，登录接口获取
```

response

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
}
```

### 修改当前登录用户头像

method: post

path: personal/user/avatar

params:

```$xslt
_method: put
file: 头像文件
api_token: 用户登录凭证，登录接口获取
```

response

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data": { // 用户详细信息
    "phone": "phone", // 用户手机号
    "email": "email@google.com", // 用户邮箱
    "nickname": "ttt", // 用户昵称
    "avatar": "http://xxx", // 头像链接
    "created_at": "YYYY-mm-dd HH:ii:ss", // 用户账号创建时间
    "integral": 1000, // 用户可用积分, integer
    "releasing_integral": 500 // 待释放积分 integer
  }
}
```

### 查询用户

method: get

path: user

params:

```angular2html
api_token: 登录秘钥，登录接口获取
phone: 可空，手机号，要求1-11位纯数字,传该参数时将只返回手机号匹配的用户数据
```

response:

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "id": 1,
      "phone":"13153667239",
    },], 
    "meta":{ // 分页信息
      "current_page":1, // 当前页面
      "from":1, 
      "last_page":1, // 总页数
      "per_page":"20", // 每页最大数量
      "to":6,
      "total":6 // 总数据量
    }
}
```

### 积分转账

method: post

path: personal/transfer

params:

```angular2html
integral: 转账积分
payee_user_key: 收款用户手机或邮箱
```

response:

```angular2html

{
  err_code: 0, // 错误码，0为操作成功，非零时为该操作执行失败
  err_msg: "success" // 错误信息，操作失败时将该信息展示给用户
}
```

### 查询转账过的手机

method: get

path: personal/transferred_phone

params:

```angular2html
api_token: 登录秘钥，登录接口获取
phone: 可空，手机号，要求1-11位纯数字,传该参数时将只返回匹配的手机号及用户id
```

response:

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "id": 1, // 用户id
      "phone":"13153667239",
    },
  ], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 查询转账过的手机/邮箱

method: get

path: personal/transferred_key

params:

```angular2html
api_token: 登录秘钥，登录接口获取
key: 可空，手机号或邮箱,传该参数时将只返回匹配的手机号/邮箱及用户id
```

response:

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "id": 1, // 用户id
      "key":"13153667239",
    },
  ], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 积分记录

method: get

path: personal/bill

params:

response:

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "title":"转账至13400000002",
      "integral":1000, // 积分（全部为正）
      "type":"transfer", // transfer: 转账给他人, transfer_collect: 收到转账, integral_release: 系统积分分发
      "created_at":"2018-09-13 18:19:32", // 转账时间
    },
  ], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 新闻列表

method: get

path: news

params:

```angular2html
```

response 

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "id": 1,
      "title": "test news",
      "created_at":"2018-10-15 20:02:12", 
      "updated_at":"2018-10-15 20:02:12"
    }, 
    ... 
  ], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 查看新闻

method: get

path: news/{news.id}

params:

```angular2html
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
  data: {
    "id": 1,
    "title": "test news",
    "content": "test content",
    "created_at":"2018-10-15 20:02:12", 
    "updated_at":"2018-10-15 20:02:12"
  }, 
}
```

### 公告列表

method: get

path: announcement

params:

```angular2html
```

response 

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "id": 1,
      "title": "test announcements",
      "created_at":"2018-10-15 20:02:12", 
      "updated_at":"2018-10-15 20:02:12"
    }, 
    ... 
  ], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 查看公告

method: get

path: announcement/{announcement.id}

params:

```angular2html
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
  data: {
    "id": 1,
    "title": "test announcement",
    "content": "test content",
    "created_at":"2018-10-15 20:02:12", 
    "updated_at":"2018-10-15 20:02:12"
  }, 
}
```

### 轮播图列表

method: get

path: banner

response

```angular2html
{
  "err_code":0,
  "err_msg":"success",
  "data:" [
    {
      "id":1,
      "url":"https://www.apple.com/cn", // 超链接地址
      "img":"http://localhost/storage/20181020/I2RWDNuLB3Xrvm2vq537VyGLV7v1Rk58nvpVjh7G.jpeg" // 图片地址
    },
    ...
  ],
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

## 后台api

### 管理员登录

method: post

path: login

params:

```angular2html
username: 用户名,
password: 密码,
```

response

```angular2html
{
  err_code: 0,
  err_msg: "success",
  api_token: "string"
}
```

### 配置信息

method: get

path: config

params:

```$xslt
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "key" => "detail_integral",
      "value" => "off" // on/off, on为显示详细积分信息
    }
  ]
}
```

### 修改配置

method: put

path: config/detail_integral

params:

```$xslt
value: 固定值 on ,开启用户积分详细显示
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
}
```

### 管理员查询用户

method: get

path: user

params:

```angular2html
api_token: 登录秘钥，登录接口获取
phone: 可空，手机号，要求1-11位纯数字,传该参数时将只返回手机号匹配的用户数据
```

response:

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "total_integral": 9000, // 总释放积分
  "data":[
    {
      "id": 1,
      "phone":"13153667239",
    "email": "email@google.com", // 用户邮箱
    "nickname": "ttt", // 用户昵称
      "created_at":"2018-09-11 21:26:32",
      "integral":0,
      "releasing_integral":0
    },], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 派发积分记录查看

method: get

path: integral_release

params:

```angular2html
phone: 选填，用户手机号
api_token: 登录秘钥，登录接口获取
```
response:

```angular2html

{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "total_integral": 9000, // 总释放积分
  "data":[
    {
      "id": 1,
      "phone":"13153667239",
      "begin_date":"2018-09-11", // 开始发放日期
      "day": 90, // 发放天数
      "integral":9000, // 要发放的所有积分
      "releasing_integral":9000 // 未发放的积分
    },], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 派发积分

method: post

path: integral_release

params:

```angular2html
user_id: 用户 id
integral: 要发放的积分
api_token: 登录秘钥，登录接口获取
```

response:

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为该操作执行失败
  err_msg: "success" // 错误信息，操作失败时可将该信息展示给用户
}
```

### 文件上传

method: post/form-data

path: file

params:

```
file: 文件
api_token: 登录秘钥，登录接口获取
```

response

```angular2html
{
  "err_code":0,
  "err_msg":"success",
  "file": {
    "id":1,
    "name":"test.jpg",
    "url":"http://localhost/file/1"
  }
}
```

### 轮播图列表

method: get

path: banner

params:

```angular2html
api_token: 登录秘钥，登录接口获取
```

response

```angular2html
{
  "err_code":0,
  "err_msg":"success",
  "data:" [
    {
      "id":1,
      "file_id": 1, // 文件id
      "url":"https://www.apple.com/cn", // 超链接地址
      "img":"http://localhost/storage/20181020/I2RWDNuLB3Xrvm2vq537VyGLV7v1Rk58nvpVjh7G.jpeg" // 图片地址
      "is_used": false, // 时候已启用
    },
    ...
  ],
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 修改轮播图

修改后将自动启用

method: put

path: banner/{banner.id}

params:

```angular2html
file_id: 文件id
url: 超链接
api_token: 登录秘钥，登录接口获取
```

response

```angular2html
{
  "err_code":0,
  "err_msg":"success"
}
```

### 停用轮播图

method: put

path: banner/{banner.id}/block_up

params:

```angular2html
api_token: 登录秘钥，登录接口获取
```

response

```angular2html
{
  "err_code":0,
  "err_msg":"success"
}
```

### 新闻列表

method: get

path: news

params:

```angular2html
api_token: 登录秘钥，登录接口获取
```

response 

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "id": 1,
      "title": "test news",
      "created_at":"2018-10-15 20:02:12", 
      "updated_at":"2018-10-15 20:02:12"
    }, 
    ... 
  ], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 上传新闻

method: post

path: news

params:

```angular2html
title: 新闻标题
content: 新闻内容
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
}
```

### 查看新闻

method: get

path: news/{news.id}

params:

```angular2html
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
  data: {
    "id": 1,
    "title": "test news",
    "content": "test content",
    "created_at":"2018-10-15 20:02:12", 
    "updated_at":"2018-10-15 20:02:12"
  }, 
}
```

### 修改新闻

method: put

path: news/{news.id}

params:

```angular2html
title: 新闻标题
content: 新闻内容
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
}
```

### 删除新闻

method: delete

path: news/{news.id}

params:

```angular2html
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
}
```

### 公告列表

method: get

path: announcement

params:

```angular2html
api_token: 登录秘钥，登录接口获取
```

response 

```angular2html
{
  err_code: 0, // 错误码，0为操作成功，非零时为操作执行失败
  err_msg: "success", // 错误信息，操作失败时可将该信息展示给用户
  "data":[
    {
      "id": 1,
      "title": "test announcement",
      "created_at":"2018-10-15 20:02:12", 
      "updated_at":"2018-10-15 20:02:12"
    }, 
    ... 
  ], 
  "meta":{ // 分页信息
    "current_page":1, // 当前页面
    "from":1, 
    "last_page":1, // 总页数
    "per_page":"20", // 每页最大数量
    "to":6,
    "total":6 // 总数据量
  }
}
```

### 上传公告

method: post

path: announcement

params:

```angular2html
title: 公告标题
content: 公告内容
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
}
```

### 查看公告

method: get

path: announcement/{announcement.id}

params:

```angular2html
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
  data: {
    "id": 1,
    "title": "test announcement",
    "content": "test content",
    "created_at":"2018-10-15 20:02:12", 
    "updated_at":"2018-10-15 20:02:12"
  }, 
}
```

### 修改公告

method: put

path: announcement/{announcement.id}

params:

```angular2html
title: 公告标题
content: 公告内容
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
}
```

### 删除公告

method: delete

path: announcement/{announcement.id}

params:

```angular2html
api_token: 登录秘钥，登录接口获取
```

response:

```$xslt
{
  err_code: 0,
  err_msg: "success",
}
```