文档版本:v1.0
更新日期:2026-03-11
接口模块:会员开放 API
一、概述
1.1 文档说明
本文档描述会员相关的开放 API 接口。所有接口均需通过 appId 和 secret 进行鉴权。
1.2 基础信息
| 项目 |
说明 |
| Base URL |
https://www.shanghuiyi.com/open/member |
| 鉴权方式 |
所有接口需在请求中携带 appId 和 secret 参数 |
| 数据格式 |
JSON |
1.3 统一响应格式
{
"errno": 0,
"errmsg": "成功",
"data": {}
}
| 字段 |
类型 |
说明 |
| errno |
int |
错误码,0 表示成功 |
| errmsg |
string |
错误信息 |
| data |
object/array/boolean |
业务数据,成功时根据接口返回不同结构 |
二、接口列表
| 序号 |
接口名称 |
请求方式 |
路径 |
说明 |
| 1 |
校验会员 |
GET |
/open/member/checkMember |
根据单位名称和会员编号校验是否为有效会员 |
三、接口详情
3.1 校验会员
3.1.1 接口说明
根据单位名称和会员编号校验是否为有效会员。先按单位名称查找公司,再校验该公司下的会员编号是否匹配。
3.1.2 请求信息
| 项目 |
说明 |
| 请求方式 |
GET |
| 请求路径 |
https://www.shanghuiyi.com/open/member/checkMember |
| Content-Type |
application/x-www-form-urlencoded 或 application/json |
3.1.3 请求参数
| 参数名 |
类型 |
必填 |
说明 |
| companyName |
string |
是 |
单位名称 |
| memberNo |
string |
是 |
会员编号 |
| appId |
string |
是 |
开放平台应用ID |
| secret |
string |
是 |
开放平台密钥 |
3.1.4 请求示例
GET https://www.shanghuiyi.com/open/member/checkMember?companyName={companyName}&memberNo=M20250001&appId={your_app_id}&secret={your_secret}
3.1.5 响应参数
| 参数名 |
类型 |
说明 |
| errno |
int |
错误码,0 表示成功 |
| errmsg |
string |
错误信息 |
| data |
boolean |
是否为有效会员:true-是,false-否 |
3.1.6 响应示例
有效会员:
{
"errno": 0,
"errmsg": "成功",
"data": true
}
非会员或编号不匹配:
{
"errno": 0,
"errmsg": "成功",
"data": false
}
3.1.7 校验逻辑说明
- 根据
companyName 在当前协会下查找公司,不存在则返回 false
- 根据公司ID查找关联会员,不存在则返回
false
- 校验会员的
memberNo 是否与传入的 memberNo 一致,一致返回 true,否则返回 false
四、错误码说明
| errno |
说明 |
| 0 |
成功 |
| 非0 |
失败,具体原因见 errmsg |