目录

公共参数说明

灰度升级公共参数

Health Service Kit服务端提供x-version字段用于灰度,即发布新特性时,不全网铺开,只提供给有限用户体验,并根据x-version配置路由规则,将新版本的App路由到云端服务器中,待beta验证完成后,服务端全网升级,客户端再正式发布版本。

为满足系统灰度升级需求,在请求服务端时可携带如下公共参数:

字段名

类型

是否必填

描述

Authorization

String

是

标准OAuth2鉴权header,格式:Bearer ${access_token}。

Content-type

String

是

目前仅支持application/json,即Http body必须使用JSON格式。

x-version

String

是

接口调用方的软件版本号,即当前客户端版本号。服务端可以基于其进行灰度,具体填写方式参考下方说明。

Accept-Encoding

String

否

如果取值中有gzip,则服务端返回数据会根据数据大小选择是否使用gzip压缩编码。

Content-Encoding

String

否

如果接口Http body较大需要开启gzip时,该Header必须设置为gzip。

x-caller-trace-id

String

否

请求跟踪ID,用于串联服务调用方与服务端整体请求链条,建议携带。

x-client-id

String

否

开放联盟分配的应用标识,服务端可以基于其进行灰度路由。

说明:

x-version字段格式填写规则:

因为不同的App可能定义相同的版本号,比如都命名为20.0.3.309,并且同一种类型App还会分成Android和iOS系统。因此为了能够针对某个具体版本的App进行灰度验证。x-version字段的格式为“操作系统_app类型_app上呈现给用户看的版本号”。

灰度发布的公共参数将携带在请求的Http Header中,样例如下所示:

POST /healthkit/v2/dataCollectors
Host: domain
Content-type: application/json
Accept-Language: zh-CN,zh
Accept-Encoding: gzip, deflate
Connection: keep-alive
x-version: and_wear_2.0.0.301
Authorization: Bearer XXX