中国电信能力开放平台业务规范.docx
《中国电信能力开放平台业务规范.docx》由会员分享,可在线阅读,更多相关《中国电信能力开放平台业务规范.docx(50页珍藏版)》请在冰豆网上搜索。
![中国电信能力开放平台业务规范.docx](https://file1.bdocx.com/fileroot1/2023-1/31/ea92935d-f676-4c96-856f-54495f7024d7/ea92935d-f676-4c96-856f-54495f7024d71.gif)
中国电信能力开放平台业务规范
能力开放合作管理平台(EMP)
业务规范
中国电信集团公司
2012年2月
文档说明
使用对象
本规范适用于能力开放合作管理平台(一期)业务管理、业务运营、产品开发、平台建设等方面的人员。
使用用途
本规范用于规范能力开放合作管理平台(一期)的开发和建设,规定了业务的目标、服务对象、功能、流程和相关支撑要求等内容,是能力开放合作管理平台业务开展、业务处理、业务管理以及相关平台建设、维护的依据。
编写原则
本规范遵循中国电信发挥综合平台优势,协助合作伙伴将电信优势资源和能力嵌入其产品和服务中,对外提供一站式能力开放合作的发展思路,规范能力开放合作管理平台的业务形态、管理、客户服务和质量监控要求。
版本信息
本规范当前版本:
v1.0
日期
修订版本
作者
主要修订内容
2011.11
0.1
钱逸群
讨论稿
2011.11
0.2
钱逸群
修改应用升级,应用升级分为改变“应用-能力”关系和不改变“应用-能力”关系两类;
修改测试服务。
测试服务修改为由EP判断应用的状态,转至相应的测试环境处理;
添加短地址服务;
2011.12
0.3
钱逸群
将业务功能和业务流程分开说明,添加第5章业务流程,添加各角色触发流程的分职能流程图。
2011.12
0.4
钱逸群
增加能力接口主动注销未通过审核的情况;
4.1节删去开发者自主退出
2011.12
0.5
4.4.2节能力接口注册添加“注册审核时,由能力提供方提供测试用例,供管控方测试接口是否正常;
添加能力提供方在提交能力接口注册申请时,可选择签约该接口的应用在发布时是否需要由能力提供方审核;
4.4.3节能力接口注销流程中,如管控方未审核通过接口的下线申请(如涉及应用数目很多),禁止新的应用签约使用该接口
添加对应用强制下线、强制删除、能力接口强制注销等管理员操作需由多角色确认;
应用状态添加“暂停态”满足运营方需求;
2012.1
0.6
钱逸群
修改开发者账号为天翼帐号;
修改能苦力提供方采用邀请制,分配帐号;
删去4.1节开发者密码重置;
签约角色修改为开发者和能力提供方双方,应用和能力接口属于绑定关系;
签约提前至创建应用之前。
4.4.3节修改对能力版本号的规定
2012.1
0.7
钱逸群
修改能力签约流程,将能力选择和应用创建流程解耦;
添加前置签约和后置签约两种签约流程;
添加4.1.2能力签约;4.3.3能力签约管理;4.4.6能力提供方签约管理。
添加流程:
5.1.2开发者能力签约流程
2012.2
1.0
钱逸群
区分能力接口测试绑定与上线绑定;
将API接口注册与能力接口注册两个流程解耦;
修订能力接口主动注销、强制注销、能力提供方强制退出开发者和能力提供方发起的签约变更(含解约)需能力管控方和合作管控方会商;
1.总则
1.1术语定义
名称
描述
能力开放合作管理平台
EnablerManagementPlatform,简称EMP平台,负责能力接口的合作与管控
能力提供方
简称Enabler;对外提供接口调用,使第三方能够利用接口调用其特有功能的企业或单位
能力提供平台
EnablerPlatform,简称EP,由Enabler建设的能力平台,负责能力功能的具体实现
合作应用
简称App,签约合作伙伴在EMP平台上创建的合作应用
合作应用用户
简称用户,合作伙伴应用(App)的使用者
AppID
EMP平台为特定版本的App分配的唯一标识序列号
AppSecret
EMP平台为特定版本的App分配的共享密钥,用于认证其身份
可调用功能
可实现某一功能的代码逻辑实体,其既包括功能接口,又包括功能实现
可调用功能接口
即API接口,一个API接口可对应多个具体的功能实现
能力
由Enabler指定的一组可调用功能的集合
能力接口
由Enabler定义的一组可调用功能接口的集合,即一组API接口的集合,一个能力接口可对应多个具体的能力实现
开放能力
由Enabler指定,一组可供外部合作伙伴使用的、具备标准化对外服务能力的可调用功能的集合
开放能力接口
由Enabler定义的一组具备标准化可调用功能接口的集合。
集合中的每一个API接口形式均须符合标准化对外接口规范
OAuthv2.0
开放用户授权协议v2,用于使获取过用户授权的应用可以在无需用户名和用户密码的条件下访问用户相关的私有资源
用户授权
用户对于合作应用能否通过开放能力接口调用、使用其私有在线信息或资源的许可
访问令牌
简称Token,合作应用可对开放能力接口进行合法调用的凭据;合作伙伴应用在调用开放能力接口之前须出示令牌并通过鉴权。
访问令牌由由EMP集中颁发、统一管理,由各Enabler负责分布式鉴权
UDB
中国电信用户数据库
UPC
能力开放用户属性信息中心
NSAG/ISAG
全国/综合业务接入网关
1.2业务开放范围
能力开放合作管理平台以互联网原创开发者作为服务对象的主体,面向不限于中国电信本网的互联网合作伙伴提供服务,主要服务对象为中小企业合作伙伴及个人开发者,同时也不排斥与大型互联网公司进行合作。
能力开放合作管理平台同时面向中国电信内部能力提供者、以及互联网外部能力提供者提供能力接口上挂服务,并向最终用户提供统一的应用授权管理手段。
1.3本规范的内容和适用范围
本业务规范主要规定了中国电信能力开放合作管理平台(EMP)的基本概念、业务功能、业务特征、业务流程、及相关支撑要求等内容,是中国电信能力开放业务开发、业务管理和相关平台建设、改造的主要依据。
1.4本规范的编写依据
本规范由中国电信集团公司创新业务事业部组织制定和颁布,集团公司具有对本业务规范的解释权和修订权,如与此前颁布相关规范或规定有冲突,以本规范为准。
本规范起草单位为中国电信股份有限公司上海研究院。
2.业务描述
2.1业务定义
能力开放合作管理平台(EMP)是作为电信开放能力的核心管控平台及面向合作伙伴的合作管理平台,其定位于以合作伙伴管理及合作资源(开放能力)管理为核心,提供一站式电子化的能力签约、能力授权、能力注册登记等基于开放能力接口的合作管理服务。
EMP平台面向以开发者为主体的互联网合作伙伴,提供一站式的能力合作管理服务。
合作伙伴在平台注册签约后,可使用平台提供的开放能力接口进行应用开发。
EMP平台同时为以天翼帐号用户为主体的合作应用使用者提供能力授权服务。
通过该服务,登录合作应用的用户可为合作应用授权,以允许合作应用通过开放能力接口调用,访问用户相关信息或实现用户相关的开放功能。
EMP平台还提供集约化、标准化的开放能力接口注册登记、调用统计分析等能力管控功能。
诸如各基地业务平台、专业公司平台、领航平台及行业短信平台等均可作为能力提供平台,将各自封装好的API注册到能力开放合作管理平台,实现面向合作伙伴的能力提供。
EMP平台先期以提供服务为优先,将在运营过程中逐步完善,持续优化,平台运营初期暂不考虑能力计费、结算以及能力组合。
2.2业务分类
根据面向服务对象不同,可分为合作及开放服务、能力签约服务、能力授权服务、能力注册登记、能力调用统计分析和短地址转换服务。
⏹合作及开发服务
面向开发者,提供开放接口文档、相关资源下载、开发者社区、开发测试支持等合作及开发服务。
同时面向门户管理员,提供文档版本管理、下载资源管理、社区管理等门户服务。
⏹能力签约服务
开发者在EMP平台上完成合作签约后,可注册登记多个合作应用,每一个合作应用均可与多项开放能力进行电子签约。
开发者可以在合作过程中根据自身需要,为合作应用选择并签署新的能力。
⏹能力授权服务
使用天翼帐号登录合作应用的用户可通过该服务,为合作应用能力调用行为授权。
唯有在合作应用的用户为开放能力授权的前提下,合作应用方可成功地调用电信开放能力。
EMP平台将结合用户的能力授权,为合作应用集中颁发相应的访问令牌,以供合作应用在调用用户相关能力时鉴权使用。
能力鉴权采用分布式方式加以实施,由各Enabler平台负责具体鉴权功能的实现,EMP平台将会把所有鉴权相关的信息同步给Enabler平台,供其在能力调用鉴权过程中使用。
⏹能力注册登记
作为面向开发者合作伙伴的统一界面,EMP平台将汇聚各能力提供方所提供的开放能力接口及资源接口,面向开发者提供标准化的规范能力调用接口,及其相应的开放接口调用规范。
同时,EMP平台还将面向能力提供方,提供能力注册上线、能力服务变更、能力接口统计、分析及授权管控等功能。
⏹能力调用统计分析
EMP平台将针对各Enabler平台的开发接口调用情况,同时结合天翼帐号用户授权情况及其应用合作状况,提供开放能力综合运营统计分析服务。
⏹短地址调用转换服务
为合作应用提供互联网URL长地址转换为短地址的映射服务,以方便互联网用户的使用及开发者对其应用分发、传播进行分析与统计。
EMP平台系统功能服务架构如下图所示:
图2.1EMP系统平台功能服务架构图
2.3目标客户
合作能力统一平台的目标用户分为合作伙伴、合作管控方、能力管控方、能力提供方、运营支撑方及最终用户。
2.3.1合作伙伴
EMP主要面向以应用原创开发者为主体的广大互联网合作伙伴,尤其是中小企业创新企业、团队及个人开发者,同时也不排斥大型互联网公司。
合作伙伴既可以是开放能力的直接付费客户,也可以是开放能力的用户(由合作伙伴应用的使用者为开放能力付费);合作伙伴(开发者)通过该平台,以互联网方式一站式获得中国电信提供的开放能力接口和信息合作资源,投入较少的学习成本即可熟悉并使用中国电信开放能力,快速形成合作应用。
2.3.2合作管控方
合作管控方主要负责对合作伙伴、合作应用及合作应用用户授权进行管理,面向上游合作伙伴,以合作应用与用户授权为基础管理对象,行使合作伙伴准入、合作应用审核及其用户授权管理等管控职能。
2.3.3能力管控方
能力管控方主要负责对能力提供方、能力签约、能力接口进行合作管理,面向下游能力提供者,以能力签约与能力接口为基础管理对象,承担签约管理、接口审批等管控职能,同时面向合作管控方提供必要的能力接口统计分析服务。
2.3.4能力提供方
能力提供方是具有包括各种数据、应用、产品、资源及平台能力的提供者,其包括中国电信互联网产品基地、专业公司及第三方互联网能力提供者等。
能力提供方根据能力开放统一平台的接口规范,开发、封装标准API接口,并将其接入至EMP平台。
同时,其还负责能力调用鉴权等具体服务,并向平台提供能力使用情况。
2.3.5最终用户
最终用户是合作应用的使用者,其包括中国电信C网及异网用户在内的所有互联网用户。
EMP平台面向最终用户提供统一的用户授权,唯有在最终用户为开放能力授权的前提下,合作应用方可成功地调用电信开放能力,同时最终用户可通过自服务门户终止已有授权。
2.3.6运营支撑方
运营支撑方主要负责统一门户的运营管理,如门户公告发布、信息维护、社区管理、投诉及客服管理等具体运营支撑工作。
3.业务特征
能力开放合作管理平台是中国电信能力开放面向互联网合作伙伴的统一入口,及中国电信开放能力的汇聚平台。
对内汇聚来自增值业务运营中心、互联网产品基地、专业公司等能力提供者的各项能力,实现对API封装后能力的统一发布和调用统计分析;对外面向用户提供能力调用授权,面向合作伙伴提供统一服务门户,实现一站式线上电子化的能力签约,协助并支持合作伙伴在自身产品和服务中调用或嵌入电信能力/资源。
其主要包括以下特征:
1)面向包括中小企业开发者和个人开发者在内的互联网合作伙伴提供一站式的合作服务,合作伙伴可通过平台所提供门户完成自注册、能力签约与应用管理、创建和发布应用、应用管理操作,并享受开发文档、开发示例、论坛社区、客服等一体化配套辅助服务;
2)平台主要管控能力接口,对于合作产品类型与形态不加额外限制,充分给予开发者使用中国电信能力开发多样化创新应用的自由度;
3)统一规范中国电信提供的多种能力调用API形式,由合作伙伴根据标准化的接口调用流程和方式调用各开放能力提供平台的接口;
4)面向互联网用户提供统一的应用-能力授权界面,使用互联网业界标准方式完成用户的授权及管理操作;
5)与面向合作产品管理、合作受众为SP的传统电信合作模式不同,能力开放合作管理平台主要面向开放能力管理,合作对象为互联网合作伙伴,并且面向合作应用的用户提供显式的能力授权服务。
4.业务功能
4.1合作伙伴功能
面向合作伙伴的功能是能力开放合作管理平台的主体功能之一,使开发者能够从统一的入口接入和了解中国电信提供的对外开放能力,以相对较低的门槛和成本,快速创建、发布和管理合作应用,并应用中使用电信能力。
合作伙伴功能包括能力选择、应用创建、管理、发布以及测试服务。
4.1.1账号管理
4.1.1.1开发者注册申请
开发者可通过平台WEB门户进行开发者注册。
EMP平台开发者须首先注册成为天翼帐号用户。
在开发者使用天翼帐号登录、完成开发者基本信息填写并提交后,即可完成天翼帐号绑定,成为平台注册合作伙伴。
开发者账号密码找回等帐号服务均由天翼帐号体系提供。
开发者账号分为两种类型:
个人开发者账号和企业开发者账号。
个人开发者和企业开发者可根据开发者类型的不同,在线填写基本信息、扩展信息、身份验证信息三类注册信息。
其中,基本信息与扩展信息是合作伙伴用于一般非正式场合下的普通身份信息。
而身份验证信息则是用来唯一标识合作伙伴身份、且用于合作签约等具有法律效力场合下的正式身份信息。
个人开发者基本信息包括:
开发者名称、个人简介(选填)、所在地区(选填)、邮箱、联系电话、手机。
个人开发者扩展信息(选填)有:
个人网站/微博/博客、IM等其他互联网联系方式等。
企业开发者基本信息包括:
企业名称、简介、所在地、法人姓名、联系方式(包括联系电话、手机)。
企业开发者扩展信息有:
企业网址(选填)、企业品牌Logo(选填)等。
开发者填写基本信息和扩展信息后即可创建开发者账号,账号中基本信息和扩展信息的修改立即生效,无需平台管理员审核。
个人开发者身份认证信息包括:
真实姓名、是否外籍、证件类型、证件号码、证件照片:
上传证件照片、手机号码(通过短信验证码验证绑定)。
企业开发者身份验证信息包括:
企业名称、企业注册地、企业执照(上传照片或扫描件)、企业法人手机号码(通过短信验证码绑定)。
所有身份验证信息均需经过运营方审核。
身份认证信息中的证件类型、证件照片、企业名称、注册地、企业执照等信息一经提交审核后不可变更。
修改绑定手机号需要短信验证码确认。
在开发者未提交身份验证信息或身份验证信息未通过审核之前,开发者不能与能力签署正式的能力合作协议,同时其合作应用也不能正式上线发布。
4.1.1.2开发者信息更改
已成为注册合作伙伴的开发者可通过WEB门户修改开发者信息,其中对基本信息和扩展信息的修改在WEB页面提交后直接生效;对身份验证信息的修改,需要再次通过经合作运营方审核通过后方可生效。
绑定手机更改需要原绑定号码和新绑定号码短信匹配验证。
4.1.1.3合作概况统计
合作伙伴(个人/企业)登录平台WEB门户后,可在WEB门户查看到合作概况统计信息,呈现的信息包括:
1)已提交的合作伙伴信息,包括基本信息、扩展信息、身份验证信息
2)合作伙伴考核信息,包括开发者等级、授信情况等(一期不作要求)
3)合作应用列表,其中包含应用名称、应用状态
4)各应用签约能力接口调用总次数,各类能力接口调用次数
5)各应用授权用户总量,新增授权用户数,撤销授权用户数,可按时间维度查看
6)各应用累计总用户量,用户登录数量,可按时间维度查看
5)和6)信息概况统计仅面向需要用户登录、授权的合作应用提供。
EMP平台将不针对单纯面向应用鉴权的合作应用提供此类数据统计。
4.1.2能力签约
能力合约指开发者和能力提供方之间就能力接口的使用所签署具有法律效力的正式合约。
开发者与同一能力提供者之间可签署一份或多份正式合约。
每一份正式合约均可覆盖一项或多项能力接口。
针对某些简单的能力接口(如榜单、排行榜等),开发者与能力提供者之间亦可不签署能力合约。
合约的服务条款既可以包括能力接口的测试服务条款,也可以包括能力接口的上线服务条款。
根据能力提供方的具体要求,开发者与能力提供方之间签约的时机既可以是能力接口测试之前,也可以是能力接口提供正式服务(应用正式上线服务)之前,前者简称为前置签约方式,而后者则被简称为后置签约方式。
签约时机的选择主要取决于合约中是否包括了关于能力接口测试服务的正式条款,其具体可由能力提供方自行决定。
能力提供方可发起对合约内容的更改。
如能力提供方因自身接口原因需要对合约内容进行变更,需提交新版本合约,合约版本管理由EMP平台完成。
EMP平台将告知开发者合约内容已更新,并由开发者对变更合约进行确认。
合约设有有效期限,系统将在合约到期30天前通知开发者续约。
如开发者未能在合作到期之前续约,则合约期满后,EMP平台将对该开发者所有与合约接口绑定的上线应用做服务自动下线处理。
在合约到期之前,开发者可提前申请解除能力合约,其解约申请审批通过之后,原合约接口所涉合作应用将做服务自动下线处理。
在EMP平台中,能力接口与开发者之间的合作状态主要包括:
1.未选择状态:
能力接口未被开发者选择;
2.已选择(未签约)状态:
能力接口已被开发者选择进“我的能力”,但未进行任何签约操作,能力接口仍处于不可用状态;
3.前置签约申请状态:
对于能力提供方要求的前置签约能力接口,开发者须首先提出前置签约申请;对于要求后置签约或无需签约的能力接口,开发者无需进行前置签约申请;
4.前置签约审核状态:
能力提供方对前置签约申请进行审核,且交由能力管控方备案;
5.测试服务就绪状态:
对于前置签约接口,一旦其通过审核及备案,接口测试服务准备即可就绪,合作应用立即可以进行测试调用;对于要求后置签约或无需签约的能力接口,一旦开发者选择了该能力接口,并完成了告知事项(如果存在的话)确认之后,接口测试服务即处于就绪状态;
6.后置签约申请状态:
对于能力提供方要求的后置签约能力接口,开发者在应用正式服务上线之前,需首先提出签约申请。
对于前置签约或无需签约的能力接口,开发者无需进行后置签约申请;
7.后置签约审核状态:
能力提供方对后置签约申请进行审核,且交由能力管控方备案;
8.上线服务就绪状态:
能力签约已完成,可为开发者的上线应用提供正常服务。
4.1.2.1能力申请
注册开发者可在WEB门户在线选择并申请使用能力。
开发者可查看能力接口的开放文档,并根据自身需求,将其选择并收藏进“我的能力”。
EMP平台将跟踪开发者所选择的每一项能力的合作签约及服务可用情况。
对于需要前置签约的能力接口,开发者在选择完能力接口之后,即可面向相关的能力提供方申请能力签约。
唯有在完成前置签约的情况下,开发者方可在自己创建的合作应用中使用其能力接口测试服务,进而在正式上线之后的合作应用中使用该能力接口所提供的正常服务。
开发者在申请合作应用上线时,其已完成前置签约的相关能力接口无需再次签约。
对于后置签约的能力接口,开发者在选择完能力接口组合、并简单地确认完相关告知事项之后(如果有的话),即可立即在自己创建的合作应用中使用其接口测试服务。
然而,当开发者在申请合作应用上线时,其必须与需要后置签约的相关能力接口完成正式签约。
唯有在完成正式合约的前提下,后置签约的能力接口方可为合作应用提供正常的能力服务。
4.1.2.2能力签约
原则上,开发者与某项能力接口是否需要签署正式合约,由能力提供方自行决定。
对于无需签约的能力接口,开发者可在测试阶段直接对其进行能力调用测试,同时在应用上线申请阶段也无需针对该接口签署上线合约。
能力提供者可以为无需签约的能力接口提供若干测试及上线告知事项,以供开发者在能力接口测试及应用上线之前确认。
如上文所述,对于需要正式签约的能力接口,其签约时机可分为两种不同的情况,可由能力提供者自行选择:
1、前置签约:
在开发者进行能力测试之前,即须签署正式合约。
针对某些能力接口,能力提供方对能力接口的安全性及使用接口的开发者要求可能相对较高,并且期望开发者在能力测试阶段遵守相应的正式服务规定,其合同中既包含能力接口的上线服务条款,同时也包括了测试服务的正式条款;针对此类能力接口,开发者在“能力申请”阶段就须进行正式能力签约。
2、后置签约:
对于某些一般性质的能力接口,能力提供方未对开发者使用其接口测试服务做特殊要求,其合约主要侧重于能力接口上线服务相关的正式条款;针对此类能力接口,开发者仅需保证在与之绑定的合作应用申请上线之前完成签约即可,而无需在能力测试阶段正式签约。
无论是前置签约还是后置签约,在正式签署合约前,开发者必须通过合作管控方的身份认证。
在签约之后,所有合约均需通过能力管控方备案方可正式生效。
在合作应用上线发布之前,须确保其所使用的全部能力接口均已完成签约。
如果某个应用所使用的能力接口涉及多个能力提供方,则开发者须和每个能力提供方均签署合约。
如果针对某项能力接口,开发者已签署过合约,且合约处于有效期内,则该开发者使用该项能力接口的所有应用在能力接口测试或申请上线时,均无需针对该接口再次签约。
如开发者选择的能力接口同时涉及前置和后置两种签约模式,则可由开发者自行选择在能力选择环节签署全部合约,或在能力选择环节签署需前置签约的合约,然后再在应用上线申请环节签署其余合约。
合约的文本及签约时机由能力提供方在EMP平台上提交并指定。
合约文本由能力提供方依据相关法律、法规、主管部门要求,以及中国电信相关规定,根据自身能力接口提供情况编写。
合约内容包括能力提供方和开发者双方对能力调用所做的约定,包括双方的权利和义务;合约须指明与能力接口的对应关系,同一个能力接口只能对应一份合约。
能力提供方在注册能力接口时,须指定该接口是否需要正式签约,及其与合约的对应关系。
4.1.2.3签约管理
开发者可在WEB门户在线查看并管理当前和能力提供方的合约,并进行如下操作:
1、查看并打印所有电子合约的正文及主要信息,如能力提供方、涉及能力接口、合约期限等;EMP平台保证合约电子版合约文本不被篡改。
2、查看当前选择的所有能力所处的合约状态及能力提供状态,如测试/服务就绪等;
3、对已签订的电子合约进行续约,对已更新的电子合约进行再次确认或拒绝解约,或对驳回的电子合约重新发起申请等操作。
4.1.2.4签约变更
签约变更指开发者对当前已签订能力使用的电子合约进行变更。
签约变更分为两种情况:
1)新增能力签约。
开发者可选择新的能力接口,并按照能力签约的标准流程,以前置或后置方式签署相应的合约。
2)已有能力解约。
由开发者选择需要解约的能力接口,并提交解约申请,经能力提供方和能力管控方的审批、备案通过后,开发者与该能力接口解除签约关系。
同时,该开发者所有与合约接口存在绑定关系的应用将按照4.1.3节应用管理相关操作,做服务自动下线处理。
4.1.3应用管理
开发者通过平台WEB门户可进行应用创建、应用信息编辑、服务上线申请等操作。
EMP平台的应用包括四种状态:
1、测试:
指应用未通过上线审核或应用下线,仅能调用能力测试接口的状态
2、审核:
指应用已提交上线申请,处于平台管理员审核过程中的状态
3、发布:
指应用正式上线服务,可正常调用签约能力的状态
4、暂停:
指管控人员出于必要,将应用所绑定的相关能力设定为不提供服务的状态。
在应用被暂停的情况下,开发者无法变更应用的状态。
此状态的变更只能由