《專業內容資源聚合服務平臺接入規范》_第1頁
《專業內容資源聚合服務平臺接入規范》_第2頁
《專業內容資源聚合服務平臺接入規范》_第3頁
《專業內容資源聚合服務平臺接入規范》_第4頁
《專業內容資源聚合服務平臺接入規范》_第5頁
已閱讀5頁,還剩12頁未讀 繼續免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

ICS01.140.40

CCSA19

CADPA

中國音像與數字出版協會團體標準

T/CADPAXX—XXXX

專業內容資源聚合服務平臺接入規范

Accessspecificationforaggregatedserviceplatformsofprofessionalcontent

resource

(征求意見稿)

(本草案完成時間:2023-10-8)

在提交反饋意見時,請將您知道的相關專利連同支持性文件一并附上。

XXXX-XX-XX發布XXXX-XX-XX實施

中國音像與數字出版協會發布

T/CADPAXX—XXXX

專業內容資源聚合服務平臺接入規范

1范圍

本文件規定了專業內容資源聚合服務模式、接入聚合服務平臺方式、要求、接口、流程和服務平臺

的質量檢測方法。

本文件適用于專業內容資源接入方接入聚合服務平臺的管理與服務。

2規范性引用文件

下列文件中的內容通過文中的規范性引用而構成本文件必不可少的條款。其中,注日期的引用文件,

僅該日期對應的版本適用于本文件;不注日期的引用文件,其最新版本(包括所有的修改單)適用于本

文件。

GB/T7408數據元和交換格式信息交換日期和時間表示法

GB/T20009信息安全技術數據庫管理系統安全評估準則

GB/T20272信息安全技術操作系統安全技術要求

GB/T20273信息安全技術數據庫管理系統安全技術要求

GB/T20274.2信息安全技術信息系統安全保障評估框架第2部分:技術保障

GB/T20274.3信息安全技術信息系統安全保障評估框架第2部分:管理保障

GB/T30994關系數據庫管理系統檢測規范

GB/T31072科技平臺統一身份認證

GB/T38633信息技術大數據系統運維和管理功能要求

GB/T37025信息安全技術物聯網數據傳輸安全技術要求

GB/T36626信息安全技術信息系統安全運維管理指南

CY/T114電子圖書質量檢測方法

T/CADPAXX專業內容資源聚合服務元數據

3術語和定義

下列術語和定義適用于本文件。

3.1

聚合服務平臺aggregatedserviceplatform

提供專業內容資源開放檢索、開放授權和開放交易的服務系統。

3.2

接入方accessparty

向聚合服務平臺提供專業內容資源信息的出版及相關方。

3.3

開放搜索系統opensearchsystem

建立在聚合服務平臺上,為用戶提供專業內容資源元數據檢索的服務系統。

3.4

開放授權系統openauthorizationsystem

通過聚合服務平臺賬戶登錄的,為用戶便捷登錄和跨系統訪問的服務系統。

3.5

開放交易系統opentradingsystem

利用聚合服務平臺的付費和鑒權功能,為用戶提供規范并可信交易的服務系統。

3.6

專業內容資源professionalcontentresource

具備專業領域應用價值并經過編輯加工和審校的成品數據。

1

T/CADPAXX—XXXX

4接入服務原則

4.1自愿性

專業內容資源接入方可自愿接入或退出聚合服務平臺。

4.2專業性

接入聚合服務平臺的專業內容資源覆蓋各專業領域并具有使用價值。

4.3規范性

聚合服務平臺提供的服務充分考慮行業特點和用戶習慣,對接入的專業內容資源實施規范化管理。

4.4安全性

聚合服務平臺具有完善的安全管理機制,對專業內容資源進行加密保護,確保數據存儲安全、傳輸

和系統的安全。

5接入服務模式

5.1接入模型

專業內容資源由出版及相關方提供,匯聚到聚合服務平臺,聚合服務平臺對聚合資源信息進行管理,

實現內容資源信息聚合服務。專業內容資源聚合服務平臺接入的服務模型構成如下:

a)接入資源:聚合服務平臺接入內容資源包括圖書、期刊、科技報告、學位論文、會議論文、

課程和科學數據集等元數據信息;

b)接入方式:專業內容資源接入聚合服務平臺的方式包括資源接入和系統接入;

c)接入管理:聚合服務平臺對接入的專業內容資源進行處理和管理,包括數據清洗、加工工具

開發、知識圖譜研制、主題詞表編制等方式,對專業內容資源進行統一規范和管理;

d)接入服務:經過聚合服務平臺方的加工與管理,對接入的專業內容資源進行統一服務,包括

聚合信息檢索、選題信息服務、專題信息服務和學者信息服務等。

專業內容資源聚合服務平臺接入服務模型如圖1所示。

接入服務聚合信息檢索選題信息服務專題信息服務學者信息服務

數據清洗加工工具知識圖譜主題詞表其他管理方式

接入管理

接入方式資源接入系統接入

接入資源

專業圖書資源專業期刊資源學位論文資源專業課程資源科學數據集資源其他專業資源

圖1接入服務模型

5.2接入方式

5.2.1資源接入

2

T/CADPAXX—XXXX

將專業內容資源接入聚合服務平臺的“開放搜索系統”,聚合服務平臺為用戶提供統一的標準化

的服務方式。

5.2.2系統接入

采用內嵌方式將專業內容資源接入到聚合服務平臺基礎系統的服務方式,包括接入開放搜索系統、

開放授權系統和開放交易系統。

6接入服務流程

6.1對接流程

專業內容資源接入方可根據應用需求選擇接入方式:

a)選擇資源接入方式:創建資源接入應用,接入開放搜索系統,接入完成后測試接入結果,測

試結果成功完成接入,測試結果失敗修改接入程序,直至成功完成接入;

b)選擇系統接入方式:創建系統接入應用,接入開放搜索系統、開放授權系統和開放交易系統。

測試結果成功完成接入,測試結果失敗修改接入程序,直至成功完成接入。

專業內容資源與聚合服務平臺對接的基本流程如圖2所示,對接示例見附錄A。

對接開始

創建資源接入應用創建系統接入應用

接入

接入

開放搜索系統

開放搜索系統

開放授權系統

開放賬務系統

失敗

失敗

檢測接入結果

成功

對接完成

圖2對接流程

6.2對接模式

接入方根據接入方式對接聚合服務平臺的相應系統,對接成功后聚合服務平臺向用戶進行專業內容

資源精準化推薦,用戶可在聚合服務平臺使用接入服務,并可在聚合服務平臺直接訪問接入方并使用專

業內容資源:

a)接入方提供元數據收割接口被聚合服務平臺開放搜索系統調用,實現元數據的收割;

b)接入方在統一認證系統調用聚合服務平臺開放授權系統接口,實現用戶的便捷登錄;

c)接入方在專業內容資源訪問權限校驗模塊調用聚合服務平臺開放交易系統,實現用戶訪問專

業內容資源的權限校驗。

對接模式如圖3所示。

聚合服務平臺

開放搜索系統開放授權系統開放交易系統專業內容資源精準化推薦

接入服務使用

利用聚合服務平臺

元數據收割用戶便捷登錄

付費和鑒權

元數據收割專業內容資源專業內容資源使用

統一認證系統

接口訪問權限校驗

聚合服務平臺用戶

接入方

3

T/CADPAXX—XXXX

圖3對接模式

7接入服務接口

7.1技術接口數據結構

聚合服務平臺以HTTP形式提供接口,對于請求方法為POST的接口支持數據以JSON格式輸入,如無特

殊說明接口數據以JSON格式輸出。

7.2開放搜索系統接口

7.2.1開放搜索系統接口調用

由接入方提供“元數據收割接口”并向聚合服務平臺提供接口地址,開放搜索系統主動調用接入

方接口完成元數據收割。調用流程如下:

a)通過不同參數獲取不同專業內容資源信息,接入方系統返回相應結果;

b)獲取專業內容資源數據庫支持的數據格式信息等,接入方系統返回相應結果;

c)分批獲取專業內容資源,接入方系統查詢接入方的專業內容資源數據庫,并返回相應專業內

容資源信息,接入方系統查詢后將結果返回至開放搜索系統;

d)接入方系統根據開放搜索系統傳遞的專業內容資源唯一標識符,在接入方專業內容資源數據

庫中檢索,并返回相應結果;

開放搜索系統元數據收割接口調用流程如圖3所示。

聚合服務平臺接入方專業內容

接入方系統

開放搜索系統資源數據庫

獲取專業內容資源數據庫信息

返回結果

獲取專業內容資源數據庫支持的數據格式

返回結果

循環

獲取專業內容資源信息集合

獲取專業內容資源信息集合

返回專業內容資源信息集合

返回結果

選擇獲取單個專業內容資源信息

部分需單獨獲取獲取專業內容資源

專業內容資源時

返回專業內容資源

返回結果

選擇獲取專業內容資源唯一標識符集合

部分僅需獲取專業獲取專業內容資源標識符集合

內容資源唯一標識

符時返回專業內容資源標識符集合

返回結果

圖4開放搜索系統元數據收割接口調用流程

7.2.2元數據收割接口描述

開放搜索系統的接入方提供“元數據收割接口”,接口描述見表1。

表1元數據收割接口描述

接口描述說明

函數名稱oai

功能描述接口由接入方提供,開放搜索系統主動調用接入方的元數據收割接口完成元數據收割。

HTTP請求方法POST

4

T/CADPAXX—XXXX

接口描述說明

1)請求動作

輸入參數2)專業內容資源格式

3)繼續令牌

1)請求信息

2)接口響應時間

輸出參數

3)專業內容資源信息

4)繼續令牌

7.2.3元數據收割接口參數

元數據收割接口參數見表2~7。

表2元數據收割接口參數

參數名稱輸入/輸出中文名稱數據類型長度說明

GetRecord-獲取單個專業內容資源信息

Identify-獲取專業內容資源數據庫信息

ListMetadataFormats-獲取專業內容資源數據

verb輸入請求動作字符串20庫支持的數據格式

ListRecords-獲取專業內容資源信息集合

ListIdentifiers-獲取專業內容資源唯一標識

符和部分基礎信息集合

專業內容資源唯一在verb為“GetRecord”時需提供,專業內容資源

identifier輸入——

標識符唯一標識符

接入方提供的專業內容資源格式,僅第一次訪問

metadataPrefix輸入專業內容資源格式字符串10

時輸入

Verb為“ListRecords”、“ListIdentifiers”時

可選擇提供,用于關聯多次被訪問請求的令牌,

resumptionToken輸入繼續令牌字符串50

第一次訪問時不輸入,值為上一個發送不完整列

表的請求返回的resumptionToken

在verb為“ListRecords”和“ListIdentifiers”

獲取專業內容資源

from輸入字符串20時可選提供,用于篩選獲取專業內容資源信息時

數據時間下限

間下限

在verb為“ListRecords”和“ListIdentifiers”

獲取專業內容資源

until輸入字符串20時可選提供,用于篩選獲取專業內容資源信息時

數據上限

間上限

responseDate輸出接口響應時間字符串20GB/T7408時間字符串

request輸出請求信息對象——接口收到的輸入參數信息,詳見表3

專業內容資源數據verb為“Identify”時返回該對象,為專業內容

Identify輸出對象——

庫信息資源數據庫信息,詳見表4

專業內容資源支持verb為“ListMetadataFormats”時返回該對象,

ListMetadataFormats輸出對象集合——

數據格式集合為專業內容資源支持的數據格式集合

專業內容資源信息專業內容資源信息集合,符合T/CADPAXX《專

ListRecords輸出對象集合——

集合業內容資源聚合服務元數據》的規定

專業內容資源標識

ListIdentifiers輸出對象集合——專業內容資源標識符集合,詳見表5

符集合

Verb為“ListRecords”、“ListIdentifiers”時

可選擇提供,用于關聯多次被訪問請求的令牌,

resumptionToken輸出繼續令牌對象對象20開放搜索系統將根據該對象中包含的令牌字符串

循環訪問接入方獲取專業內容資源,如接入方不

返回該對象則代表數據返回完畢

表3元數據收割接口輸出參數request對象說明

參數名稱輸入/輸出中文名稱數據類型長度說明

verb輸出動作字符串20接入方接收到的輸入參數verb的值

5

T/CADPAXX—XXXX

參數名稱輸入/輸出中文名稱數據類型長度說明

metadataPrefix輸出專業內容資源格式字符串10接入方接收到的輸入參數metadataPrefix的值

url輸出訪問地址字符串20接入方被訪問的地址url

表4元數據收割接口輸出參數Identify對象說明

參數名稱輸入/輸出中文名稱數據類型長度說明

專業內容資源數據

repositoryName輸出字符串256專業內容資源數據庫名稱

庫名稱

專業內容資源數據專業內容資源數據庫提供的對接開放搜索系統

baseURL輸出字符串256

庫基本url的接口url地址

GB/T7408時間字符串,專業內容資源數據庫使

earliestDatestamp輸出最早數據時間字符串20

用的日期戳不得早于該值

該值說明專業內容資源數據庫如何維護數據

no-專業內容資源數據庫不會維護刪除的專業

內容資源

刪除的數據維護辦

deletedRecord輸出字符串10transient-專業內容資源數據庫不保證持久

或一致地維護刪除列表

persistent-專業內容資源數據庫無時間限制

地維護刪除相關的信息

專業內容資源數據庫支持的最精細的獲取數據

最精細的獲取數據

granularity輸出字符串20時間粒度,合法格式為:YYYY-MM-DD和

時間粒度

YYYY-MM-DDThh:mm:ssZ,詳細見GB/T7408

adminEmail管理員郵箱字符串256負責專業內容資源數據庫的管理員聯系郵箱

表5元數據收割接口輸出參數ListIdentifiers對象數組說明

參數名稱輸入/輸出中文名稱數據類型長度說明

專業內容資源唯一標識符和部分基礎信息,詳

專業內容資源唯一

細見表6。根據專業內容資源數據庫是否維護

header輸出標識符和部分基礎字符串256

“刪除的數據”,可能會返回是否專業內容資源

信息集合

的刪除狀態,詳細見表4“deletedRecord”參數

表6元數據收割接口輸出參數header對象說明

參數名稱輸入/輸出中文名稱數據類型長度說明

專業內容資源唯一

identifier輸出字符串256專業內容資源唯一標識符

標識符

對接接口“ListRecords”和“ListIdentifiers”

為選擇性獲取而設的verb都支持根據日期戳選擇性獲取專業內容

datestamp輸出字符串20

置的日期戳資源,該值便于選擇性獲取時提供篩選功能,符

合GB/T7408

如果專業內容資源數據庫維護刪除的數據,在數

據刪除時可選提供該字段,固定為“deleted”,

status輸出專業內容資源狀態字符串7

專業內容資源數據庫是否維護刪除的數據詳見表

4的“deletedRecord”參數

表7元數據收割接口輸出參數resumptionToken對象說明

參數名稱輸入/輸出中文名稱數據類型長度說明

expirationDate輸出令牌過期時間字符串20可選的,GB/T7408時間字符串

接入方希望接入開放搜索系統的專業內容資源總

completeListSize輸出完整數據長度整形數字10

計數目

接入方在本次被請求之前共計返回的專業內容資

cursor輸出游標整形數字20

源總計數目

6

T/CADPAXX—XXXX

參數名稱輸入/輸出中文名稱數據類型長度說明

token輸出令牌字符串50用于關聯多次被訪問請求的令牌字符串

7.2.4元數據收割接口錯誤代碼

元數據收割接口錯誤代碼說明見表8。

表8元數據收割接口錯誤碼說明

錯誤碼說明

badVerb請求動作的值不是合法的請求動作、缺少請求動作或重復傳遞了請求動作

badArgument請求包含非法的參數、缺少必需的參數、包含重復的參數或參數的值

badResumptionTokenresumptionToken參數的值無效或已過期

cannotDisseminateFormat專業內容資源數據庫不支持metadataPrefix參數給定的值標識的數據格式

idDoesNotExist標識符參數的值在此專業內容資源數據庫中未知或非法

noRecordsMatchfrom、util和metadataPrefix參數的值的組合將導致一個空列表

7.3開放授權系統接口

7.3.1開放授權系統接口調用

開放授權系統接口包括授權請求、授權令牌2個接口。接入方調用順序如下:

a)用戶在請求登錄時,接入方系統將客戶端重定向到授權請求接口;

b)開放授權系統請求用戶授權個人信息給接入方系統;

c)用戶同意授權后,開放授權系統將接入方系統重定向到接入方系統;

d)接入方系統調用授權令牌接口,獲取授權令牌;

e)獲得授權令牌和用戶唯一標識后,在接入方系統內完成用戶登錄,最終返回用戶登錄成功響

應。

開放授權系統接口流程如圖4所示。

聚合服務平臺

用戶接入方系統

開放授權系統

請求登錄

調用授權請求接口

請求用戶授權信息給接入方系統

用戶同意授權

重定向到接入方系統

調用授權令牌接口

返回授權令牌、用戶唯一標識

完成用戶登錄

返回用戶結果

圖5開放授權系統接口調用流程

7.3.2開放授權請求接口

開放授權請求接口描述

開放授權請求接口描述見表9。

7

T/CADPAXX—XXXX

表9開放授權請求接口描述

接口描述說明

函數名稱authorize

功能描述重定向方式調用,接口向用戶提供授權頁面,使用戶可以同意將基礎信息授權給接入方,用戶同

意后系統將重定向到接入方系統,并攜帶臨時碼參數以供后續獲得授權令牌使用

HTTP請求方法GET

1)應用ID

2)重定向URL

輸入參數3)響應類型

4)授權權限范圍

5)授權攜帶狀態

1)臨時碼

輸出參數

2)授權攜帶狀態

開放授權請求接口參數

開放授權請求接口參數描述見表10。

表10開放授權請求接口參數

參數名稱輸入/輸出中文名稱數據類型長度說明

應用唯一標識,在聚合資源平臺上創建應用后

client_id輸入應用ID整型數字11

獲得

redirect_uri輸入重定向URI字符串256用戶授權同意后重定向接入方的地址

response_type輸入響應類型字符串4返回值類型,固定為“code”

申請獲得聚合服務平臺的用戶信息內容,固定

scope輸入授權權限范圍字符串20

為“read_userinfo”

用于保持請求和回調的狀態,授權請求后原樣

返回給接入方。該參數可用于防止csrf攻擊(跨

state輸入授權攜帶狀態字符串無限制

站請求偽造攻擊),建議接入方帶上該參數,

可設置為簡單的隨機數加session進行校驗

code輸出臨時碼字符串20通過臨時碼在授權令牌接口中獲取授權令牌

state輸出授權攜帶狀態字符串無限制值與輸入參數state一致

7.3.3開放授權令牌接口

開放授權令牌接口描述

授權令牌接口描述見表11。

表11開放授權令牌接口描述

接口描述說明

函數名稱token

功能描述通過臨時碼獲得授權令牌,授權令牌擁有一定時間有效期,接入方可以通過授權令牌獲取到用戶

基本信息,并完成用戶在接入方系統的登錄

HTTP請求方法POST

1)應用ID

輸入參數2)授權類型

3)臨時碼

1)授權令牌

2)用戶唯一標識符

輸出參數3)令牌類型

4)令牌有效期時間

5)令牌創建時間

8

T/CADPAXX—XXXX

開放授權令牌接口參數

開放授權令牌接口參數描述見表12。

表12開放授權令牌接口參數

參數名稱輸入/輸出中文名稱數據類型長度說明

應用唯一標識,在聚合服務平臺上創建

client_id輸入應用ID整型數字11

應用后獲得

grant_type輸入授權類型字符串256值固定為"authorization_code"

code輸入臨時碼字符串20授權請求接口返回的臨時碼

授權令牌字符串,使用該令牌調用獲取

access_token輸出授權令牌字符串20

用戶信息接口

uid輸出用戶唯一標識符整型數字20授權用戶的唯一標識符

token_type輸出令牌類型字符串20值固定為"bearer"

expires_in輸出令牌有效期時間整型數字11令牌距離過期剩余秒數

create_time輸出令牌創建時間字符串20GB/T7408時間字符串

7.3.4開放授權系統錯誤代碼

開放授權系統錯誤代碼說明見表13。

表13開放授權系統錯誤碼說明

錯誤碼說明

該請求缺少必需的參數,或者包含無效的參數值,或者多次包含一個參數,或者

invalid_request

格式錯誤

unauthorized_client接入方系統無權使用此方法請求授權令牌

access_denied用戶或聚合服務平臺拒絕了該請求

unsupported_response_type聚合服務平臺不支持使用此方法獲取授權碼

invalid_scope請求的授權范圍范圍無效,未知或格式錯誤

server_error服務器異常

temporarily_unavailable由于服務器的暫時超載或維護,授權服務器當前無法處理該請求

7.4開放交易系統接口

7.4.1開放交易系統接口調用

為確保信息、程序和資金安全及系統間的信息對稱,在調用開放交易系統接口前應提前在聚合服

務平臺中配置專業內容資源的信息,將專業內容資源進行分組,分組信息在后續接口對接時用于鑒權

使用。開放交易系統接口包括鑒權和資源購買2個接口,接入方調用順序如下:

a)用戶在訪問某個專業內容資源時,接入方調用簽權接口,獲取用戶是否購買該專業內容資源;

b)若用戶已購買該專業內容資源,接入方系統直接返回專業內容資源給用戶;

c)若用戶未購買該專業內容資源,接入方系統將以重定向方式調用資源購買接口,資源購買接

口返回給用戶資源購買頁面,用戶購買成功后,開放交易系統會將用戶客戶端重定向到接入

方系統的訪問專業內容資源鏈接,該鏈接將重新執行調用簽權接口校驗用戶是否已購買專業

內容資源;

對接開放交易系統接口調用流程如圖5所示。

9

T/CADPAXX—XXXX

聚合服務平臺

用戶接入方系統

開放交易系統

訪問專業內容資源

循環

調用簽權接口

返回簽權結果

替換

用戶已購買該專業內容資源

返回專業內容資源

未購買未購買該專業內容資源

調用資源購買接口

返回資源購買頁面

購買資源

重定向回訪問專業內容資源鏈接

圖6開放交易系統接口調用流程

7.4.2簽權接口

簽權接口描述

簽權接口描述見表14。

表14簽權接口描述

接口描述說明

函數名稱acs_authorize

功能描述該接口提供給接入方,使接入方可以在用戶訪問專業內容資源時訪問接口獲取到用戶是否購買該

專業內容資源。

HTTP請求方法POST

1)授權令牌

2)API接口驗證序號

3)專業內容資源分組

輸入參數4)價格

5)專業內容資源名稱

6)用戶請求IP地址

7)訪問專業內容資源地址

1)簽權結果(用戶未購買專業內容資源、用戶已購買專業內容資源)

輸出參數

2)臨時碼

簽權接口參數

簽權接口參數描述見表15。

表15簽權接口參數

參數名稱輸入/輸出中文名稱數據類型長度說明

該值在httpheader中輸入,值為通過開放授

x-ca-token輸入授權令牌字符串20

權系統獲得的用戶授權令牌

該值在httpheader中輸入,值為通過聚合服

x-ca-appkey輸入API接口驗證序號字符串32務平臺創建的系統接入應用后生成的

appkey

10

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容,請與我們聯系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論