EMP技術(shù)規(guī)范分冊(cè)-管理接口規(guī)范v1.0_20120201_第1頁
EMP技術(shù)規(guī)范分冊(cè)-管理接口規(guī)范v1.0_20120201_第2頁
EMP技術(shù)規(guī)范分冊(cè)-管理接口規(guī)范v1.0_20120201_第3頁
EMP技術(shù)規(guī)范分冊(cè)-管理接口規(guī)范v1.0_20120201_第4頁
EMP技術(shù)規(guī)范分冊(cè)-管理接口規(guī)范v1.0_20120201_第5頁
已閱讀5頁,還剩25頁未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡介

1、中國電信集團(tuán)公司技術(shù)標(biāo)準(zhǔn)Q/CTXXXX.01-2012能力開放合作管理平臺(tái)(EMP一期)技術(shù)規(guī)范分冊(cè)管理接口規(guī)范v1.0中國電信集團(tuán)公司 發(fā)布2012-2-XX 發(fā)布2012-XX -XX實(shí)施30目 錄1適用范圍52規(guī)范性引用文件63術(shù)語定義74EMP組網(wǎng)及接口概述84.1EMP組網(wǎng)方案84.2EMP接口概述94.3管理接口安全策略105EMP與UDB接口115.1重定向令牌驗(yàn)證接口115.1.1接口信息115.2重定認(rèn)證請(qǐng)求接口115.2.1接口信息115.3用戶身份信息查詢接口115.3.1接口信息115.4重定認(rèn)證令牌注銷接口115.4.1接口信息115.5安全密鑰發(fā)布接口115.6應(yīng)

2、用基本信息查詢接口115.6.1接口信息115.6.2接口參數(shù)126EMP與UPC接口136.1接口概述136.2授權(quán)應(yīng)用信息查詢接口136.2.1接口信息136.2.2接口參數(shù)136.3能力授權(quán)信息查詢接口156.3.1接口信息156.3.2接口參數(shù)156.4用戶授權(quán)取消接口166.4.1接口信息166.4.2接口參數(shù)167EMP與Enabler接口187.1接口概述187.2能力上/下線信息同步接口187.2.1接口信息187.2.2接口參數(shù)187.3應(yīng)用簽約信息同步接口197.3.1接口信息197.3.2接口參數(shù)197.4用戶授權(quán)信息同步接口217.4.1接口信息217.4.2接口參數(shù)2

3、17.5開發(fā)者信息查詢接口227.5.1接口信息227.5.2接口參數(shù)227.6接口調(diào)用信息統(tǒng)計(jì)接口237.6.1接口信息237.6.2接口參數(shù)237.7接入令牌驗(yàn)證接口257.7.1接口信息257.7.2接口參數(shù)257.8應(yīng)用狀態(tài)同步接口267.8.1接口信息267.8.2接口參數(shù)268EMP與CTVAP接口288.1認(rèn)證接口288.2退出接口288.3權(quán)限分配接口288.4幫助接口288.5變更用戶信息接口289EMP數(shù)據(jù)編碼規(guī)范299.1自定義數(shù)據(jù)類型299.1.1API詳細(xì)信息(APIS)299.1.2能力接口信息(EI)299.1.3能力接口列表(EI_ID_ARRAY)299.1.

4、4應(yīng)用與能力簽約信息(APP_EI)299.1.5應(yīng)用圖標(biāo)(APP_ICON)299.1.6應(yīng)用信息(APP_DETAIL)309.1.7應(yīng)用信息列表(APP_DETAIL_ARRAY)309.1.8能力接口描述(EI_DESC)309.2接口返回碼30內(nèi)部資料,注意保密,未經(jīng)同意,請(qǐng)勿翻印版本:v1.0文檔信息文檔名稱EMP技術(shù)規(guī)范分冊(cè)管理接口規(guī)范文件編號(hào)編制人保密級(jí)別修改過程版本號(hào)日期負(fù)責(zé)人概述2011-100.1王大中接口規(guī)范初稿2011-110.3王大中1、增加自定義數(shù)據(jù)模型,包括API、能力接口2、增加對(duì)于UDB的接口需求2011-120.4王大中增加Refresh Token接口2

5、011-120.5王大中補(bǔ)充EMP與UDB接口細(xì)節(jié)2011-120.6王大中若干接口命名修訂2012-11.0王大中1、將EMP-APP接口整理為開放API接口規(guī)范2、增加EMP與UPC管理接口評(píng)審過程版本號(hào)日期評(píng)審者概述分發(fā)范圍前 言中國電信能力開放合作管理平臺(tái)主要面向以開發(fā)者為主體的互聯(lián)網(wǎng)合作伙伴,提供一站式、標(biāo)準(zhǔn)化的能力合作管理服務(wù)。合作伙伴在平臺(tái)注冊(cè)簽約后,可使用平臺(tái)提供的開放能力接口進(jìn)行合作應(yīng)用開發(fā)。能力開放合作管理平臺(tái)同時(shí)為以天翼帳號(hào)用戶為主體的合作應(yīng)用使用者提供能力授權(quán)服務(wù)。通過該服務(wù),登錄合作應(yīng)用的用戶可為合作應(yīng)用授權(quán),以允許合作應(yīng)用通過開放能力接口調(diào)用,訪問或使用與用戶相關(guān)的

6、信息或開放功能。能力開放合作管理平臺(tái)還提供集約化、標(biāo)準(zhǔn)化的互聯(lián)網(wǎng)式能力接口注冊(cè)登記、開放接口調(diào)用統(tǒng)計(jì)分析等集約化能力管控功能。各基地業(yè)務(wù)平臺(tái)、專業(yè)公司平臺(tái)均可作為能力提供平臺(tái),將封裝好的開放API注冊(cè)到能力開放合作管理平臺(tái),實(shí)現(xiàn)面向合作伙伴的規(guī)?;芰Ψ?wù)提供。本規(guī)范由中國電信集團(tuán)公司創(chuàng)新業(yè)務(wù)事業(yè)部組織制定和頒布,集團(tuán)公司具有對(duì)本業(yè)務(wù)規(guī)范的解釋權(quán)和修訂權(quán),如與此前頒布相關(guān)規(guī)范或規(guī)定有沖突,以本規(guī)范為準(zhǔn)。本規(guī)范起草單位:中國電信股份有限公司上海研究院1 適用范圍本規(guī)范適用于中國電信能力開放合作管理平臺(tái)的建設(shè)與部署,是中國電信能力開放合作管理平臺(tái)招標(biāo)采購、工程設(shè)計(jì)、網(wǎng)絡(luò)運(yùn)營、維護(hù)管理等方面的技術(shù)依

7、據(jù),并可作為設(shè)備提供商和集成商能力開放合作管理平臺(tái)系統(tǒng)設(shè)計(jì)、設(shè)備開發(fā)的技術(shù)依據(jù)。2 規(guī)范性引用文件下列標(biāo)準(zhǔn)所包含的條文,通過在本標(biāo)準(zhǔn)中引用而構(gòu)成為本標(biāo)準(zhǔn)的條文。本標(biāo)準(zhǔn)出版時(shí),所示版本均為有效。所有標(biāo)準(zhǔn)都會(huì)被修訂,使用本標(biāo)準(zhǔn)的各方應(yīng)探討使用下列標(biāo)準(zhǔn)最新版本的可能性?!?】中國電信能力開放合作管理平臺(tái)業(yè)務(wù)規(guī)范【2】中國電信能力開放合作管理平臺(tái)技術(shù)規(guī)范總冊(cè)【3】中國電信能力開放合作管理平臺(tái)技術(shù)規(guī)范分冊(cè)能力接口規(guī)范【4】中國電信能力開放合作管理平臺(tái)技術(shù)規(guī)范分冊(cè)開放API接口規(guī)范【5】中國電信用戶數(shù)據(jù)庫接口與流程規(guī)范V2.03 術(shù)語定義名 稱描 述能力開放合作管理平臺(tái)Enabler Management

8、 Platform,簡稱EMP平臺(tái),負(fù)責(zé)能力接口的合作與管控能力提供方Enabler Provider,簡稱Enabler,對(duì)外提供接口調(diào)用,使第三方能夠利用接口調(diào)用其特有功能的企業(yè)或單位能力提供平臺(tái)Enabler Platform,簡稱EP或能力平臺(tái),由Enabler建設(shè)的能力平臺(tái),負(fù)責(zé)能力功能的具體實(shí)現(xiàn)合作應(yīng)用簡稱App,簽約合作伙伴在EMP平臺(tái)上創(chuàng)建的合作應(yīng)用合作應(yīng)用用戶簡稱用戶,合作伙伴應(yīng)用(App)的使用者App IDEMP平臺(tái)為特定版本的App分配的唯一標(biāo)識(shí)序列號(hào)App SecretEMP平臺(tái)為特定版本的App分配的共享密鑰,用于認(rèn)證其身份可調(diào)用功能可實(shí)現(xiàn)某一功能的代碼邏輯實(shí)體,其

9、既包括功能接口,又包括功能實(shí)現(xiàn)可調(diào)用功能接口即API接口,一個(gè)API接口可對(duì)應(yīng)多個(gè)具體的功能實(shí)現(xiàn)能力由Enabler指定的一組可調(diào)用功能的集合能力接口由Enabler定義的一組可調(diào)用功能接口的集合,即一組API接口的集合,一個(gè)能力接口可對(duì)應(yīng)多個(gè)具體的能力實(shí)現(xiàn)開放能力由Enabler指定,一組可供外部合作伙伴使用的、具備標(biāo)準(zhǔn)化對(duì)外服務(wù)能力的可調(diào)用功能的集合開放能力接口由Enabler定義的一組具備標(biāo)準(zhǔn)化可調(diào)用功能接口的集合。集合中的每一個(gè)API接口形式均須符合標(biāo)準(zhǔn)化對(duì)外接口規(guī)范OAuth v2.0開放用戶授權(quán)協(xié)議v2.0,用于使獲取過用戶授權(quán)的應(yīng)用可以在無需用戶名和用戶密碼的條件下訪問用戶相關(guān)的

10、私有資源用戶授權(quán)用戶對(duì)于合作應(yīng)用能否通過開放能力接口調(diào)用、使用其私有在線信息或資源的許可訪問令牌簡稱Token,合作應(yīng)用可對(duì)開放能力接口進(jìn)行合法調(diào)用的憑據(jù);合作伙伴應(yīng)用在調(diào)用開放能力接口之前須出示令牌并通過鑒權(quán)。訪問令牌由由EMP集中頒發(fā)、統(tǒng)一管理,由各Enabler負(fù)責(zé)分布式鑒權(quán)。UDB中國電信用戶數(shù)據(jù)庫UPC能力開放用戶屬性信息中心NSAG/ISAG全國/綜合業(yè)務(wù)接入網(wǎng)關(guān)4 EMP組網(wǎng)及接口概述4.1 EMP組網(wǎng)方案l 全國中心UDB:UDB作為認(rèn)證網(wǎng)元,為EMP平臺(tái)提供天翼帳號(hào)用戶認(rèn)證功能。l 綜合管理平臺(tái)(NMSC/ISMP/NSAG):EMP平臺(tái)視其為各電信能力綜合管理及基礎(chǔ)電信能力

11、提供平臺(tái),為各Enabler平臺(tái)提供綜合電信基礎(chǔ)能力管控及策略配置服務(wù)。EMP一期暫不直接對(duì)接NMSC/ISMP/NSAG。l 各垂直/橫向能力提供平臺(tái)(基地、支付、POI、領(lǐng)航平臺(tái)等):EMP平臺(tái)將向各Enabler平臺(tái)同步能力簽約、能力授權(quán)信息,并由其自行負(fù)責(zé)能力的鑒權(quán)。同時(shí),EMP平臺(tái)還將從各Enabler平臺(tái)接受能力調(diào)用統(tǒng)計(jì)信息,以進(jìn)行匯總分析。EMP平臺(tái)與Enabler平臺(tái)之間將會(huì)涉及到部分接口適配改造,以實(shí)現(xiàn)二者的對(duì)接,從而實(shí)現(xiàn)集中簽約、授權(quán)。EMP一期暫不對(duì)接領(lǐng)航平臺(tái)。4.2 EMP接口概述EMP(一期)系統(tǒng)接口互聯(lián)方案如上圖所示。其中,除EMP與合作應(yīng)用之間的接口為開放API接

12、口之外,其他均為面向內(nèi)部系統(tǒng)的管理接口。本規(guī)范僅包括EMP與UDB、UPC、CTVAP、Enabler等內(nèi)部系統(tǒng)平臺(tái)之間的管理接口定義。關(guān)于EMP與合作應(yīng)用之間的開放API接口,參見能力開放合作管理平臺(tái)技術(shù)規(guī)范分冊(cè)開放API接口規(guī)范。EMP系統(tǒng)管理接口概況如下:1. EMP與UDB之間的管理接口IF1:重定向令牌驗(yàn)證接口IF2:重定向認(rèn)證請(qǐng)求接口IF3:用戶身份信息查詢接口IF4:重定向認(rèn)證令牌注銷接口IF5:安全密鑰發(fā)布接口IF6:應(yīng)用基本信息同步接口2. EMP與UPC之間的管理接口IF1:授權(quán)應(yīng)用信息查詢接口IF2:能力授權(quán)信息查詢接口IF3:用戶授權(quán)取消接口3. EMP與Enabler

13、之間的管理接口IF1:能力上/下線信息同步接口IF2:應(yīng)用簽約信息同步接口IF3:用戶授權(quán)信息同步接口IF4:開發(fā)者信息查詢接口IF5:接口調(diào)用信息統(tǒng)計(jì)接口IF6:接入令牌驗(yàn)證接口IF7:應(yīng)用狀態(tài)同步接口接口4. EMP與CTVAP之間的管理接口IF1:認(rèn)證接口IF2:退出接口IF3:權(quán)限分配接口IF4:幫助接口IF5:變更用戶信息接口4.3 管理接口安全策略為確保管理接口安全,實(shí)施和部署時(shí)應(yīng)從傳輸層和應(yīng)用層進(jìn)行以下保護(hù)措施,保障EMP及各互聯(lián)系統(tǒng)平臺(tái)的全網(wǎng)可靠性和安全性:1. 網(wǎng)絡(luò)傳輸層:1) 其他系統(tǒng)平臺(tái)可以通過專線連接于EMP建立連接;2) EMP位于受防護(hù)墻保護(hù)的DMZ區(qū)域,在防火墻本

14、身設(shè)置策略,允許指定的平臺(tái)系統(tǒng)服務(wù)器的IP和端口與之連接。2. 應(yīng)用層:1) EMP系統(tǒng)和其他系統(tǒng)的數(shù)據(jù)交互可采用HTTPS協(xié)議進(jìn)行;2) 對(duì)于HTTP協(xié)議的消息體內(nèi)容可以采用MD5加密生成簽名。5 EMP與UDB接口EMP利用UDB所提供的重定向接口實(shí)現(xiàn)天翼賬號(hào)的用戶認(rèn)證功能。EMP同時(shí)為UDB提供了合作應(yīng)用基本查詢接口,以便于UDB統(tǒng)計(jì)應(yīng)用相關(guān)信息。5.1 重定向令牌驗(yàn)證接口5.1.1 接口信息參見中國電信用戶數(shù)據(jù)庫- 接口與流程規(guī)范-v2.0關(guān)于重定向令牌驗(yàn)證接口的描述5.2 重定認(rèn)證請(qǐng)求接口5.2.1 接口信息參見中國電信用戶數(shù)據(jù)庫- 接口與流程規(guī)范-v2.0關(guān)于重定向認(rèn)證請(qǐng)求接口的描

15、述5.3 用戶身份信息查詢接口5.3.1 接口信息參見中國電信用戶數(shù)據(jù)庫- 接口與流程規(guī)范-v2.0關(guān)于用戶身份信息查詢接口的描述5.4 重定認(rèn)證令牌注銷接口5.4.1 接口信息參見中國電信用戶數(shù)據(jù)庫- 接口與流程規(guī)范-v2.0關(guān)于重定向令牌注銷接口的描述5.5 安全密鑰發(fā)布接口參見中國電信用戶數(shù)據(jù)庫- 接口與流程規(guī)范-v2.0關(guān)于安全密鑰發(fā)布接口的描述5.6 應(yīng)用基本信息查詢接口5.6.1 接口信息接口名稱UDB/app_info接口概述UDB通過該接口向EMP查詢應(yīng)用基本信息,該接口僅向UDB開放,并限制CN2網(wǎng)內(nèi)指定IP訪問。請(qǐng)求方式POST承載協(xié)議HTTPS數(shù)據(jù)格式XML接口提供者EM

16、P,由EMP實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者UDB,由UDB實(shí)現(xiàn)接口客戶端URLhttps:/emp_domain:port/UDB/app_info5.6.2 接口參數(shù)1) 請(qǐng)求參數(shù),在HTTP包體中包含以下XML參數(shù)名必選類型及范圍說明sp_idtruestring應(yīng)用設(shè)備標(biāo)識(shí)2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明app_detailtrueAPP_DETAIL應(yīng)用詳細(xì)信息3) 接口示例請(qǐng)求:POST /udb/app_info HTTP/1.1Host:Content-Type:application/xml;charset=UTF-8app_1響應(yīng):app_1測試應(yīng)用測試應(yīng)用的詳細(xì)描述0474

17、946383961010001000474946383961010001006 EMP與UPC接口6.1 接口概述為提升用戶管理自身授權(quán)合作應(yīng)用的體驗(yàn),由UPC面向最終用戶統(tǒng)一提供合作應(yīng)用授權(quán)查詢及管理頁面。用戶可在UPC提供的授權(quán)管理界面上進(jìn)行授權(quán)取消操作。UPC通過調(diào)用EMP所提供的管理接口來實(shí)現(xiàn)授權(quán)應(yīng)用信息查詢、用戶授權(quán)管理等相關(guān)操作。為保證安全性,面向UPC的管理接口將僅限定UPC系統(tǒng)的IP訪問。6.2 授權(quán)應(yīng)用信息查詢接口6.2.1 接口信息接口名稱UPC/usr_app_list接口概述UPC通過此接口可獲取該用戶所授權(quán)的所有第三方應(yīng)用的名稱及圖標(biāo)請(qǐng)求方式POST承載協(xié)議HTTPS

18、數(shù)據(jù)格式XML接口提供者EMP,由EMP實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者UPC,由UPC實(shí)現(xiàn)接口客戶端URLhttps:/emp_domain:port/UPC/usr_app_list6.2.2 接口參數(shù)1) 請(qǐng)求參數(shù)參數(shù)名必選類型及范圍說明user_idtruestring天翼帳號(hào)p_user_idtruestring用戶在UDB平臺(tái)的唯一標(biāo)識(shí)2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messagetruestring同步結(jié)果內(nèi)容,“成功”或失敗信息app_detail_arrayfalseAPP_DETAIL

19、_ARRAY用戶已授權(quán)的合作應(yīng)用列表,當(dāng)res_code=0時(shí),必須傳送該字段值3) 接口示例請(qǐng)求:POST /UPC/usr_app_list HTTP/1.1Host:Content-Type:application/xml;charset=UTF-81898888888835123456789響應(yīng):0成功app_1測試應(yīng)用測試應(yīng)用的詳細(xì)描述047494638396101000100047494638396101000100123456789app_2測試應(yīng)用2測試應(yīng)用2的詳細(xì)描述0474946383961010001002123047494638396101000100212332165

20、49876.3 能力授權(quán)信息查詢接口6.3.1 接口信息接口名稱UPC/usr_app_ei接口概述UPC通過此接口獲取該用戶對(duì)應(yīng)用授權(quán)的詳細(xì)信息。請(qǐng)求方式POST承載協(xié)議HTTPS數(shù)據(jù)格式XML接口提供者EMP,由EMP實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者UPC,由UPC實(shí)現(xiàn)接口客戶端URLhttps:/emp_domain:port/UPC/usr_app_ei6.3.2 接口參數(shù)1) 請(qǐng)求參數(shù)參數(shù)名必選類型及范圍說明user_idtruestring天翼帳號(hào)p_user_idtruestring用戶在UDB平臺(tái)的唯一標(biāo)識(shí)sp_idtruestring應(yīng)用設(shè)備標(biāo)識(shí)ei_idtruestring應(yīng)用簽約

21、的能力接口信息2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messagetruestring同步結(jié)果內(nèi)容,“成功”或失敗信息ei_descfalseEI_DESC應(yīng)用所簽約能力接口的詳細(xì)信息,當(dāng)res_code=0時(shí),必須傳送該字段值3) 接口示例請(qǐng)求:POST /UPC/usr_app_list HTTP/1.1Host:Content-Type:application/xml;charset=UTF-818988888888351234567892321響應(yīng):0成功test_1授權(quán)時(shí)顯示的信息解除授權(quán)時(shí)顯

22、示的信息6.4 用戶授權(quán)取消接口6.4.1 接口信息接口名稱UPC/usr_app_cancel接口概述用戶取消授權(quán)時(shí),UPC通過此接口通知EMP。EMP收到UPC通知時(shí),需通知各能力平臺(tái)。請(qǐng)求方式POST承載協(xié)議HTTPS數(shù)據(jù)格式XML接口提供者EMP,由EMP實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者UPC,由UPC實(shí)現(xiàn)接口客戶端URLhttps:/emp_domain:port/UPC/usr_app_cancel6.4.2 接口參數(shù)1) 請(qǐng)求參數(shù)參數(shù)名必選類型及范圍說明user_idtruestring天翼帳號(hào)p_user_idtruestring用戶在UDB平臺(tái)的唯一標(biāo)識(shí)sp_idtruestring

23、應(yīng)用設(shè)備標(biāo)識(shí)2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messagetruestring同步結(jié)果內(nèi)容,“成功”或失敗信息3) 接口示例請(qǐng)求:POST /UPC/usr_app_cancel HTTP/1.1Host:Content-Type:application/xml;charset=UTF-818988888888351234567892響應(yīng):0成功7 EMP與Enabler接口7.1 接口概述EMP與Enabler之間的管理接口,用于完成簽約、授權(quán)及接口統(tǒng)計(jì)等各類相關(guān)信息的同步與查詢等相關(guān)操作。7.

24、2 能力上/下線信息同步接口7.2.1 接口信息接口名稱Enabler/resource_sync接口概述Enabler成功完成能力上線后,EMP調(diào)用該接口將能力信息同步給Enabler請(qǐng)求方式POST承載協(xié)議HTTP數(shù)據(jù)格式XML接口提供者Enabler,由Enabler實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者EMP,由EMP實(shí)現(xiàn)接口客戶端URLhttp:/enabler_domain:port/Enabler/resource_sync7.2.2 接口參數(shù)1) 請(qǐng)求參數(shù),在HTTP包體中包含以下XML參數(shù)名必選類型及范圍說明enabler_idtruestringEnabler在EMP平臺(tái)注冊(cè)后自動(dòng)分配的

25、ID。actionturestring0- 能力上線1- 能力下線ei_idtruestring 由能力提供方填寫能力接口在能力平臺(tái)上的唯一ID(EPID)。apistrueAPIS能力所包含的api信息2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messagetruestring同步結(jié)果內(nèi)容,“成功”或失敗信息3) 接口示例請(qǐng)求:POST /Enabler/resource_sync HTTP/1.1Host:Content-Type:application/xml;charset=UTF-8e_101/a

26、aaa/bbbb/cccc/dddd響應(yīng):0成功7.3 應(yīng)用簽約信息同步接口7.3.1 接口信息接口名稱Enabler/app_ei_sync接口概述應(yīng)用成功完成能力簽約后,EMP將簽約信息同步給Enabler,應(yīng)用簽約關(guān)系發(fā)生變更時(shí),EMP向Enabler同步應(yīng)用最新的簽約關(guān)系。請(qǐng)求方式POST承載協(xié)議HTTP數(shù)據(jù)格式XML接口提供者Enabler,由Enabler實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者EMP,由EMP實(shí)現(xiàn)接口客戶端URLhttp:/enabler_domain:port/Enabler/app_ei_sync7.3.2 接口參數(shù)1) 請(qǐng)求參數(shù),在HTTP包體中包含以下XML參數(shù)名必選類型

27、及范圍說明enabler_idtruestringEnabler在EMP平臺(tái)注冊(cè)后自動(dòng)分配的ID。dev_idtruestring開發(fā)者在EMP平臺(tái)的IDapp_idtruestring應(yīng)用IDapp_secrettruestring該應(yīng)用的密鑰app_statustruestring應(yīng)用狀態(tài)0測試狀態(tài)1發(fā)布狀態(tài)2暫停狀態(tài)3刪除app_leveltruestring應(yīng)用級(jí)別0初級(jí)1中級(jí)2高級(jí)3合作授權(quán)app_eitrueEI_ID_ARRAY該應(yīng)用在該能力平臺(tái)上簽約的能力集合2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代

28、碼res_messagetruestring同步結(jié)果內(nèi)容,“成功”或失敗信息3) 接口示例請(qǐng)求:POST /Enabler/app_ei_sync HTTP/1.1Host:Content-Type:application/xml;charset=UTF-8e_1dev_1123afvfgfdgfdtrhjyhjhyjhjhjhjhy00123456789響應(yīng):0成功7.4 用戶授權(quán)信息同步接口7.4.1 接口信息接口名稱Enabler/app_user_ei_sync接口概述用戶成功完成應(yīng)用能力授權(quán)后,EMP將授權(quán)信息同步給Enabler(如本次授權(quán)能力涉及多個(gè)Enabler,則所有Enab

29、ler皆需同步成功,否則算為同步失?。┱?qǐng)求方式POST承載協(xié)議HTTPS數(shù)據(jù)格式XML接口提供者Enabler,由Enabler實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者EMP,由EMP實(shí)現(xiàn)接口客戶端URLhttps:/enabler_domain:port/Enabler/app_user_ei_sync7.4.2 接口參數(shù)1) 請(qǐng)求參數(shù),在HTTP包體中包含以下XML參數(shù)名必選類型及范圍說明app_idtruestring應(yīng)用注冊(cè)時(shí)分配的AppKeyenabler_idtruestringEnabler在EMP平臺(tái)注冊(cè)后自動(dòng)分配的ID。access_tokentruestring完成應(yīng)用-用戶-能力授權(quán)、應(yīng)

30、用能力授權(quán)的令牌typetruestring授權(quán)同步類型0:新增授權(quán)信息1:刪除授權(quán)信息2:刷新授權(quán)信息p_user_idfalsestring用戶在UDB平臺(tái)的唯一標(biāo)識(shí),當(dāng)EMP下發(fā)無需用戶確認(rèn)的AT時(shí),該字段可不出現(xiàn)或?yàn)榭罩?。ei_id_arraytrueEI_ID_ARRAY能力接口列表,一個(gè)access_token可以為多個(gè)能力接口授權(quán)expires_intruestringAccess Token的有效期(以秒為單位)2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messagetruestring同步

31、結(jié)果內(nèi)容,“成功”或失敗信息3) 接口示例請(qǐng)求:POST /Enabler/app_user_ei_sync HTTP/1.1Host:Content-Type:application/xml;charset=UTF-8app_1123abcdefghijk/00000000000011234567893600響應(yīng):0成功7.5 開發(fā)者信息查詢接口7.5.1 接口信息接口名稱Enabler/dev_query接口概述Enabler調(diào)用此接口獲取開發(fā)者相關(guān)信息請(qǐng)求方式POST承載協(xié)議HTTPS數(shù)據(jù)格式XML接口提供者EMP,由EMP實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者Enabler,由Enabler實(shí)現(xiàn)接口

32、客戶端URLhttps:/emp_domain:port/Enabler/dev_query7.5.2 接口參數(shù)1) 請(qǐng)求參數(shù),在HTTP包體中包含XML參數(shù)名必選類型及范圍說明dev_idtruestring開發(fā)者在EMP平臺(tái)的IDenabler_idtruestringEnabler在EMP平臺(tái)的IDenabler_secfalsestringEnabler接入Key,本期不涉及,在后期引入第三方Enabler后考慮此參數(shù)2) 響應(yīng)參數(shù),在HTTP包體中包含XML參數(shù)名必選類型及范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messag

33、etruestring同步結(jié)果內(nèi)容,“成功”或失敗信息dev_idtruestring開發(fā)者在EMP平臺(tái)的IDdev_teltruestring開發(fā)者聯(lián)系電話dev_nametruestring個(gè)人開發(fā)者真實(shí)姓名,或企業(yè)開發(fā)者的企業(yè)名稱3) 接口示例請(qǐng)求:POST /Enabler/app_user_ei_sync HTTP/1.1Host:Content-Type:application/xml;charset=UTF-8dev_1e_1/響應(yīng):0成功000010001021-28970137developer7.6 接口調(diào)用信息統(tǒng)計(jì)接口7.6.1 接口信息接口名稱Enabler/data_

34、upld接口概述Enabler調(diào)用此接口向EMP上報(bào)接口調(diào)用信息請(qǐng)求方式POST承載協(xié)議HTTP數(shù)據(jù)格式XML接口提供者EMP,由EMP實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者Enabler,由Enabler實(shí)現(xiàn)接口客戶端URLhttp:/emp_domain:port/Enabler/data_upld7.6.2 接口參數(shù)1) 請(qǐng)求參數(shù),在HTTP包體中包含XML參數(shù)名必選類型及范圍說明app_idtruestring應(yīng)用在EMP平臺(tái)的IDenabler_idtruestringEnabler在EMP平臺(tái)的IDeitrueEI能力接口信息。一個(gè)Enabler可以提供多個(gè)能力接口2) 響應(yīng)參數(shù)參數(shù)名必選類型及

35、范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messagetruestring同步結(jié)果內(nèi)容,“成功”或失敗信息3) 接口示例請(qǐng)求:POST /Enabler/data_upld HTTP/1.1Host:Content-Type:application/xml;charset=UTF-8app_1e_1/ei_id/aaaa/bbbb/cccc/dddd響應(yīng):0成功7.7 接入令牌驗(yàn)證接口7.7.1 接口信息接口名稱Enabler/token_verify接口概述Enabler調(diào)用此接口到EMP驗(yàn)證Token信息請(qǐng)求方式POST承載協(xié)議H

36、TTPS數(shù)據(jù)格式XML接口提供者EMP,由EMP實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者Enabler,由Enabler實(shí)現(xiàn)接口客戶端URLhttps:/emp_domain:port/Enabler/token_verify7.7.2 接口參數(shù)1) 請(qǐng)求參數(shù),在HTTP包體中包含XML參數(shù)名必選類型及范圍說明access_tokentruestring獲取到的Access Tokenapp_idtruestring應(yīng)用注冊(cè)時(shí)分配的App_ID,是應(yīng)用在EMP平臺(tái)的唯一標(biāo)識(shí)enabler_idtruestringEnabler在EMP平臺(tái)注冊(cè)后自動(dòng)分配的ID。ei_id_arraytrueEI_ID_ARRA

37、Y應(yīng)用所調(diào)用的能力在EMP平臺(tái)的ID 2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明res_codetruestring令牌驗(yàn)證結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messagetruestring令牌驗(yàn)證結(jié)果描述,“成功”或失敗信息app_idtruestring應(yīng)用注冊(cè)時(shí)分配的App_ID,是應(yīng)用在EMP平臺(tái)的唯一標(biāo)識(shí),當(dāng)res_code為0時(shí)返回該值ei_idtruestring應(yīng)用與該能力簽約的所有能力列表,當(dāng)res_code為0時(shí)返回該值p_user_idtruestring用戶在UDB平臺(tái)的唯一標(biāo)識(shí),當(dāng)res_code為0時(shí)返回該值access_tokentruestrin

38、g獲取到的Access Token,當(dāng)res_code為0時(shí)返回該值expires_intruestringAccess Token的有效期(以秒為單位)3) 接口示例請(qǐng)求:POST /Enabler/token_verify HTTP/1.1Host:Content-Type:application/xml;charset=UTF-8at123123123123456654321響應(yīng):0成功12312345614000000001at12336007.8 應(yīng)用狀態(tài)同步接口7.8.1 接口信息接口名稱Enabler/app_status_sync接口概述當(dāng)應(yīng)用狀態(tài)(測試狀態(tài)、發(fā)布狀態(tài))發(fā)生變更

39、時(shí),EMP向能力平臺(tái)同步應(yīng)用狀態(tài)(如本次授權(quán)能力涉及多個(gè)Enabler,則所有Enabler皆需同步成功,否則算為同步失敗)請(qǐng)求方式POST承載協(xié)議HTTPS數(shù)據(jù)格式XML接口提供者Enabler,由Enabler實(shí)現(xiàn)接口服務(wù)端接口調(diào)用者EMP,由EMP實(shí)現(xiàn)接口客戶端URLhttps:/enabler_domain:port/Enabler/app_status_sync7.8.2 接口參數(shù)1) 請(qǐng)求參數(shù),在HTTP包體中包含以下XML參數(shù)名必選類型及范圍說明app_idtruestring應(yīng)用注冊(cè)時(shí)分配的應(yīng)用IDapp_statustruestring應(yīng)用狀態(tài)0測試狀態(tài)1發(fā)布狀態(tài)2暫停狀態(tài)3

40、刪除2) 響應(yīng)參數(shù)參數(shù)名必選類型及范圍說明res_codetruestring同步結(jié)果代碼,返回0表示成功,其它值詳見失敗代碼res_messagetruestring同步結(jié)果內(nèi)容,“成功”或失敗信息3) 接口示例請(qǐng)求:POST /Enabler/app_status_sync HTTP/1.1Host:Content-Type:application/xml;charset=UTF-8app_10響應(yīng):0成功8 EMP與CTVAP接口8.1 認(rèn)證接口參見增值業(yè)務(wù)系統(tǒng)管理平臺(tái)集成方案v1.6.8關(guān)于認(rèn)證接口的描述8.2 退出接口參見增值業(yè)務(wù)系統(tǒng)管理平臺(tái)集成方案v1.6.8關(guān)于退出接口的描述8.3 權(quán)限分配接口參見增值業(yè)務(wù)系

溫馨提示

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

最新文檔

評(píng)論

0/150

提交評(píng)論