第四包内容库接口设计

1、第一章 接口设计第一节 接口概述内容汇聚分为通联汇聚、全台网汇聚以及互联网汇聚，为了使各汇聚尽可能，继承荔枝云项目 OPEN 化的特点，汇聚的接口设计就必须符合低耦合、涵盖广、可扩展、使用简单等特点，基于以上要求内容考虑将所有入库素材类型进行分析、聚合、抽象、概括后设计了一套的标准接口协议，每个对象都预留了扩展字段方便以后临时增加，对象用树形的结构明确显示了整个接口协议的，方便大家的使用。内容库入库接口服务本身采用通用的 rest 接口方式，属于完全开放式调用协议，同时基于 HTTP 请求，支持各种客户端调用语言，使得让任何系统接入都轻而易举。内容库入库接口通过定制支持 PAAS，将与 PAA

2、S个流程交互封装起来，只针对外一个接口，把整个流程简单化，流程图如下：1、接口调用系统先将文件传到预先根据系统配置好的 FTP 账号上2、通过调用入库服务的REST 接口，触发内容库流程3、REST 接口调用方式 HTTP4、地址Thttp:/IP:端口nworkflow/rest/addTask5、参数说明方式二、文件描述 XML 文件扫描方式1、将文件以及文件描述XML 文件一起传到预先根据系统配置好的 FTP 账号上2、入库服务会定时扫描 FTP 对应文件夹中的XML 文件后，触发内容库流程方式一方式二名称说明必填数据类型长度message请求消息体（将协议内容作为一个大字段参数，编码后

3、传入，协议内容后面单独介绍）YstringClob应用描述资源涵盖了所有全内容库需要汇聚的元素据类型包，根据素材资源的实际类型选择相对应的节点进行填写，完成接口的描述数据元素说明3.21.1名称说明必填可重复数据类型长度ID文稿IDYNstring30Type类型：NNstring32Title标题YNstring20SubTitle副标题NNstring20Keywords关键字YNstring20ElementsOfNews要素NNElementsOfNewsType20要素类型（ElementsOfNewsType）数据元素说明关联类型（AssoteActorType）应用描述在接口调用

4、过程中，会经常出现相关业务的信息数据项，如、业务角色等信息，本数据结构为以上相关信息提供数据结构名称说明必填可重复数据类型长度Date发生时间,格式为yyyy-MM-dd hh:mm:Nstring30Location发生地点NNstring20Keys主要人物NNstring20Content内容NNstring20MAssoteDates相关日期（参公共数据AssoteDatesType 定义说明）NNAssoteDa tesTypeAssoteActors相关业务信息集（参AssoteActorsType 公共数据结构说明）NYAssoteAc torsTypeRelMeterial关联

5、素材NNMeterialEntityCopyRightInfo信息NNCopyRightIn foTypeExtendAttributes扩展属性集（参 ExtendAttributesType公共数据结构说明）NYExtendAttri butesTypeSerialNo在串联单中的序号NN定义，支持多个信息，以提高接口数据结构和编程实现的重用。数据元素说明关联集类型（AssoteActorsType）应用描述关联的复数形式。数据元素说明关联日期类型（AssoteDateType）应用描述名称说明必填可重复数据类型长度AssoteActor信息结构（参 ExtendAttributesTyp

6、e 说明）YYAssoteActorType名称说明必填可重复数据类型长度Assote Actor信息结构YYType类型（Director：主编、 ScriptEditor：稿件编辑、 NLEProgramEditor：编辑、Technin：技术、ScriptAuditor：稿件、NLEProgramAudit：节目、Reporter：采访、 Executor：执行人、Creator：创建人）YNstring20Code的编码YNstring20NameNNstring20Description备注NNstring30用于交互与相关的各种日期类型信息，如：发生时间、稿件创建时间、最后修改时间

7、、时间等。数据元素说明关联日期集类型（AssoteDatesType）应用描述关联日期的复数形式。数据元素说明扩展属性（ExtendAttributeType）名称说明必填可重复数据类型长度AssoteDate关联日期（参 AssoteDate Type 说明）YYAssoteDateType名称说明必填可重复数据类型长度DateType日期类型（Event：发生时间、Create：创建时间、LastModified：最后修改时间、Publish：、Audit：时间、 PreBroadcast：预播时间、Broadcast：时间、 erView：采访日期）YNstring20TypeName类

8、型说明（发生时间、创建时间、最后修改时间、 、 时间、预播时间、播出时间）NNstring30DateValue日期取值（format:yyyy-mm-dd hh24:mi:ss）YNstring20应用描述为了提高规范应对各务应用场景，满足各种业务需求，特提供扩展属性字段用与业务扩展需要，其中 AttributeID 根据具体应用需要自行约定，AttributeValue 则填入 ID 所代表的业务数据的值。数据元素说明扩展属性（ExtendAttributesType）应用描述扩展属性的复数形式。数据元素说明信息（CopyRightInfoType）说明：此数据结构为预留设计考虑，具体信息

9、数据项以台方最终发布的为准。应用描述信息或素材的信息。名称说明必填可重复数据类型长度AttributeID属性 ID，根据业务需要约定YNstring20AttributeName属性名称NNstring20AttributeValue属性取值，根据业务需要填写YNstring20数据元素说明关联素材实体（MeterialEntity）应用描述素材关联信息实体。数据元素说明名称说明必填可重复数据类型长度AuthorizationType类型（ 、在时段范围之内使用、在次数范围之内使用）YNstring20AuthorizationAction的操作（、带标使用、只读、可裁剪）YNstring20AuthorizationCount使用次数NNAuthorizationDuration使用时段（参 Duration公共数据结构元素说明）NNDurationT ypeDescription备注信息YNstring40名称说明必填可重复数据类型长度MaterialGUID素材GUIDYNstring60Title标题NNstring60Length时长（秒）NNlongInPo素材入点(帧)NNstring60OutPo素材出点(帧)NNstring60KeyFrame关键帧