一、基本说明
统一网关地址:
http://XXXXXXX/open/gateway
API_KEY 与 TOKEN
用于数据签名的两个重要参数,由整好平台下发。
基础请求参数构成:
参数名称 |
是否必传 |
类型 |
默认值 |
描述 |
method |
是 |
string |
无 |
接口名 |
version |
是 |
string |
1.0.0 |
版本号 |
token |
是 |
string |
无 |
整好平台下发的token |
data |
是 |
json |
无 |
请求数据 |
sign |
是 |
string |
无 |
签名(详见签名算法) |
签名算法
$sign = md5($token . $api_key . $data);
其中 data 是将 【请求数据】转化为JSON后的字符串
返回数据说明
参数名称 |
是否必传 |
类型 |
默认值 |
描述 |
error_code |
是 |
intger |
0 |
错误代码 |
error_msg |
是 |
string |
0 |
错误描述 |
response_data |
是 |
array |
无 |
返回数据 |
二、开放接口
获取验证码
接口名: sendPhoneCode
请求方式: POST
请求参数:
参数名称 |
是否必传 |
类型 |
默认值 |
描述 |
phone |
是 |
intger |
无 |
手机号 |
code |
否 |
intger |
无 |
验证码 |
------------------------------------------------------------------------------------
用户注册
接口名: register
请求方式: POST
请求参数:
参数名称 |
是否必传 |
类型 |
默认值 |
描述 |
phone |
是 |
intger |
无 |
手机号 |
code |
是 |
string |
无 |
手机验证码 |
------------------------------------------------------------------------------------
获取项目/产品分类
接口名: getClassify
请求方式: GET
请求参数:
参数名称 |
是否必传 |
类型 |
默认值 |
描述 |
type |
是 |
intger |
无 |
类型 1 微整项目2 名医项目 3全部 |
all |
否 |
intger |
无 |
-1 全部 非-1取所传父级下所有子级分类0则为取所有的顶级分类 |
parent_id |
否 |
intger |
无 |
当parent_id为-1时有效 最多三级 每个分类的子级 在其分类信息的child字段内 |
index |
否 |
intger |
无 |
传1返回二级全部 不传或传0不返回二级全部 |
无子级时的格式{
"error_code": 0,
"error_msg": "ok",
"sid": "7acmkvn0kgqnbkg6vlhld7cve2",
"response_data": [
{
"id": 5,
"parent_id": 4,
"parent_path": "3-4",
"name": "开内眼角",
"type": 1,
"logo_path": "",
"check_logo_path": "",
"create_time": 0
},
{
"id": 6,
"parent_id": 4,
"parent_path": "3-4",
"name": "开外眼角",
"type": 1,
"logo_path": "",
"check_logo_path": "",
"create_time": 0
}
]
}
有子级时的格式
{
"id": 3,
"parent_id": 0,
"parent_path": "",
"name": "眼部",
"type": 1,
"logo_path": "",
"check_logo_path": "",
"create_time": 0,
"child": [
{
"id": 3,
"parent_id": 1,
"parent_path": "",
"parent_name": "眼部",
"name": "全部",
"type": 2,
"logo_path": "http://img.moreunion.com/classify/[email protected]",
"check_logo_path": "http://img.moreunion.com/classify/[email protected]",
"create_time": 1505818700
},
{
"id": 4,
"parent_id": 3,
"parent_path": "3",
"name": "开眼角",
"type": 1,
"logo_path": "",
"create_time": 0,
"child": [
{
"id": 5,
"parent_id": 4,
"parent_path": "3-4",
"name": "开内眼角",
"type": 1,
"logo_path": "",
"create_time": 0
},
{
"id": 6,
"parent_id": 4,
"parent_path": "3-4",
"name": "开外眼角",
"type": 1,
"logo_path": "",
"create_time": 0
}
]
},
{
"id": 7,
"parent_id": 3,
"parent_path": "3",
"name": "双眼皮",
"type": 1,
"logo_path": "",
"check_logo_path": "",
"create_time": 0,
"child": [
{
"id": 8,
"parent_id": 7,
"parent_path": "3-7",
"name": "埋线双眼皮",
"type": 1,
"logo_path": "",
"create_time": 0
},
{
"id": 9,
"parent_id": 7,
"parent_path": "3-7",
"name": "切开双眼皮",
"type": 1,
"logo_path": "",
"create_time": 0
},
{
"id": 10,
"parent_id": 7,
"parent_path": "3-7",
"name": "定点双眼皮",
"type": 1,
"logo_path": "",
"create_time": 0
}
]
}
]
}
parent_id为-1时 返回的分类详情里面会有child字段 存放子级信息
部分字段解释
id 分类id
parent_id 父级id
parent_path 父级路径
name 分类名称
type 分类类型 1 项目分类 2 商品分类
logo_path 分类图片
check_logo_path 选中的封面图
create_time 创建时间
------------------------------------------------------------------------------------
获取医生的列表
接口名: getDoctorList
请求方式: GET
请求参数:
参数名称 |
是否必传 |
类型 |
默认值 |
描述 |
classify_id |
否 |
intger |
无 |
类型 1 微整项目2 名医项目 3全部 |
sort |
否 |
intger |
无 |
-1 排序用到的类别,降序排列,默认为0代表智能排序,1按案例数排序,2按咨询数量,3访问量,4连线量 5是否在线 6满意度 7粉丝数8预约数 9医生回答月统计 |
city_id |
否 |
intger |
无 |
地区id |
page |
是 |
intger |
无 |
第几页 |
limit |
是 |
intger |
无 |
每页显示多少条 |
hosp_id |
否 |
intger |
无 |
医院的id |
is_pass |
否 |
intger |
无 |
传5代表查询名医,传4查询普通医生,传空查询所有 |
doctor_name |
否 |
intger |
无 |
医生的名称 模糊搜索 |
online_status |
否 |
intger |
无 |
医生状态1不在线 2 在线 3 视频中 |
post |
否 |
intger |
无 |
医生职务 |
order_id |
否 |
intger |
无 |
订单ID (写日记 ) |
type |
否 |
intger |
无 |
1为医生排行 2 为视频问诊 [新版本]区分智能排序排序规则 |
{
"error_code": 0,
"error_msg": "ok",
"sid": "",
"response_data": [
{
//医生id
"user_id": 100027,
//地区id
"city_id": 1,
//医生头像
"doctor_face": "http://new-beauty.b0.upaiyun.com/hospital_images/20170601/dcfd7c5a5d5d1f6114d9d66efc744f14.jpg",
//医生名字
"doctor_name": "yishengxin",
//医院id
"hosp_id": 15,
//性别1男2女
"sex": 1,
//医生职务
"post": 1,
//医生描述
"doctor_desc": "123123123123123123123123",
//是否认证 1未填写 2认证中 3 认证失败 4普通认证成功 5 名医认证成功6 名医认证中 7名医认证失败
"is_pass": 1,
//创建时间
"create_time": 1496295523,
//不在线(0没有提醒,可以离线通知,1已添加,置灰) 2 在线 3 视频中
"online_status": 1,
//从业时间
"practice_date": 8,
//预约数
"sale_num": 108,
//案例数
"case_num": 2,
//粉丝数
"fans_num": 0,
//医生职称
"aptitude": "助理执业医师",
//咨询数量
"consult_num": 1,
"hosp_name": "北京协和医院",
"hosp_phone": "05945083031",
//医生格言
"doctor_motto": "",
//当前用户是否已关注,-1未登录,0未关注,1已关注
"month_answer_num": 11,
//月回复数
"month_answer_num": 0,
//医生回答数
"answer_num": 0,
"follow": -1,
//医院名称
"hosp_name": "北京协和医院",
//医院电话
"hosp_phone": "15801390666",
//名医荣誉图
"homepic": "",
//案例数
"classifys_list": [
{
//分类id
"id": 3,
//名称
"name": "开内眼角",
//多少
"count": 1
},
{
//分类id
"id": 3,
//名称
"name": "开外眼角",
//多少
"count": 1
},
],
//案例数
classifys_list_count": 0,
//职务
"post_info": "院长
//擅长科目
"classifys": [
{
"id": 303,
"doctor_id": 100027,
//科目id
"classify_id": 41,
//科目名称
"classify_name": "鼻部"
},
{
]
//医生分享
"share_title": "",
//案例
"share_time": "",
//视频问诊(医生好评)
"doctor_grade": 0
},
]
}
------------------------------------------------------------------------------------
医生发布分享
接口名: addDoctorShare
请求方式: POST
请求参数:
参数名称 |
是否必传 |
类型 |
默认值 |
描述 |
title |
是 |
string |
无 |
分享标题 |
content |
是 |
string |
无 |
分享内容 |
later_data |
是 |
array |
无 |
附加数据(图文混合的的附加数据) |
classify_id |
是 |
intger |
无 |
分类 |
desc |
否 |
string |
无 |
选填 描述 |
{
"error_code": 0,
"error_msg": "ok",
"sid": "",
"response_data": {
//分享id
"share_id": "157"
}
}
------------------------------------------------------------------------------------
三、错误代码
错误码 |
描述 |
10000 |
请求的接口不存在 |
10001 |
请求类型不正确 例如 post请求的接口用get请求 |
10002 |
token不正确 |
10003 |
签名错误 |
10004 |
参数不正确 |
10005 |
手机号不正确 |
10006 |
手机号已注册 |
10007 |
手机号未注册 |
10008 |
验证码发送失败 |
10009 |
注册失败 |
10010 |
校验验证码失败 |
10011 |
添加分享失败 |