第四包內(nèi)容庫接口設(shè)計

1、第一章 接口設(shè)計第一節(jié) 接口概述內(nèi)容匯聚分為通聯(lián)匯聚、全臺網(wǎng)匯聚以及互聯(lián)網(wǎng)匯聚，為了使各匯聚盡可能，繼承荔枝云項目 OPEN 化的特點，匯聚的接口設(shè)計就必須符合低耦合、涵蓋廣、可擴展、使用簡單等特點，基于以上要求內(nèi)容考慮將所有入庫素材類型進行分析、聚合、抽象、概括后設(shè)計了一套的標準接口協(xié)議，每個對象都預留了擴展字段方便以后臨時增加，對象用樹形的結(jié)構(gòu)明確顯示了整個接口協(xié)議的，方便大家的使用。內(nèi)容庫入庫接口服務(wù)本身采用通用的 rest 接口方式，屬于完全開放式調(diào)用協(xié)議，同時基于 HTTP 請求，支持各種客戶端調(diào)用語言，使得讓任何系統(tǒng)接入都輕而易舉。內(nèi)容庫入庫接口通過定制支持 PAAS，將與 PAA

2、S個流程交互封裝起來，只針對外一個接口，把整個流程簡單化，流程圖如下：1、接口調(diào)用系統(tǒng)先將文件傳到預先根據(jù)系統(tǒng)配置好的 FTP 賬號上2、通過調(diào)用入庫服務(wù)的REST 接口，觸發(fā)內(nèi)容庫流程3、REST 接口調(diào)用方式 HTTP4、地址Thttp:/IP:端口nworkflow/rest/addTask5、參數(shù)說明方式二、文件描述 XML 文件掃描方式1、將文件以及文件描述XML 文件一起傳到預先根據(jù)系統(tǒng)配置好的 FTP 賬號上2、入庫服務(wù)會定時掃描 FTP 對應(yīng)文件夾中的XML 文件后，觸發(fā)內(nèi)容庫流程方式一方式二名稱說明必填數(shù)據(jù)類型長度message請求消息體（將協(xié)議內(nèi)容作為一個大字段參數(shù)，編碼后

3、傳入，協(xié)議內(nèi)容后面單獨介紹）YstringClob應(yīng)用描述資源涵蓋了所有全內(nèi)容庫需要匯聚的元素據(jù)類型包，根據(jù)素材資源的實際類型選擇相對應(yīng)的節(jié)點進行填寫，完成接口的描述數(shù)據(jù)元素說明3.21.1名稱說明必填可重復數(shù)據(jù)類型長度ID文稿IDYNstring30Type類型：NNstring32Title標題YNstring20SubTitle副標題NNstring20Keywords關(guān)鍵字YNstring20ElementsOfNews要素NNElementsOfNewsType20要素類型（ElementsOfNewsType）數(shù)據(jù)元素說明關(guān)聯(lián)類型（AssoteActorType）應(yīng)用描述在接口調(diào)用

4、過程中，會經(jīng)常出現(xiàn)相關(guān)業(yè)務(wù)的信息數(shù)據(jù)項，如、業(yè)務(wù)角色等信息，本數(shù)據(jù)結(jié)構(gòu)為以上相關(guān)信息提供數(shù)據(jù)結(jié)構(gòu)名稱說明必填可重復數(shù)據(jù)類型長度Date發(fā)生時間,格式為yyyy-MM-dd hh:mm:Nstring30Location發(fā)生地點NNstring20Keys主要人物NNstring20Content內(nèi)容NNstring20MAssoteDates相關(guān)日期（參公共數(shù)據(jù)AssoteDatesType 定義說明）NNAssoteDa tesTypeAssoteActors相關(guān)業(yè)務(wù)信息集（參AssoteActorsType 公共數(shù)據(jù)結(jié)構(gòu)說明）NYAssoteAc torsTypeRelMeterial關(guān)聯(lián)

5、素材NNMeterialEntityCopyRightInfo信息NNCopyRightIn foTypeExtendAttributes擴展屬性集（參 ExtendAttributesType公共數(shù)據(jù)結(jié)構(gòu)說明）NYExtendAttri butesTypeSerialNo在串聯(lián)單中的序號NN定義，支持多個信息，以提高接口數(shù)據(jù)結(jié)構(gòu)和編程實現(xiàn)的重用。數(shù)據(jù)元素說明關(guān)聯(lián)集類型（AssoteActorsType）應(yīng)用描述關(guān)聯(lián)的復數(shù)形式。數(shù)據(jù)元素說明關(guān)聯(lián)日期類型（AssoteDateType）應(yīng)用描述名稱說明必填可重復數(shù)據(jù)類型長度AssoteActor信息結(jié)構(gòu)（參 ExtendAttributesTyp

6、e 說明）YYAssoteActorType名稱說明必填可重復數(shù)據(jù)類型長度Assote Actor信息結(jié)構(gòu)YYType類型（Director：主編、 ScriptEditor：稿件編輯、 NLEProgramEditor：編輯、Technin：技術(shù)、ScriptAuditor：稿件、NLEProgramAudit：節(jié)目、Reporter：采訪、 Executor：執(zhí)行人、Creator：創(chuàng)建人）YNstring20Code的編碼YNstring20NameNNstring20Description備注NNstring30用于交互與相關(guān)的各種日期類型信息，如：發(fā)生時間、稿件創(chuàng)建時間、最后修改時間

7、、時間等。數(shù)據(jù)元素說明關(guān)聯(lián)日期集類型（AssoteDatesType）應(yīng)用描述關(guān)聯(lián)日期的復數(shù)形式。數(shù)據(jù)元素說明擴展屬性（ExtendAttributeType）名稱說明必填可重復數(shù)據(jù)類型長度AssoteDate關(guān)聯(lián)日期（參 AssoteDate Type 說明）YYAssoteDateType名稱說明必填可重復數(shù)據(jù)類型長度DateType日期類型（Event：發(fā)生時間、Create：創(chuàng)建時間、LastModified：最后修改時間、Publish：、Audit：時間、 PreBroadcast：預播時間、Broadcast：時間、 erView：采訪日期）YNstring20TypeName類

8、型說明（發(fā)生時間、創(chuàng)建時間、最后修改時間、 、 時間、預播時間、播出時間）NNstring30DateValue日期取值（format:yyyy-mm-dd hh24:mi:ss）YNstring20應(yīng)用描述為了提高規(guī)范應(yīng)對各務(wù)應(yīng)用場景，滿足各種業(yè)務(wù)需求，特提供擴展屬性字段用與業(yè)務(wù)擴展需要，其中 AttributeID 根據(jù)具體應(yīng)用需要自行約定，AttributeValue 則填入 ID 所代表的業(yè)務(wù)數(shù)據(jù)的值。數(shù)據(jù)元素說明擴展屬性（ExtendAttributesType）應(yīng)用描述擴展屬性的復數(shù)形式。數(shù)據(jù)元素說明信息（CopyRightInfoType）說明：此數(shù)據(jù)結(jié)構(gòu)為預留設(shè)計考慮，具體信息

9、數(shù)據(jù)項以臺方最終發(fā)布的為準。應(yīng)用描述信息或素材的信息。名稱說明必填可重復數(shù)據(jù)類型長度AttributeID屬性 ID，根據(jù)業(yè)務(wù)需要約定YNstring20AttributeName屬性名稱NNstring20AttributeValue屬性取值，根據(jù)業(yè)務(wù)需要填寫YNstring20數(shù)據(jù)元素說明關(guān)聯(lián)素材實體（MeterialEntity）應(yīng)用描述素材關(guān)聯(lián)信息實體。數(shù)據(jù)元素說明名稱說明必填可重復數(shù)據(jù)類型長度AuthorizationType類型（ 、在時段范圍之內(nèi)使用、在次數(shù)范圍之內(nèi)使用）YNstring20AuthorizationAction的操作（、帶標使用、只讀、可裁剪）YNstring20AuthorizationCount使用次數(shù)NNAuthorizationDuration使用時段（參 Duration公共數(shù)據(jù)結(jié)構(gòu)元素說明）NNDurationT ypeDescription備注信息YNstring40名稱說明必填可重復數(shù)據(jù)類型長度MaterialGUID素材GUIDYNstring60Title標題NNstring60Length時長（秒）NNlongInPo素材入點(幀)NNstring60OutPo素材出點(幀)NNstring60KeyFrame關(guān)鍵幀