爱康云开发平台

爱康云开放平台提供API接口可帮助设备厂商、医疗机构开发服务应用。并提供一站式支持智能手机和平板等设备的服务应用。

爱康云,全方位健康管理工具。

1.慢性病管理:面向大众,尤其适合社区卫生服务中心对其所覆盖的社区居民进行慢性病管理;

2.移动健康设备厂商:对于能长期监测人体健康指标的移动健康设备,爱康能提供管理平台及数据输入接口,实现更便捷的健康监测及管理;

3.体检机构:爱康希望与全国体检机构合作,为体检提供档案管理及健康干预平台;

4.健身中心:爱康提供平台,由中心提供运动、塑身、减肥等运动健身方案,并实现在线会员管理与服务,为用户提供无边界数字化的健身服务。

1、爱康云OAuth2.0简介

爱康云已采用OAuth2.0协议为第三方网站/客户端提供连接服务,遵循[RFC-5849]规范。OAuth2.0协议为用户资源的授权提供了一个安全的、开放而又简易的标准。 有关OAuth2.0认证的详细说明,请到OAuth2.0官网阅读官方OAuth2.0规范说明。
开发者通过认证鉴权接口从爱康云获取爱康云用户的认证令牌,绑定认证令牌后。 即可通过此令牌访问爱康云的数据,并且在注册回调接口后还能在用户上传数据后得到实时的通知。


2、OAuth2.0流程

OAuth2.0基本流程如下图所示:



2.1 获取Access Code

接口地址:http://kaisr.vicp.cc:8087/authorize

支持格式:OAuth HTTP 标准认证返回格式

HTTP请求方式:GET

是否需要登录:否

请求参数:

示例如下:

http://kaisr.vicp.cc:8087/authorize?client_id=xxx
&redirect_uri=http%3A%2F%2Fapi.yourdomain.com%2Fget_code&response_type=code&scope=user,sports

将参数urlencode后放在url的参数部分,然后转跳到这个地址上。如果用户在爱康云已经登录,就会显示授权页面,点击确认后会转跳到参数redirect_uri所指定的地址 AccessCode通过参数code返回,示例如下:

http://kaisr.vicp.cc:8087/get_code?code=xxxxxxxxxxxxxxxxx

AccessCode是一个很重要的返回值,你需要将其存储起来供下一次调用使用。


2.2 获取Access Token(授权令牌)

在获取到AccessCode之后,就可以通过这个code获取授权令牌(Access Token)了。获取Access Token需要用之前获取的Access Code作为参数发起一次Http请求, 由于客户端发起容易被截获,建议在服务端发起这个请求。

接口地址:http://kaisr.vicp.cc:8087/token

支持格式:OAuth HTTP 标准认证返回格式

HTTP请求方式:POST

HTTP HEADER : Key:Authorization Value:base64("AppKey:AppSecret")

是否需要登录:否

请求参数:

返回参数(JSON对象):


2.3 Access Token(授权令牌)过期获取新令牌的过程

在获取授权令牌的时候,API授权接口会返回一个Refresh Token(刷新令牌)的值,这个值需要存起来,当授权令牌过期后,可以通过这个值去获取一个新的授权令牌, 从而不必再重复第一步从获取Access Code开始。执行这个过程的方式和第二步类似,地址相同,只是参数有所区别。

接口地址:http://kaisr.vicp.cc:8087/token

支持格式:OAuth HTTP 标准认证返回格式

HTTP请求方式:POST

是否需要登录:否

请求参数:

返回参数(JSON对象):

爱康云API简介

在使用API之前,请先阅读“爱康云OAuth2.0文档”。第三方用户在经过验证授权后,获取到用户的授权令牌,第三方应用就可以使用这个令牌来访问用户的数据了,爱康开放API支持Bearer这一种方式, 只需要将Access Token放到Http Header的Authorization键中即可

接口地址:http://api.aikangcom/api/method_name

HTTP请求方式:GET、POST

认证参数:Http Header:Key:authorization Value:access token

API参数:接口所需参数均为命名参数,需要将参数组合成一个json对象,放在body里

API详细说明

API可以通过Http协议的GET和POST方法访问

获取用户基本信息

获取用户基本信息

开发者可通过用户id来获取用户基本信息。请使用http协议。

接口调用请求说明

http请求方式: GET

http://api.aikangcom/api/get_user_info.do?uid=123456

Mehtod Name get_user_info
访问方法 GET
API参数(Body) {}

返回值说明

{"sex":Int,//性别

"birth":"String",//出生日期

"nick":"String",//昵称

"image_url":"String",//图像地址

"blood_type":Int,//血型ID,1-AB型,2-A型,3-B型,4-O型

"personality":"String",//签名

}

获取用户身高

获取用户身高

开发者可通过用户id来获取用户身高。请使用http协议。

接口调用请求说明

http请求方式: GET

http://api.aikangcom/api/get_weight.do?uid=123456

Mehtod Name get_weight
访问方法 GET
API参数(Body) {}

返回值说明

{

"uid": "String", //用户id

"evaluate": "String", //评估

"result": true, //返回是否成功

"curvData": [

{

"weight": Int, //身高值

"record_time": String" 数据记录时间 yyyy-mm-dd hh:mm:ss

},

{

"weight": Int, //身高值

"record_time": String" 数据记录时间 yyyy-mm-dd hh:mm:ss

}

]

}

获取用户血糖

获取用户血糖

开发者可通过用户id来获取用户血糖。请使用http协议。

接口调用请求说明

http请求方式: GET

http://api.aikangcom/api/get_blood_glucose.do?uid=123456

Mehtod Name get_blood_glucose
访问方法 GET
API参数(Body) {}

返回值说明

{

"uid": "String", //用户id

"evaluate": "String", //评估

"result": true, //返回是否成功

"curvData": [

{

"fasting_glucose": Int, //血糖值

"record_time": String" 数据记录时间 yyyy-mm-dd hh:mm:ss

},

{

"fasting_glucose": Int, //血糖值

"record_time": String" 数据记录时间 yyyy-mm-dd hh:mm:ss

}

]

}

获取用户体温

获取用户体温

开发者可通过用户id来获取用户体温。请使用http协议。

接口调用请求说明

http请求方式: GET

http://api.aikangcom/api/get_temperature.do?uid=123456

Mehtod Name get_temperature
访问方法 GET
API参数(Body) {}

返回值说明

{

"uid": "String", //用户id

"evaluate": "String", //评估

"result": true, //返回是否成功

"curvData": [

{

"temperature ": Double, //体温值

"record_time": String" 数据记录时间 yyyy-mm-dd hh:mm:ss

},

{

"temperature ": Double, //体温值

"record_time": String" 数据记录时间 yyyy-mm-dd hh:mm:ss

}

]

}

获取用户心率

获取用户心率

开发者可通过用户id来获取用户心率。请使用http协议。

接口调用请求说明

http请求方式: GET

http://api.aikangcom/api/get_pulse.do?uid=123456

Mehtod Name get_pulse
访问方法 GET
API参数(Body) {}

返回值说明

{

"uid": "String", //用户id

"evaluate": "String", //评估

"result": true, //返回是否成功

"curvData": [

{

"pulse ": Int, //心率值

"record_time": String" 数据记录时间 yyyy-mm-dd hh:mm:ss

},

{

"pulse ": Int, //心率值

"record_time": String" 数据记录时间 yyyy-mm-dd hh:mm:ss

}

]

}

通知接口

穿戴式设备厂商在注册APP的时候,需要提供一个回调地址,当用户上传数据的时候,API会即时调用这个地址,将消息通知给穿戴式设备厂商的系统。请在5秒内处理完成回调通知的逻辑,穿戴式设备厂商系统如果发生超时或者系统错误的时候,API不会重发此通知

返回方式说明

协议 HTTP
方法 POST
参数(body) user_id
返回 不判断内容,只判断返回的状态码,200即认为成功,其余状态均认为失败