vr-explorer-docs: An HTML repository from iyangsheng

1. API接口概览和测试数据
2. 接口命名规则
3. 接口说明
	3.1 第三方客户对接说明
		3.1.1 第三方接口凭证获取
		3.1.2 第三方获取二维码接口
		3.1.3 维塑推送合成通知消息
		3.1.4 第三方状态码
	3.2 获取维塑接口凭证
		3.2.1 获取维塑接口凭证
		3.2.2 用户信息绑定
	3.3 获取体测文件及数据
		3.3.1 获取体成分数据
      3.3.1-1 vr-explorer 获取体成分数据
    	3.3.1-2 S30 获取体成分数据
		3.3.2 获取用户脂肪等级
		3.3.3 获取身体评分
		3.3.4 获取身体成分调节数据
	3.4 获取体态文件及数据
		3.4.1 获取体态文件
		3.4.2 获取体态数据
		3.4.3 获取围度文件
		3.4.4 获取围度数据
	3.5 获取肩部检测数据
	3.6 获取打印报告
	3.7 维塑返回状态码说明
	3.8 合成推送类型与接口关系说明

1.文档介绍

1.1 API 接口概览

接口	接口功能
获取第三方凭证接口	获取可访问第三方接口凭证的地址。由第三方客户提供，接口格式、传入返回参数参照 3.1.1
请求第三方二维码接口	用户在设备端完成测量后的结果二维码，由第三方客户提供，接口格式、传入返回参数参照 3.1.2
维塑推送合成通知消息	体测、体态、节段分布结果及扫描相关信息，调用此接口向第三方服务推送信息。由第三方客户提供，接口格式、传入返回参数参照 3.1.3
获取维塑接口凭证	第三方客户调用此接口获取维塑相关接口凭证，vfid 和 vfsecret 从维塑管理平台获取
用户信息绑定	第三方 app 扫描设备端二维码后，在第三方后台验证用户身份通过后，调用此接口通知维塑后台服务从而发起合成请求
体测文件数据接口	体测模型合成成功，第三方客户调用此接口获取体测模型和数据
体态文件数据接口	体态模型合成成功，第三方客户调用此接口获取体态模型和数据
返回状态码说明	状态码说明

1.2 测试数据

参数名	参数值
key	vfbuqo5Tmnvrqe25
secret	GpBIk52k83PGvyzkeFDtfCUs3kaX8vUg
scanid	35042104080001-7254507f-50da-11ec-b365-300ed55248eb

2. 接口规则

2.1 命名规则

https://[域名]/[版本号]/[接口名]

例：http://api.explorer.visbody.com/v1/token

实例	说明
api.vr-explorer.visbody.com	域名
v1	版本号
token	接口名

2.2 版本控制

接口版本通过路由控制

HTTP GET:
// v1版本
http://api.explorer.visbody.com/v1/token
// v2版本
http://api.explorer.visbody.com/v2/token

2.3 POST 提交方式

Content-Type: application/json

3. 接口说明

3.1 第三方客户对接说明

目前支持 API 对接、二维码对接对接 2 种方式。

1. API 对接

使用说明： 可通过维塑提供的 API 接口获取用户测量数据。对接成功后维塑会通过客户配置的 3.1.3 接口推送扫描 ID 等相关信息，客户根据测量项目结果访问对应接口获取数据，合成推送类型与接口关系见 3.8 说明

对接说明：

申请 API 对接权限
通过维塑管理平台 API 对接设置配置 3.1.1、3.1.3 接口

2. 二维码对接

使用说明： 替换设备默认的序列号，扫码后可跳转到客户自己的 APP 或小程序等其他平台，需客户自行开发扫码业务逻辑

对接说明：

申请 API 对接权限
通过维塑管理平台 API 对接设置配置 3.1.1、3.1.2、3.1.3 接口
用户扫码后通过维塑 3.2.2 接口发起用户信息绑定及合成

3.1.1 第三方接口凭证获取 :id=third-token

接口描述：

由客户提供获取可访问第三方接口如 3.1.2、3.1.3 等接口的凭证地址

请求 URL 格式要求：

<http|https>://<域名>/<path>
http://<host>:<port>/<path>

请求方式：

参数：

参数名	必选	类型	说明
key	是	string	用户唯一凭证,由第三方提供
secret	是	string	用户唯一凭证密钥,由第三方提供

正常时返回示例

{
  "code": 0,
  "data": {
    "token": "TOKEN",
    "expires_in": 7200
  }
}

错误时返回示例

{
  "code": 30001,
  "error_msg": "ERROR_MSG"
}

返回参数说明

参数名	类型	说明
code	int	状态码,返回状态码参考 3.1.5 说明
error_msg	string	错误信息
token	string	接口凭证
expires_in	int	凭证有效时间单位秒

3.1.2 第三方获取二维码接口 :id=get-grcode

接口描述：

用户在设备端完成测量后的结果二维码，由第三方提供

请求 URL 格式要求：

<http|https>://<域名>/<path>
http://<host>:<port>/<path>

请求方式：

参数：

参数名	必选	类型	说明
scan_id	是	string	扫描 ID
device_id	是	string	设备 ID
token	是	string	第三方接口凭证

正常时返回示例

{
  "code": 0,
  "data": {
    "url": "qrCodeUrl"
  }
}

错误时返回示例

{
  "code": 30001,
  "error_msg": "ERROR_MSG"
}

返回参数说明

参数名	类型	说明
code	int	状态码 ,返回状态码参考 3.1.4 说明
error_msg	string	错误信息
url	string	二维码地址

3.1.3 维塑推送合成通知消息 :id=notify

接口描述：

用户在设备端扫描二维码后，体测、体态、节段分布结果及扫描相关信息，调用此接口向第三方服务推送信息

请求 URL 格式要求：

<http|https>://<域名>/<path>
http://<host>:<port>/<path>

请求方式：

POST

参数：

参数名	必选	类型	说明
scan_id	是	string	扫描 ID
device_id	是	string	设备 ID
time	是	date	完成时间时间格式 2018-06-25 10:10:10
user_info	否	object	用户信息
age	否	int	年龄
mobile	否	string	手机号
email	否	string	邮箱
sex	否	string	f 女，m 男
height	否	int	身高
action_status	是	object	状态信息
girth_status	否	int	体围的合成状态，０失败，１成功，２超时
eval_status	否	int	体态的合成状态，０失败，１成功，２超时
bia_status	否	int	体成分的合成状态，０失败，１成功，２超时
eval_shoulder_status	否	int	肩部的合成状态，０失败，１成功，２超时
pdf_status	否	int	pdf 是否可以打印，０否，１是
token	是	string	第三方接口凭证

格式如下

{
  "user_info": {
    "age": 26,
    "height": 178,
    "phone": "13812345678",
    "email": "xxx@126.com",
    "sex": "f"
  },
  "action_status": {
    "eval_status": 0,
    "bia_status": 0,
    "girth_status": 0,
    "eval_shoulder_status": 0
  },
  "device_id": "20041910080001",
  "scan_id": "20041910080001-a210136e-1bfb-11ea-b711-00d861a9ecd9",
  "time": "2019-12-11 17:56:15",
  "pdf_status": 1,
  "token": "TOKEN"
}

正常时返回示例

{
  "code": 0
}

正确接收到通知请求后必须响应，否则维塑服务会发起 3 次重传

错误时返回示例

{
  "code": 30001,
  "error_msg": "ERROR_MSG"
}

返回参数说明

参数名	类型	说明
code	int	状态码 ,返回状态码参考 3.1.4 说明
error_msg	string	错误信息

3.1.4 第三方状态码

描述：以上接口第三方客户请按以下状态码返回相关状态信息

状态码	备注
0	请求成功
30001	无效的 token

3.2 获取维塑接口凭证 :id=get-token

####请求头携带参数

根据请求头中的参数返回对应语言和单位的报告数据在请求头中添加语言,单位

$headers[]  =  "unit: $vfUnit; // vfUnit 可传的参数单位为metric(公制单位) / imperial (英制单位)
$headers[]  =  "language: $vfLanguage; // vfLanguage 可传语言为 en-US(英文) / ja-JP(日文) / zh-CN(中文)

3.2.1 获取维塑接口凭证

接口描述：

用于获取调用维塑接口凭证

请求 URL：

http://api.explorer.visbody.com/v1/token

请求方式：

参数：

参数名	必选	类型	说明
key	是	string	第三方用户唯一凭证，即 vfid
secret	是	string	第三方用户唯一凭证密钥，即 vfsecret

正常时返回示例

{
  "code": 0,
  "data": {
    "token": "TOKEN",
    "expires_in": 7200
  }
}

错误时返回示例

{
  "code": 40001,
  "error_msg": "ERROR_MSG"
}

返回参数说明

参数名	类型	说明
code	int	状态码,返回状态码参考 3.8 说明
error_msg	string	错误信息
token	string	接口凭证
expires_in	int	凭证有效时间单位秒

** vfid、vfsecret 获取方式： **

1.开通维塑管理系统账号
2.申请开通 API 对接权限
3.在维塑管理系统设备对接页根据页面提示完成 API 对接后，获取 vfid、vfsecret

** token 的使用方式 ** 1.在通过 POST 或 GET 请求中以普通参数传入 2.在请求头中添加 Authorization Bearer Token, 以 php 为例

$headers[]  =  "Content-Type: application/json";
$headers[]  =  "Authorization: Bearer ". $vfToken;

3.2.2 用户信息绑定

接口描述：

第三方 app 扫描设备端二维码后，在第三方后台验证设备和用户身份通过后，调用此接口通知维塑后台服务从而发起合成请求

请求 URL：

http://api.explorer.visbody.com/v1/dataBind

请求方式：

POST

参数：

参数名	必选	类型	说明
scan_id	是	string	扫描 ID
device_id	是	string	设备 ID
third_uid	是	string	第三方用户唯一 Id 字母和数字长度 8 ~ 40
email	是	string	邮箱
sex	是	int	性别 1 男 2 女
height	是	int	身高 110 ~ 205 单位 cm
age	是	int	年龄范围需在 10 ~ 99 之间
token	是	string	接口凭证
name	是	string	用户昵称

正常时返回示例

  {
    "code": 0,
    "data": {
      "result":TRUE
    }
  }

错误时返回示例

{
  "code": 40001,
  "error_msg": "ERROR_MSG"
}

返回参数说明

参数名	类型	说明
code	int	状态码,返回状态码参考 3.6 说明
error_msg	string	错误信息
result	boolean	发起合成结果

** token 的使用方式 ** 1.在通过 POST 或 GET 请求中以普通参数传入 2.在请求头中添加 Authorization Bearer Token, 以 php 为例

$headers[]  =  "Content-Type: application/json";
$headers[]  =  "Authorization: Bearer ". $vfToken;

3.3 获取体测文件数据

3.3.1 获取体成分数据

3.3.1-1 vr-explorer 获取体成分数据

接口描述：

用于获取体测体成分数据

请求 URL：

http://api.explorer.visbody.com/v1/body/mass

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

返回示例

  {
    "code": 0,
    "data": {
    	"WT": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "FFM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "BFM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "LM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "TBW": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "BMI": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "PBF": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "BMR": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "WHR": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "SM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "TM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		  "PROTEIN": {"l":10,"m":15,"h":20,"v":30.3,"status":3}，
    }
  }

返回参数说明

参数名	类型	说明
WT	object	体重（kg/pound ）
FFM	object	去脂体重（kg/pound）
BFM	object	体脂肪量（kg/pound）
LM	object	肌肉量（kgt/pound）
TBW	object	身体水分（kg/pound）
BMI	object	身体质量(kg/pound)
PBF	object	体脂肪率（%）
BMR	object	基础代谢量（kcal/d）
WHR	object	腰臀比
SM	object	骨骼肌量（kg/pound）
TM	object	无机盐（kg/pound）
PROTEIN	object	蛋白质（kg/pound）

体成分范围说明

{
  "l": 10, // 下限值
  "m": 15, // 标准值
  "h": 20, // 上限值
  "v": 30.3, // 测量值
  "status": 3 // 状态 1 低，２正常，３高
}

3.3.1-2 S30 获取体成分数据

接口描述：

用于获取体测体成分数据

请求 URL：

http://api.explorer.visbody.com/v1/body/mass

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID
type	否	string	设备类型 1 为 S30 数据类型

返回示例

  {
    "code": 0,
    "data": {
    	"WT": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"FFM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"BFM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"LM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"TBW": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"BMI": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"PBF": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"BMR": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"WHR": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"SM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"TM": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"PROTEIN": {"l":10,"m":15,"h":20,"v":30.3,"status":3}，
		"ICW": {"l":10,"m":15,"h":20,"v":30.3,"status":3},
		"ECW": {"l":10,"m":15,"h":20,"v":30.3,"status":3}
    }
  }

返回参数说明

参数名	类型	说明
WT	object	体重（kg）
FFM	object	去脂体重（kg）
BFM	object	体脂肪量（kg）
LM	object	肌肉量（kg）
TBW	object	身体水分（kg）
BMI	object	身体质量
PBF	object	体脂肪率（%）
BMR	object	基础代谢量（kcal/d）
WHR	object	腰臀比
SM	object	骨骼肌量（kg）
TM	object	无机盐（kg）
PROTEIN	object	蛋白质（kg）
ICW	object	细胞内液（kg）
ECW	object	细胞外液（kg）

体成分范围说明

  {
	"l":10,        // 下限值
	"m":15,        // 标准值
	"h":20,        // 上限值
	"v":30.3,      // 测量值
	"status":3     // 状态 1 低，２正常，３高
  }

3.3.2 获取用户脂肪等级

接口描述：

用于用户脂肪等级

请求 URL：

http://api.explorer.visbody.com/v1/body/state

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

返回示例

{
  "code": 0,
  "data": {
    "va_grade": 9,
    "body_age": 18,
    "body_share": 3
  }
}

返回参数说明

参数名	类型	说明
va_grade	int	内脏脂肪等级(1~~10 正常，10~~14 过高，14~17 高，>17 超高)
body_age	int	身体年龄
body_share	int	体型判断(１虚弱型，２肌肉型，３肥胖型，４健康型)

3.3.3 获取用户身体评分

接口描述：

用于用户身体评分

请求 URL：

http://api.explorer.visbody.com/v1/body/score

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID
scan_type	是	int	扫描类型 1 体测 2 体态

返回示例

{
  "code": 0,
  "data": {
    "score": 98
  }
}

返回参数说明

参数名	类型	说明
score	int	项目评分

3.3.4 获取身体成分调节数据

接口描述：

用于获取身体成分调节数据

请求 URL：

http://api.vrpro3.visbody.com/v1/forecast/adjust

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

返回示例

{
  "code": 0,
  "data": {
    "weight": 1.8,
    "body_fat": -2.6,
    "muscle": -2.6,
    "gr_weight": 75,
    "gr_body_fat": 12.3,
    "gr_muscle": 15.1
  }
}

返回参数说明

参数名	类型	说明
weight	double	体重调节量
body_fat	double	体脂肪调节量
muscle	double	肌肉调节量
gr_weight	double	体重黄金比例
gr_body_fat	double	体脂肪黄金比例
gr_muscle	double	肌肉黄金比例

3.4 获取体态文件及数据

3.4.1 获取体态文件

接口描述：

用于获取体态模型、关键点 json 文件及体态拍照图片

请求 URL：

http://api.explorer.visbody.com/v1/shape/file

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

返回示例

{
  "code": 0,
  "data": {
    "model_url": "MODEL_URL",
    "json_url": "JSON_URL",
    "pic_front_url": "PIC_FRONT_URL",
    "pic_left_url": "PIC_LEFT_URL",
    "pic_right_url": "PIC_RIGHT_URL",
    "pic_top_url": "PIC_TOP_URL",
    "expires_in": 7200
  }
}

返回参数说明

参数名	类型	说明
model_url	string	体态模型文件路径，文件格式.obj
json_url	string	体态关键点 json 文件路径，文件格式.txt (用于体态模型效果关节点展示)
pic_front_url	string	体态正视图图片文件路径，文件格式.jpg
pic_left_url	string	体态左视图图片文件路径，文件格式.jpg
pic_right_url	string	体态右视图图片文件路径，文件格式.jpg
pic_top_url	string	体态顶视图图片文件路径，文件格式.jpg
expires_in	int	文件路径有效时间

3.4.2 获取体态数据

接口描述：

用于获取体态评估身体数据

请求 URL：

http://api.explorer.visbody.com/v1/shape/points

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

返回示例

{
  "code": 0,
  "data": {
    "high_low_shoudler": {
      "val": 15.96,
      "conclusion": "高低肩(左高)",
      "risk": "高低肩可引发颈肩部的慢性疼痛，常伴随脊柱侧弯、骨盆位移、长短腿等情况出现"
    },
    "head_slant": {
      "val": 15.96,
      "conclusion": "正常",
      "risk": "--"
    },
    "head_forward": {
      "val": 15.96,
      "conclusion": "正常",
      "risk": "--"
    },
    "leg_xo": {
      "left_val": 184.3,
      "right_val": 187.2,
      "conclusion": "正常",
      "risk": "--"
    },
    "pelvis_forward": {
      "val": 15.96,
      "conclusion": "正常",
      "risk": "--"
    },
    "left_knee_check": {
      "val": 175.4,
      "conclusion": "正常",
      "risk": "--"
    },
    "right_knee_check": {
      "val": 187.7,
      "conclusion": "正常",
      "risk": "--"
    },
    "round_shoulder_left": {
      "val": 15.6,
      "conclusion": "正常",
      "risk": "--"
    },
    "round_shoulder_right": {
      "val": 15.6,
      "conclusion": "正常",
      "risk": "--"
    },
    "body_slope": {
      "val": 0,
      "conclusion": "正常",
      "risk": "--"
    }
  }
}

返回参数说明

参数名	类型	说明
high_low_shoudler	object	高低肩单位(cm/in)
head_slant	object	头侧歪单位 °
head_forward	objectze	头前引单位 °
leg_xo	object	腿型单位 °
pelvis_forward	object	骨盆前后移单位 °
left_knee_check	object	左膝盖分析单位 °
right_knee_check	object	右膝盖分析单位 °
round_shoulder_left	object	左圆肩单位 °
round_shoulder_right	object	右圆肩单位 °
body_slope	object	身体倾斜单位 °
val	double	测量值
left_val	double	左腿测量值
right_val	double	右腿测量值
conclusion	string	评估结论
risk	string	风险提示正常则显示 "--"

3.4.3 获取围度文件

接口描述：

用于获取体围模型、围度 json、模型围度图片文件

请求 URL：

http://api.explorer.visbody.com/v1/measure/file

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

返回示例

{
  "code": 0,
  "data": {
    "model_url": "MODEL_URL",
    "json_url": "JSON_URL",
    "pic_measure_url": "PIC_MEASURE_URL",
    "expires_in": 7200
  }
}

返回参数说明

参数名	类型	说明
model_url	string	体测模型文件路径，文件格式.obj
json_url	string	围度 json 文件路径，文件格式.json,可配合模型文件展示围度的位置以及数据
pic_measure_url	string	模型围度图片文件路径，文件格式.jpg
expires_in	int	文件路径有效时间

3.4.4 获取围度数据

接口描述：

用于获取体测围度数据

请求 URL：

http://api.explorer.visbody.com/v1/measure/girth

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

返回示例

{
  "code": 0,
  "data": {
    "bust_girth": 0,
    "waist_girth": 0,
    "hip_girth": 0,
    "left_upperArm_girth": 0,
    "right_upperArm_girth": 0,
    "left_thigh_girth": 0,
    "right_thigh_girth": 0,
    "left_calf_girth": 0,
    "right_calf_girth": 0,
    "height": 0,
    "neck_girth": 0,
    "left_min_thigh_girth": 0,
    "right_min_thigh_girth": 0,
    "mid_waist_girth": 0
  }
}

返回参数说明

参数名	类型	说明
neck_girth	double	颈围(cm/in)
left_upper_arm_girth	double	左上臂围(cm/in)
right_upper_arm_girth	double	右上臂围(cm/in)
bust_girth	double	胸围(cm/in)
waist_girth	double	高腰围(cm/in)
mid_waist_girth	double	中腰围(cm/in)
hip_girth	double	臀围(cm/in)
left_thigh_girth	double	左大腿围(cm/in)
left_min_thigh_girth	double	左大腿最小围(cm/in)
right_thigh_girth	double	右大腿围(cm/in)
right_min_thigh_girth	double	右大腿最小围(cm/in)
left_calf_girth	double	左小腿围(cm/in)
right_calf_girth	double	右小腿围(cm/in)
height	double	输入身高(cm/in)

3.5 获取肩部检测数据及结论

接口描述：

用于获取肩部检测数据及结论

请求 URL：

http://api.explorer.visbody.com/v1/shoulder/data

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

返回示例

{
  "code": 0,
  "data": {
    "left_abuction": {
      "val": 25.5,
      "conclusion": "受限",
      "limit": "[150.0°~180.0°]"
    },
    "right_abuction": {
      "val": 25.5,
      "conclusion": "受限",
      "limit": "[150.0°~180.0°]"
    },
    "left_antexion": {
      "val": 45.5,
      "conclusion": "过大",
      "limit": "[120.0°~180.0°]"
    },
    "right_antexion": {
      "val": "--",
      "conclusion": "--",
      "limit": "--"
    },
    "conclusions": [
      {
        "title": "肩关节活动度受限",
        "analysis": "肩关节活动受限，多由肌肉紧张，锁骨肩胛骨活动度不足，头颈肩胛不在中立位等原因引起。会影响正常运动模式（导致运动损伤），以及引起相关病理问题（如肩周炎、含胸驼背、颈椎酸痛等现象），长期忽视易导致各类肩关节疾病的发生。",
        "advice": "找专业人士对具体原因做进一步筛查及治疗。"
      },
      {
        "title": "肩关节活动度过大",
        "analysis": "肩关节活动度过大，多由韧带松弛导致（女性多见），如经常肩部柔韧性训练，也会出现活动过大的现象。",
        "advice": "找专业人士对具体原因做进一步筛查及治疗。"
      }
    ]
  }
}

返回参数说明

参数名	类型	说明
left_abuction	object	外展上举-左手
right_abuction	object	外展上举-右手
left_antexion	object	前屈上举-左手
right_antexion	object	前屈上举-右手
val	double	测量值单位（°）若本项失败则为 --
limit	string	正常范围若本项失败则为 --
conclusion	string	评估结论若本项失败则为 --
conclusions	array	本次检测的所有结论根据检测情况会出现单个结论或多个结论情况
title	string	结论标题
analysis	string	结论分析若所有项均正常则返回空字符串
advice	string	结论建议若所有项均正常则返回空字符串

3.6 获取打印报告

接口描述：

用于获取打印报告文件接口

请求 URL：

http://api.explorer.visbody.com/v1/report

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
scan_id	是	string	扫描 ID

请求头携带参数报告的语言 $headers[] = "language: $vfLanguage; // vfLanguage 可传语言为 en-US(英文) / ja-JP(日文) / zh-CN(中文) 返回示例

  {
    "code": 0,
    "data":{
   				 report_url: "http://rexp-dev.visbody.com/reptfile/report/vr-exp/pdf/en-US/35042104086001-d0e23a52-0095-11ec-9e7e-300ed55249b1.pdf?_upt=9baa05fa1629365732.003"
 					 expires_in: 600
    }
   }

返回参数说明

参数名	类型	说明
data	string	文件下载链接
expires_in	number	有效时间

3.7 维塑返回状态码说明

维塑的接口响应通过 HTTP 状态码及业务状态码区分，业务状态码在 response body 里标记

HTTP 状态码	业务状态码	备注
500	-1	系统繁忙
200	0	请求成功
400	40001	无效的请求路径
400	40002	无效的 vfid 或 secret
400	40003	无效的 token
400	40004	参数错误
400	40005	未绑定设备信息
400	40006	无效的扫描 ID（扫描 ID 不属于该账号或本次扫描未成功或扫描数据过期）
400	40008	无接口权限
400	40009	扫描 ID 已绑定

3.8 合成推送类型与接口关系说明

描述：

第三方客户进行 API 对接配置完成 3.1.3 接口后，用户的每次测量维塑都会通过该接口将相关测量信息推送给第三方，第三方根据测量项目的合成结果 status 访问对应的维塑数据结果接口

测量项目与合成推送类型关系如下：

用户测量项目	合成推送项目
体围	girth_status
体态	eval_status
体成分	bia_status
肩部	eval_shoulder_status
打印报告	pdf_status

合成推送类型与接口关系如下：

合成推送项目	说明	可访问接口
girth_status	体围	3.4.3、3.4.4
eval_status	体态	3.3.3、3.4.1、3.4.2
bia_status	体成分	3.3.1、3.3.2、3.3.3、3.3.4
eval_shoulder_status	肩部检测	3.5
pdf_status	打印报告	3.6

** 3.8.1 接口特别说明：** 打印报告接口，获取报告需要所测量项目中至少有一项合成成功

其他：

合成未成功或未进行项目测量时访问接口会返回状态码 40006

3.9 获取报告历史记录

接口描述：

获取报告历史记录

请求 URL：

http://api.explorer.visbody.com/v1/history/data

请求方式：

参数：

参数名	必选	类型	说明
token	是	string	接口凭证
page	是	string	页码
size	是	string	每页数量
device_id	是	string	设备 ID
phone_number	否	string	手机号码
start_data	否	string	开始时间
end_data	否	string	结束时间

返回示例

  {
  "code": 0,
  "data": {
    "scanIdArray": [
      "34041912080013-fe14541f-bd22-11eb-a249-300ed5517747",
      "34041912080013-034af912-bd22-11eb-a249-300ed5517747",
      "34041912080013-312ed677-bd1e-11eb-beeb-300ed5517747",
      "34041912080013-cadff1c4-bd1d-11eb-beeb-300ed5517747",
      "34041912080013-7e22e106-bd1d-11eb-beeb-300ed5517747",
      "34041912080013-804c181e-bd0e-11eb-beeb-300ed5517747",
      "34041912080013-338d2b02-bd0e-11eb-beeb-300ed5517747",
      "34041912080013-cea3e9a6-bd0c-11eb-beeb-300ed5517747",
      "34041912080013-8a634611-bd0c-11eb-beeb-300ed5517747",
      "34041912080013-737b5c04-bd09-11eb-beeb-300ed5517747"
    ],
    "count": 40
  }
}

返回参数说明

参数名	类型	说明
scanIdArray	arrat	返回用户历史记录数据
count	number	共有多少条数据

iyangsheng/vr-explorer-docs

目录

1.文档介绍

1.1 API 接口概览

1.2 测试数据

2. 接口规则

2.1 命名规则

2.2 版本控制

2.3 POST 提交方式

3. 接口说明

3.1 第三方客户对接说明

1. API 对接

2. 二维码对接

3.1.1 第三方接口凭证获取 :id=third-token

3.1.2 第三方获取二维码接口 :id=get-grcode

3.1.3 维塑推送合成通知消息 :id=notify

3.1.4 第三方状态码

3.2 获取维塑接口凭证 :id=get-token

3.2.1 获取维塑接口凭证

3.2.2 用户信息绑定

3.3 获取体测文件数据

3.3.1 获取体成分数据

3.3.1-1 vr-explorer 获取体成分数据

3.3.1-2 S30 获取体成分数据

3.3.2 获取用户脂肪等级

3.3.3 获取用户身体评分

3.3.4 获取身体成分调节数据

3.4 获取体态文件及数据

3.4.1 获取体态文件

3.4.2 获取体态数据

3.4.3 获取围度文件

3.4.4 获取围度数据

3.5 获取肩部检测数据及结论

3.6 获取打印报告

3.7 维塑返回状态码说明

3.8 合成推送类型与接口关系说明

3.9 获取报告历史记录