中国联通APaaS能力开放平台API规范积分商城分册v19.docx

1、中国联通APaaS能力开放平台API规范积分商城分册v19中国联通A-a能力开放平台P规范积分商城分册v1.9 作者：日期： 中国联通公司发布中国联通A-PaaS能力开放平台API规范积分商城分册1 概述1.1 背景随着行业和公司发展，IT和各业务领域更深度融合,IT已不仅是信息化部门的专有任务，越来越多业务单元需要直接参与到T建设中。传统I模式正在转变，“平台+应用”新格局快速形成,IT部门将逐步更加聚焦于IT整体规划、共享能力提供、数据聚合、基础设施和服务提供等领域。为构建平台和应用间桥梁，A-PaaS能力体系应运而生，在2015年IT整体规划中,参照I三层架构总体规划，进一步将各类公共业

2、务能力进行沉淀，形成应用能力层（A-PaaS）,通过A-PaaS实现IT、数据、运营、应用能力的复用和整合，促进集中统一运营红利释放。各类业务单元(BU)作为AaaS能力使用方，获得更加透明、标准化的平台能力支撑，通过平台+业务应用新的IT模式，最大程度发挥自身运营灵活性，并也可实现自身能力复用、沉淀。 各类能力单元(A)做为APaaS能力提供方，视角也在逐步发生变化,由系统建设组织者逐步变为公共能力的生产者或运营者，可以专注能力潜力挖掘,打造更有价值的能力。1.2 范围此文档是A-Paa能力开放平台对外提供的服务接口规范,适用于所有通过API和SK方式调用开放能力的场景。所有业务应用需要按照

3、此规范要求进行服务调用,并根据返回结果做适当的业务处理。1.3 平台介绍A-PaS运营支撑平台是面向业务单元的一个能力视图，是具体的服务、管理、交易平台，包括能力商店、能力开放平台、应用部署环境管理。通过能力商店实现能力提供统一管理,所有开放能力均在能力商店上架，统一管理，统一订购；通过能力开放平台，实现能力开放，对第三方、子公司、省分U、总部BU提供统一能力调用；通过应用部署环境管理,为创新应用提供自助式分布式部署环境。对于U来说，A-PaS运营支撑平台呈现业务标准化能力,屏蔽各能力提供平台差异化服务;另一方面对于内部各类AU提供规范服务接入,A-PaS运营支撑平台是公司平台化运营的基础业务

4、能力体系。本规范主要是针对A-aaS能力开放平台对外提供的服务接口规范;1.4 参考文献1.5 缩略语与术语1.5.1 缩略语英文缩写英文全称中文解释APAiliy-Platfor s a rvie业务能力层-PaSIntegrti atfrm as Sevice技术组件层AUAbiity Unit能力单元BUusns U业务单元APEY PP-KEY应用DP_SECRETAPPSECRT应用密钥1.5.2 术语本文档所涉及的术语定义请参见下表。名词解释能力用于支撑各类业务活动的公共要素或环节，各类业务应用的“公约数”、承载一定业务功能，可复用,相对稳定。一个能力可以包括多个服务服务服务是指提

5、供某项业务功能的具体API接口应用接入业务单元使用能力开放平台的能力，完成业务应用建设的过程业务经理业务应用的建设与维护人员,能力经理能力的建设和运营人员，U的能力提供方平台运营方A-PaaS整体运营基本责任单元,负责A-PaaS体系的运营P调用方式通过接口地址调用服务的技术实现方式SDK调用方式通过SDK方式调用服务的技术实现方式2 接入技术2.1 传输协议 采用TTP传输协议,并采用RESTUL风格的服务访问方式。 POT把提交的数据则放置在HTTP包的包体中。 所有参数值需要转换为UTF编码。 支持POST请求方式的PI接口，所需要拼接的格式示例如下：i/xxx（服务名称)xx(版本号)

6、?2.2 PI调用方式 本章节主要介绍通过接口地址调用服务的技术实现方式,简称PI调用方式;2.2.1 传输协议 采用HTTP传输协议，并采用RETFUL风格的服务访问方式。 OS把提交的数据则放置在HT包的包体中。 所有参数值需要转换为UTF-8编码。 支持PST请求方式的API接口,所需要拼接的UL格式示例如下:（服务名称）x（版本号)？2.2.2 调用方式通过HTTP POT请求方式进行API调用，并根据PI规范拼接正确的UR,就能够办理相应业务或取得相应数据。2.2.3 调用参数发起I调用的请求有二类参数：系统参数、应用参数,系统参数与应用参数以POST的方式把提交的数据则放置在TP包

7、的包体中传输;1) 系统参数名称类型必填？说明备注ap_keycar（3)Y接入标识码timeaptimestampY时间戳当前的系统时间戳,单位为毫秒，举例：21-03-5 1:12: 187erialnuberchar(23）Y序列号YYYYMMDDHMSS+毫秒()+6位随机数igarchar(256)Y签名信息 2）应用参数应参参数参照实时接口规范2.2.4 签名方式调用p值需要进行签名in值的校验，服务器也会对该请求参数进行验证是否合法的。签名值sgn是将请求源串以及p_secrt根据一定签名方法生成的签名值；方法如下：1. 根据系统参数名称（除sign签名)将所有请求系统参数按照字

8、母先后顺序排序:key +vaue . k +vlue 例如:请求R为：;将系统参数值ap_ky=ab,timestam=16-0-25 12:12:12 18,sera_nur=912321eqwrwq参数名和参数值链接后，得到拼装字符串:pp_keabcserial_mber912321eqwqqtimestam2016-0-2 12:12:2 1872. 拼接ap_scretappecre为应用申请时分配的Ap密钥,不在R中传递，双方配置在自己系统中,用于计算sign值，增强安全性。ppecr值拼接到上面的字串中后面，加入appsecrt值为B273242，最终得到：pp_kabsral

9、_numer91221eqwrwqqmestmp01-3-25 2：1：12 1727324273. 系统支持5(4位)加密方式md5：将appert拼接到参数字符串尾后进行md5(64位)加密,格式是: md5(keyvue1key2lue2. ap_scret)4. Sign计算：把上面得到的源串进行MD5计算,得到sign值为eqewq123214uie92.3 SDK调用方式A-PaaS能力开放平台SK提供了调用接口(PI)的请求封装、签名、返回解析、消息监听等功能,使用SDK可以轻松完成的调用，API结果的获取,消息的实时监听。3 实时接口3.1 积分消费记录查询3.1.1 应用场景

10、用于查询客户的积分消费历史;3.1.2 请求说明AI名称cnintgrmallcoreasicqery.scorexpendrecor外网调用入口内网调用入口HTP请求方式HTTPPO格式JNAPI授权类型需要授权是否收费API否类型基础服务版本13.1.3 输入参数3.1.3.1 应用级输入参数名称类型必填？说明备注reqtschr（14)请求发起时间戳yyMMddHmmsschnnelcodevarchr（0)Y发起方渠道编码bzparamvarcar（653)Yjsn字符串“paam1”：”ue”,”parm2”:”vlue2”,.参数列表参数以其参数名的字典序升序进行排序，结果进行ae

11、加密,并且转成base64字符串。加密所用ky由积分商城提供(同appSerect)所传参数见下表authsinvchar(256)Y数字签名chanlcoderqs+“pam1”：”alue1”,”parm2”:”alu2”,.+ppSerect加号不传参数列表参数以其参数名的字典序升序进行排序,按照上面顺序进行排序后MD5加密(UT编码），接入渠道编码hannelcde，密钥appSerec由积分商城提供所传参数见下表加密解密方法： 测试时，系统参数里面加密使用的是申请应用的时候提供的apkeyppscret；应用参数里面加密时使用的渠道编码为“AP+两位省份编码”，密钥为“RikaIB2

12、AMvmJk5RG1=”bzprams入参名称类型必填?说明备注rasvrhar（50)Y发起方流水渠道编码+ yyymddhh24mss+6位不重复序列reqseiecodevach(9)Y服务编码积分消费记录查询:1101100provcecodeca(3）省份编码itycodeh(3)地市编码neypechar()Y网别0 2G2 G9 4Gpytyeh（2)付费类型1 预付费 后付费usrtypecha(1)Y用户类型0 手机1宽带 固话3 上网卡urnumberarchar(30)Y服务号码telaeacoderchr()N区号固网必填begindatear（8)Y开始时间YYMMDDenddatechar()Y结束时间YYYMD3.1.4 返回结果名称类型必填?说明备注epcodhar()Y应答编码应答编码00 成功999 系统异常respdecvrchar（0）N应答描述应答描述rsschar(14）响应时间戳yyMMdHHmmssrmsvarcha(65536)Y业务应答（业务参数列表）消息应答参数为jsn格式,同请求参数一样，整体结果进行aes加密，并且转成ae6字符串rsmsg内参数说明名