文档中心 > YunOS开放平台

轻服务数据接入

更新时间:2016/12/24 访问次数:4258

用户使用轻服务,是由YunOS提供展示框架,由您提供一个接口传送数据。数据接入,是轻服务接入最重要的环节。

一、数据接入方式

数据接入有2种方式供选择:API透传接口和META数据。使用场景包括左一屏首页、推荐广场、轻服务主页,用户均可进行订阅、刷新、浏览、点击、添加快捷方式等操作,点击后都是进入您的H5页面或Native APP页面。

  API透传接口 Meta数据
开发过程

需要选择合适模板;

需要根据内容拉取及翻页策略进行开发

可以选择合适样式的模板,如果不选择,则YunOS使用默认模板
数据拉取  实时拉取,拉取频率由用户操作决定。用户拉取内容,没有次数限制。  定时拉取,拉取频率可以在META数据接入页约定。YunOS先将您的数据进行定时缓存,然后封装成轻服务接口。用户拉取内容,没有次数限制。
轻服务主页场景 内容展示顺序由开发者决定,参见内容拉取及翻页策略 内容展示顺序根据内容更新时间gmt_modified和YunOS推荐算法决定
推荐广场场景 默认会将API入参的val不传或者传空,您的接口需要据此返回精品数据 请联系YunOS运营同学进行配置
负一屏信息流场景 默认会将API入参的val不传或者传空,您的接口需要据此返回精品数据。需要用户订阅。 用户订阅与否,都经过YunOS推荐算法进行展示,带来更多的流量曝光和点击,不需要您额外操作

1.API透传接口

您可以通过人工设置或者自有算法来控制API透传接口的内容展示列表。用户在使用轻服务时,会调用API透传接口,返回值直接展示给用户。

2.Meta数据

YunOS首先将您的数据进行定时缓存,然后由YunOS封装成轻服务接口,提供给用户使用。内容展示顺序,根据内容更新时间和YunOS推荐算法决定。

用户在使用轻服务时,YunOS通过内容更新时间和推荐算法,将内容展示给用户,给您带来更多的流量曝光和点击。

二.META数据方式

1.接口开发

请根据META数据接入说明META数据接入开发指南META数据接入字段标准开发Meta数据接口。如果您对展示模板有要求,可查看轻服务模板,并在接入字段more字段中,填写tplId这一扩展字段。

2.服务器设置及测试

示例图如下,详细过程请参见Meta数据接入指南

三.API透传接口方式

1.接口开发

您需要选择合适的轻服务模板,根据API接口参数说明翻页策略轻服务开发指南,开发API接口提供数据,并填写服务器地址+约定参数。该方式技术门槛较低,开发简单。

CloudCard会将用户请求数据通过出口网关发送给开发者服务器,调用您开发的接口,获得返回值,传给用户,以信息流形式进行展示。 

2. 数据接口服务器设置

数据接口开发完成后,“控制台”->"轻服务管理"->数据接入服务器设置页面 进行配置。CloudCard将会调用您的接口,并将返回数据,以信息流形式展示给用户。其中,

约定参数:CloudCard调用接口拉取轻服务数据时,传递的约定入参,选填。您可以在此重新约定API接口参数说明中pageSize的默认值,也可以自定义添加接口调用的来源信息等。(注:什么是接口入参的pageSize?怎么正确使用?

签名Key:用来做请求参数签名用,避免参数被篡改。

加密秘钥:用来加密来回传输的数据,保证数据安全。

消息加解密方式:如果开发者选择 “安全模式”,则接口中签名和加密同时做;如果开发者选择“明文模式”,则接口中只做签名,防止请求参数被篡改。

3.测试接口

点击测试接口按钮,将会访问您的服务器网关地址,带上约定参数,调用接口,校验接口是否符合 API接口参数说明 的要求。

  • 不填约定参数,接口测试只校验返回的错误码
  • 填了约定参数,接口测试校验返回的错误码和数据格式 

(1).约定参数不填

此时只校验接口返回的错误码code是否为200。如果校验通过,则前端页面的“下一步”按钮变为可点击状态;如果校验不通过,请根据API接口参数说明 的要求, 检查是哪种错误。

(2).约定参数填写

YunOS测试工具带上约定参数,调用接口,校验接口返回值中tplId和jsonModel等字段。接口调用成功,则前端页面弹框会展示接口返回的json数据,并且“下一步”按钮变为可点击状态。

如果校验出错,请检查是否有字段缺失,返回值中的tplId和jsonModel是否为空,以及jsonModel中的tplId是否为空;检查返回的数据格式是不是SDK中BaseModel的类型。

进行正式发布时,约定入参选填,您可以在此重新约定API接口参数说明中pageSize的默认值,也可以自定义添加接口调用的来源信息等。

 

 

延伸阅读:

轻服务用户行为反馈的开放说明

轻服务数据接口如何测试,调用出错怎么办?

轻服务接入后,用户可以在哪些场景使用到?

META数据接入说明

如何使用已接入的META数据创建轻服务?

 

FAQ

关于此文档暂时还没有FAQ
返回
顶部