写点什么

【荣耀开发者服务平台—百亿曝光扶持等你来】智慧服务内容接口卡片接入指南

  • 2022 年 9 月 05 日
    北京
  • 本文字数:2094 字

    阅读完需:约 7 分钟

荣耀开发者服务平台(HONOR Developers)是荣耀面向开发者的统一生态入口,通过聚合周边内外部系统,分全球多站点部署,为全球开发者提供业务全生命周期的商业支撑服务。


平台可为软硬件合作伙伴带来三大应用场景服务,包括主动服务的场景化体验智慧服务,智能协同的跨设备互联的智慧生态以及应用与游戏出海服务。同时,荣耀帐号服务、推送服务、运动健康等开放能力和业务也提供了多样化的合作选择。


当前荣耀智慧服务百亿级曝光扶持计划正火热进行中~


一、接入流程

荣耀智慧服务为开发者提供一站式接入服务能力,和全场景、多终端、多入口的 AI 分发能力,为开发者提高业务推广效率,同时给用户提供便捷、贴心、智能的服务体验。目前包含四种接入类型:快捷服务、快应用卡片、安卓应用卡片、内容接口卡片,呈现显示包括卡片和图标等,本文将提供内容接口卡片接入指南。


二、接口开发指南

1.性能要求

(1)接口 TPS(每秒请求次数)要求:要求三方接口的 TPS>2000。

(2)接口时延要求:在最大 TPS 情况下,99%的请求时延小于 150 毫秒。

(3)接口稳定性要求:调用成功率> 99.99%。全年服务中断不超过 20 分钟。

(4)可靠性要求:系统需要支持水平扩容,满足业务发展。

2. 安全要求

2.1 接口协议

接口协议:HTTPS。

HTTPS 证书要求:使用合法 CA 颁发的证书,不允许使用自签名证书。

数据格式:请求和响应采用 Json 的报文格式。

请求方法:POST 方式。

报文压缩:响应消息应开启 gz 压缩,减少带宽开销。

长连接:为避免反复 TLS 建连的开销,支持 http:keep-alive,荣耀服务器使用长连接的方式进行调用。

2.2 接口认证方式

  • AK/SK 的身份认证方式

  • Header 认证

  • OAuth Client 模式认证

2.2.1 AK/SK 认证


(1)防重放出于防重放攻击的需要,服务端应该校验报文中的 ts 和当前实际时间相差在一个范围内。例如:校验服务器侧时间戳与请求报文中的时间戳差值的绝对值(ABS),小于 15 分钟。

(2)签名算法 Sign 的计算代码示例,服务器侧可以基于 ts 计算该 sign,与请求中的 sign 比对是否相等,以达到验证客户端身份的目的。

String secret = "密钥";
String ts = "从消息头中获取ts";
Mac mac = Mac.getInstance("HmacSHA256");
SecretKey secretKey = new SecretKeySpec(secret.getBytes(SystemCharsets.UTF_8), "HmacSHA256");
mac.init(secretKey);
byte[] byteHMAC = mac.doFinal(ts.getBytes(SystemCharsets.UTF_8));
String sign = new String(Base64.encodeBase64(byteHMAC), StandardCharsets.UTF_8);
复制代码

例如:

secret 为 2e3b71f5def64d95a727314f028bf5aa, ts为1547630863716时,签名结果应该为: 6lFqepUu79KSxVCsrXyB/aLVFIdutsTLLx1cZjxDE4I=
复制代码

2.2.2 Header 认证

开发者在荣耀服务开放平台上配置对应的 key 及 value 值,支持多个。



2.2.1 OAuth Client 模式认证

OAuth2.0 协议规范,可访问 OAuth 2.0 官方网站 https://oauth.net/2/

当前仅支持 Client 模式

3. 接口响应大小限制

(1)接口响应总大小不超过 1MB。

(2)其余字段的返回大小详见具体描述。

(3)接口中的资源链接(如图片链接、音频链接等)要求是 HTTPS 协议。

4. 隐私要求

提供隐私通知(notice),用于在用户使用服务时呈现。

其他的隐私要求,在双方合作协议中补充。

5. 响应错误描述

业务结果码(errorCode)和结果描述参考:


6. 公共请求参数/响应参数

6.1 服务履行接口

基本信息

方法:POST

说明:调用您在荣耀开发者联盟上录入的 Fulfillment 的 URL 地址,携带服务履行相关信息

请求头域


6.2 请求参数:FulfillmentReq

请求的 body 信息如下,slots 为各垂类接口定义信息,具体内容参考各垂类接口定义

消息体样例

{	"endpoint": {		"device": {			"base": {				"deviceId": "string",				"deviceType": "phone"			},			"presentation": {				"screenOrientation": "horizontal",				"net": "wifi",				"location": {					"longitude": "string",					"latitude": "string",					"locationSystem": "WGS84"				}			}		},		"locale": "zh-CN",		"countryCode": "zh",		"timeZone": "+0800",		"localTime": "string"	},	"inquire": {		"inquireId": "string",		"intent": {			"serviceId": "string",			"intentName": "string",			"status": "online",			"slots": {}<!--具体槽位信息见不同垂类接口定义-->		}	}} 
复制代码

6.3 响应参数:FulfillmentResp

响应信息如下,templateContent 为各垂类接口响应信息,具体内容参考各垂类接口定义

消息体样例

{	"reply": {		"commands": [{			"head": {				"namespace": "string",				"name": "string"			},			"body": {				"displayTemplate": "string",				"templateType": "string",				"templateInstance": "string",				"templateContent": {}<!--具体响应见不同垂类接口定义-->			}		}]	},	"code": "0",	"message": "ok",	"errorCode": "string",	"errorMessage": "string",	"version": "string"}
复制代码


了解更多详情,欢迎访问荣耀荣耀开发者服务平台官网:https://developer.hihonor.com/

7 月 20 日 - 10 月 20 日,参与荣耀开发者服务平台注册认证,更多好礼相送。


官方联系方式:

官方微信:HONOR_Developer

官方邮箱:Developers_BD@hihonor.com

用户头像

还未添加个人签名 2022.06.28 加入

第一时间发布荣耀开发者服务平台相关资讯,共享行业资源,合作共赢。荣耀开发者服务平台是荣耀面向开发者的统一生态入口,支持一站式接入荣耀软件、硬件生态合作,助力开发者商业成功。

评论

发布
暂无评论
【荣耀开发者服务平台—百亿曝光扶持等你来】智慧服务内容接口卡片接入指南_手机_荣耀开发者服务平台_InfoQ写作社区