速眠微服务开放接口API

1 简介

速眠微服务开放接口API文档

1.1 概述

速眠微服务API平台提供接口能力,第三方可以通过接口扩展自身的业务等

1.2 版本记录

更新日期 描述 操作人
2022-12-13 添加用户，量表相关接口 ztime

2 开发指南

开发指南

2.1 如何调用接口

速眠为合作方提供的接口为 HTTP 接口。HTTP 请求的 URL 前缀为：

服务说明

  • member: 用户服务
  • questionnaire: 量表服务
  • organization: 机构服务

接口请求地址

  • 开发环境:
    member: https://member-service-dev.sumian.com
    questionnaire: https://questionnaire-service-dev.sumian.com
    organization: https://organization-service-dev.sumian.com
  • 测试环境:
    member: https://member-service-test.sumian.com
    questionnaire: https://questionnaire-service-test.sumian.com
    organization: https://organization-service-test.sumian.com
  • 正式环境:
    member: https://member-service.sumian.com
    questionnaire: https://questionnaire-service.sumian.com
    organization: https://organization-service.sumian.com

测试账号

开发环境dev：
appId = 'demo'
appSecret = 'eyXeeSDiOiJKV1QiLCJhbGciOiJIUzI1NiG8'

测试环境test:
appId = 'demo'
appSecret = 'eyXeeSDiOiJKV1QiLCJhbGciOiJIUzI1NiG8'

请求示例

composer require liuyuanshan11/sd-micro-service-client

use liuyuanshan11\SdMicroServiceClient\MicroService;

$services = [
    'member' => 'https://member-service-dev.sumian.com',
    'questionnaire' => 'https://questionnaire-service-dev.sumian.com',
    'organization' => 'https://organization-service-dev.sumian.com',
];

// 容器->服务（实例）->('模块', ‘方法’, '参数'): $micro->(service)->act(role, cmd, params)
$micro = new MicroService('appId', 'appSecret', $services);
$micro->get('member')->act('members', 'create', ["mobile" => "13200000000"]));

3.1 用户接口: member服务

请求地址: 用户服务member, 获取相应地址

接口 描述
创建用户 创建用户
获取用户详情 获取用户详情
更新用户信息 更新用户信息

3.1.1 创建用户

接口调用

role: members, cmd: create
php-micro-sdk示例: micro->get('member')->('members', 'create', params)

业务参数params

参数名 示例值 类型 必须 说明 默认值
mobile 13178460001 string 是 手机号
name 'jay' string 否 真实姓名
miniAppType 1 number 否 小程序类型(1:患者小程序,2:自在森林小程序)
wechatAvatar '' string 否 微信头像
avatar '' string 否 头像
nickname '啦啦' string 否 昵称
openId '' string 否 微信公众平台 openId
unionId '' string 否 微信公众平台 unionId
account '' string 否 账号
password '' string 否 密码
credentialsType 1 number 否 证件类型，1：身份证，2：护照，3：外国人永久居留（身份）证，4：港澳往返内地通行证，5：台湾往返内地通行证
credentialsNumber '' string 否 证件号
gender 0 number 否 性别，1：男，2：女，0：保密
birthday 1034472471 number 否 出生日期
age 20 number 否 年龄
nationalId 1 number 否 民族Id
province 广东省 string 否 省
city 深圳市 string 否 市
area 南山区 string 否 区
hight 180 number 否 身高: cm
weight 60 number 否 体重:kg
educationDegree 1 number 否 教育程度 1 小学以下，2 小学，3 初中，4 高中，5 中专，6 大专，7 本科，8 硕士，9 博士 10 学龄前
marriage 0 number 否 婚姻状况 1: 未婚, 2: 已婚 3: 离异 4: 丧偶 5: <18 岁不涉及 6: 其他
career '' 职业
professionId 1 number 否 职业
objectiveIds [1,2] array 否 目标Id

返回结果: 患者信息

参数名 示列值 说明
id 1 id
name demo 真实姓名
avatar '' 头像
wechatAvatar '' 微信头像
openId '' 微信公众平台 openId
unionId '' 微信公众平台 unionId
nickname '' 昵称
mobile '' 手机号
account '' 账号
password '' 密码
credentialsType 1 证件类型，1：身份证，2：护照，3：外国人永久居留（身份）证，4：港澳往返内地通行证，5：台湾往返内地通行证
credentialsNumber 证件号
gender 0 性别，1：男，2：女，0：保密
birthday 出生日期
age 20 年龄
province 广东省 省
city 深证市 市
area 南山区 区
hight 180 身高: cm
weight 60 体重:kg
educationDegree 1 教育程度 1 小学以下，2 小学，3 初中，4 高中，5 中专，6 大专，7 本科，8 硕士，9 博士 10 学龄前
marriage 0 婚姻状况 1: 未婚, 2: 已婚 3: 离异 4: 丧偶 5: <18 岁不涉及 6: 其他
status 1 0 禁用 1 启用
nationalId 2 民族Id
professionId 1 职业Id
createdAt 1650160322 创建时间
updatedAt 1650160322 更新时间

返回示例

{
    "code": 0,
    "data": {
        "createdAt": 1670916428,
        "updatedAt": 1670916428,
        "name": "adminaaa",
        "avatar": "fafas",
        "wechatAvatar": "asa",
        "openId": "fwa",
        "unionId": "ff",
        "nickname": "awq",
        "mobile": "13232455673",
        "account": "igfa",
        "credentialsType": 1,
        "credentialsNumber": "fsad",
        "gender": 1,
        "status": 1,
        "province": "string",
        "city": "string",
        "area": "string",
        "hight": 177,
        "weight": 62,
        "educationDegree": 2,
        "marriage": 1,
        "nationalId": 2,
        "id": 58,
        "miniAppType": 1,
        "birthday": 234,
        "age": 12,
        "professionId": 2
    },
    "message": "success"
}

3.1.2 用户详情

接口调用

role: members, cmd: create
php-micro-sdk示例: micro->get('member')->('members', 'create', params)

业务参数params

参数名 示例值 类型 必须 说明 默认值
id 1 number 是 患者Id(id>=1)
organizationId 1 number 否 组织Id
expand '' string 否 获取指定子资源数据
attributes ['id', 'name'] array 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 患者信息

3.1.3 更新用户信息

接口调用

role: members, cmd: create
php-micro-sdk示例: micro->get('member')->('members', 'create', params)

业务参数params

参数名 示例值 类型 必须 说明 默认值
id 1 number 是 患者Id(id>=1)
mobile '13209089099' string 否 手机号(不能为空)
openId '' string 否 微信公众平台 openId(不能为空)
其它参数同新建接口参数一致
#### 返回结果: 患者信息

3.2 量表接口

请求地址: 量表服务questionnaire, 获取相应地址

接口 描述
量表列表 量表分页列表
量表详情 获取量表详情

3.2.1 量表列表

接口调用

role: members, cmd: create
php-micro-sdk示例: micro->get('member')->('members', 'create', params)

业务参数params

参数名称 类型 是否必须 说明
page Number N 页码默认为1
pageSize Number N 每页数据量，默认为10
expand String N 扩展加载字段: "questionSets.questions,questionSets.dimensions.comments"
attributes String N 本资源属性: "id,title,type"

返回结果: 量表信息

字段名称 类型 说明
id number 量表id
title string 量表标题
description string 量表描述
remark string 备注
type number 问卷类型，0：普通问卷，1：测评问卷
isSingle number 是否单一量表, 0: 否, 1=是
lastResultOnly number 是否仅展示最后一个结果，0：否, 1=是
createdAt int 创建时间, 时间戳(单位秒)
updatedAt int 更新时间, 时间戳(单位秒)

返回示例

{
  "data": [
    {
      "id": 1,
      "title": "广泛性焦虑量表",
      "description": "在过去两个星期里，您有多少时间会受到以下的这些问题的困扰呢？\n为了准...(略)",
      "remark": "",
      "type": 0,
      "isSingle": 1,
      "lastResultOnly": 0
    }
  ],
}

3.2.4 获取量表详情

接口调用

role: members, cmd: create
php-micro-sdk示例: micro->get('member')->('members', 'create', params)

业务参数body

参数名称 类型 是否必须 说明
id number Y 量表id

返回结果: 量表信息

4.2 错误码汇总

失败响应字段介绍

参数名称 类型 是否必须 说明
code number 是 业务码
message string 是 错误描述
status number 是 http状态码