sffi / member-plug
A project for Company Member Center
Requires
- php: >=7.4
- ext-json: *
- dev-master
- v0.1.50
- v0.1.49
- v0.1.48
- v0.1.47
- v0.1.46
- v0.1.45
- v0.1.44
- v0.1.43
- v0.1.42
- v0.1.41
- v0.1.40
- v0.1.39
- v0.1.38
- v0.1.37
- v0.1.36
- v0.1.35
- v0.1.34
- v0.1.33
- v0.1.32
- v0.1.31
- v0.1.30
- v0.1.29
- v0.1.28
- v0.1.27
- v0.1.26
- v0.1.25
- v0.1.24
- v0.1.23
- v0.1.22
- v0.1.21
- v0.1.20
- v0.1.19
- v0.1.18
- v0.1.17
- v0.1.16
- v0.1.15
- v0.1.14
- v0.1.13
- v0.1.12
- v0.1.11
- v0.1.10
- v0.1.9
- v0.1.8
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.3
- v0.1.2
- v0.1.1
This package is auto-updated.
Last update: 2024-09-17 14:33:20 UTC
README
2021-01-13 完善第三方信息查询接口
2020-08-06 新增添加第三方信息接口
2020-07-09 新增批量查询接口
$res = \sffi\Factory::Member()->batchQuery([ 'username' => '188', ['level', '>', 2] ]);
添加配置文件member.php位于根目录下extend目录里
return [ 'baseurl' => 'baseurl', 'request_key' => 'key' ];
例子：调用资产查询
\sffi\Factory::Assets('http://YOU.DOMAIN.PATH','PLEASE INPUT YOU KEY')->query(1,'rmb');
文档如下：
会员中心
本项目为内部项目，仅供公司内部调用。
本项目调用需授权，需要先在数据库platform_key表中添加一条唯一key的数据，并将KEY值交由下游系统在请求头中携带【PLATFORM-KEY】使用。否则将提示未授权访问。
本系统由用户管理于积分管理两大部分组成。
【api】用户/member
修改用户信息
基本信息
Path： /member/update
Method： POST
接口描述：
此接口可以修改用户所有信息，
修改证件信息需要传递Card数组
修改用户昵称等信息需要传递Info数组
修改用户密码等级等信息，需要传递member数组
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| id | number | 必须 | 用户ID | ||
| member | object | 非必须 | 会员基本信息 | ||
| ├─ password | string | 非必须 | 密码 | ||
| ├─ level | number | 非必须 | 等级 | ||
| ├─ tags | string [] | 非必须 | 标签 | item 类型: string | |
| ├─ | 非必须 | ||||
| info | object | 非必须 | 会员信息 | ||
| ├─ nickname | string | 非必须 | 昵称 | ||
| ├─ head_img | string | 非必须 | 头像 | ||
| ├─ sex | number | 非必须 | 性别 | ||
| card | object | 非必须 | 会员证件信息 | ||
| ├─ idcard_no | string | 非必须 | 证件号 | ||
| ├─ true_name | string | 非必须 | 真实姓名 | ||
| ├─ idcard_font_url | string | 非必须 | 证件照国徽面路径 | ||
| ├─ idcard_back_url | string | 非必须 | 证件照人像面路径 | ||
| ├─ idcard_auth_video_url | string | 非必须 | 认证视频路径 | ||
| third | object | 必须 | 第三方信息 | ||
| ├─ nickname | string | 必须 | 昵称 | ||
| ├─ open_id | string | 必须 | 第三方会员ID | ||
| ├─ head_img_url | string | 必须 | 头像路径 | ||
| ├─ province | string | 必须 | 省份 | ||
| ├─ city | string | 必须 | 市区 | ||
| ├─ country | string | 必须 | 国家 | ||
| ├─ unionid | string | 必须 | 唯一识别码 | ||
| ├─ type | string | 必须 | 第三方类型 wx-gzh微信公众号 wx-xcx微信小程序 ali阿里 wb微博 dy抖音 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | string [] | 非必须 | item 类型: string | ||
| ├─ | 非必须 | ||||
| msg | string | 非必须 | |||
| code | number | 非必须 |
查询
基本信息
Path： /member/query
Method： POST
接口描述：
此接口在存在用户名查询时，仅查询用户信息，ID和type不生效。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| id | string | 非必须 | 用户ID | mock: 1 | |
| type | string [] | 非必须 | 可为字符串，或者数组 字符串仅查询单个内容，数组可以查询多个内容 | item 类型: string | |
| ├─ | 非必须 | info用户昵称头像信息 card用户证件信息 third用户第三方信息 //top常用联系人信息 暂未实现 | |||
| username | string | 非必须 | 用户名查询单个用户，优先查询此方法 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | object | 非必须 | 如果为对象则为用户信息 如果为数字则表示用户ID 如果为false则表示用户不存在 | ||
| ├─ member | object | 非必须 | 用户信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ username | string | 非必须 | |||
| ├─ level | number | 非必须 | |||
| ├─ tags | string [] | 非必须 | item 类型: string | ||
| ├─ | 非必须 | ||||
| ├─ status | number | 非必须 | |||
| ├─ info | object | 非必须 | 用户基本信息 | ||
| ├─ member_id | number | 非必须 | |||
| ├─ sex | number | 非必须 | |||
| ├─ head_img | string | 非必须 | |||
| ├─ nickname | string | 非必须 | |||
| ├─ province | null | 非必须 | |||
| ├─ city | null | 非必须 | |||
| ├─ district | null | 非必须 | |||
| ├─ card | object | 非必须 | 用户证件信息 | ||
| ├─ id | number | 非必须 | |||
| ├─ idcard_no | string | 非必须 | |||
| ├─ true_name | string | 非必须 | |||
| ├─ idcard_type | number | 非必须 | |||
| ├─ idcard_font_url | string | 非必须 | |||
| ├─ idcard_back_url | string | 非必须 | |||
| ├─ idcard_auth_video_url | string | 非必须 | |||
| ├─ idcard_auth_video_time | null | 非必须 | |||
| ├─ auth_status | number | 非必须 | |||
| ├─ third | object | 非必须 | 暂未实现 | ||
| msg | string | 非必须 | |||
| code | number | 非必须 |
注册新用户
基本信息
Path： /member/registe
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| username | text | 是 | 18800000000 | 用户账号 |
| password | text | 是 | e10adc3949ba59abbe56e057f20f883e | md5后的密码 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | object | 非必须 | 详细数据 | ||
| ├─ id | number | 非必须 | |||
| ├─ username | string | 非必须 | |||
| ├─ level | number | 非必须 | 用户等级 | ||
| ├─ tags | string [] | 非必须 | 用户标签 | item 类型: string | |
| ├─ | 非必须 | ||||
| ├─ status | number | 非必须 | |||
| msg | string | 必须 | 提示信息 | ||
| code | number | 必须 | 提示编码 |
验证用户密码
基本信息
Path： /member/valid
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| username | text | 是 | 18800000001 | 用户账号 |
| password | text | 是 | e10adc3949ba59abbe56e057f20f883e | 用户密码 需MD5 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | object | 非必须 | |||
| ├─ id | number | 非必须 | 用户ID | ||
| ├─ username | string | 非必须 | 用户账号 | ||
| ├─ level_id | number | 非必须 | 用户等级 | ||
| ├─ tag_ids | string | 非必须 | 用户标签 | ||
| ├─ status | number | 非必须 | 用户状态 | ||
| msg | string | 非必须 | |||
| code | number | 非必须 |
【api】证件信息/Idcard
新增入住证件
基本信息
Path： /idcard/createCard
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| idcard_no | text | 是 | 430902199100000000 | |
| true_name | text | 是 | 余* |
返回数据
申请认证
基本信息
Path： /idcard/applyAuth
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| id | text | 否 | 1 | 用户ID |
| card_id | text | 否 | 1 | 证件ID |
返回数据
认证结果查询
基本信息
Path： /idcard/query
Method： GET
接口描述：
本接口仅支持单参数查询，仅支持会员主键或证件主键查询。
即，id和card_id仅支持一个参数。
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| id | 否 | 1 | 用户ID |
| card_id | 否 | 8 | 证件ID |
返回数据
跳转路径
基本信息
Path： /idcard/toRedirect
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| token | 是 | 9VF2M04ESaqw/iTDlrodQVJ4Q16mM/Sg |
【api】资产类型/assetsType
冻结用户资产
基本信息
Path： /assets_type/frozenAssetsType
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| id | 是 | 1 | 用户ID |
| assetsType | 否 | rmb | 资产类型编码 不传表示冻结所有资产 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | string [] | 非必须 | item 类型: string | ||
| ├─ | 非必须 | ||||
| msg | string | 必须 | |||
| code | number | 必须 |
新增用户资产类型
基本信息
Path： /assets_type/addAssetsType
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| id | 是 | 1 | 用户ID |
| assetsType | 是 | rmb | 资产类型编码 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | object | 非必须 | |||
| ├─ score_type | string | 必须 | 资产类型编码 | ||
| ├─ member_id | string | 必须 | 会员ID | ||
| ├─ status | number | 非必须 | 资产状态 | ||
| ├─ id | string | 必须 | 资产ID | ||
| msg | string | 必须 | |||
| code | number | 必须 |
【api】资产/assets
充值
基本信息
Path： /assets/recharge
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| id | text | 是 | 1 | |
| assetsType | text | 是 | rmb | |
| assets | text | 是 | 40 | |
| orderId | text | 否 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | string [] | 非必须 | item 类型: string | ||
| ├─ | 非必须 | ||||
| msg | string | 必须 | |||
| code | number | 必须 |
冻结部分资产
基本信息
Path： /assets/frozen
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| id | text | 是 | 用户ID | |
| assetsType | text | 是 | 资产类型编码 | |
| assets | text | 是 | 资产数量 单位分 | |
| orderId | text | 否 | 订单ID |
返回数据
批量查询
基本信息
Path： /assets/batchQuery
Method： GET
接口描述：
此接口返回结果文档同query接口文档
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| id | 是 | 1 | |
| assetsTypes[] | 是 | rmb | 资产类型编号 可传多个 |
| startTime | 是 | 2020-06-27 16:30:00 | 开始时间 |
| endTime | 是 | 2020-06-28 16:30:00 | 结束时间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | object [] | 非必须 | item 类型: object | ||
| ├─ id | number | 必须 | mock: 1 | ||
| ├─ member_id | number | 必须 | mock: 1 | ||
| ├─ score_type | string | 必须 | |||
| ├─ score | number | 必须 | |||
| ├─ create_time | string | 必须 | |||
| ├─ order_id | string | 必须 | |||
| ├─ status | number | 必须 | |||
| ├─ type | number | 必须 | |||
| msg | string | 非必须 | |||
| code | number | 非必须 |
查询
基本信息
Path： /assets/query
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Body
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| id | text | 是 | 用户ID | |
| assetsType | text | 是 | 资产类型编号 | |
| startTime | text | 否 | 开始时间 | |
| endTime | text | 否 | 结束时间 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | object [] | 非必须 | item 类型: object | ||
| ├─ id | number | 必须 | |||
| ├─ member_id | number | 必须 | 用户ID | ||
| ├─ score_type | string | 必须 | 资产类型编号 | ||
| ├─ score | number | 必须 | 资产数量 单位分 | ||
| ├─ create_time | string | 必须 | |||
| ├─ order_id | string | 必须 | 订单号 | ||
| ├─ status | number | 非必须 | |||
| ├─ type | number | 必须 | 收支类型 1收入 2支出 | ||
| msg | string | 非必须 | |||
| code | number | 非必须 |
消费
基本信息
Path： /assets/consume
Method： GET
接口描述：
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| id | 是 | 1 | 用户ID |
| assetsType | 是 | rmb | 资产类型编码 |
| assets | 是 | 5 | 资产数量 单位：分 |
| orderId | 是 | order_1025510147 | 订单号 |
返回数据
【api】用户信息/info
查询
基本信息
Path： /info/query
Method： POST
接口描述：
查询数据可以为此结构
[["nickname","=","鱼子"]]
也可以为
{
"nickname": "鱼子"
}
此结构
返回数据如下：
{ "data": [ { "member_id": 29, "sex": 2, "head_img": "/uploads/20191016/a26a0178d78b3f2d6f23b54adedb6e64.png", "nickname": "19174", "province": null, "city": null, "district": null }, { "member_id": 32, "sex": 2, "head_img": "/uploads/20191016/a26a0178d78b3f2d6f23b54adedb6e64.png", "nickname": "11156", "province": null, "city": null, "district": null } ], "msg": "成功", "code": 1 }
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| nickname | string | 非必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | object [] | 非必须 | item 类型: object | ||
| ├─ member_id | number | 必须 | |||
| ├─ sex | number | 必须 | |||
| ├─ head_img | string | 必须 | |||
| ├─ nickname | string | 必须 | |||
| ├─ province | null | 必须 | |||
| ├─ city | null | 必须 | |||
| ├─ district | null | 必须 | |||
| msg | string | 非必须 | |||
| code | number | 非必须 |