剧院数字化服务系统接口规范

1剧院数字化服务系统接口规范本标准规定了剧院数字化服务系统建设中的通用信息交互要求和基本原则。本标准适用于剧院数字化服务系统建设中的基础接口设计、ERP系统接口设计、顾客平安系统接口设计、微网站接口设计、会员卡管理系统接口设计、票务管理系统接口设计以及停车场管理系统接口设计要求。2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T8566-2007软件生存周期过程GB/T8567-2006计算机软件文档编制规范GB/T11457-2006信息技术软件工程术语GB/T15126-2008信息技术开放系统互连网络服务定义GB/T15532-2008计算机软件测试规范GB/T18726-2011现代设计工程集成技术的软件接口规范3术语和定义下列术语和定义适用于本文件3.1剧院数字化服务系统digitalservicesystemfortheaters剧院数字化服务系统，是指通过以物联网、云计算、大数据等新一代信息技术的应用，达到提升剧院顾客服务品质，支撑强化剧院管理系统，完善剧院营销体系的目的。3.2接口interface接口是计算机系统中两个独立的部件进行信息交换的共享边界。这种交换可以发生在计算机软、硬件，外部设备或进行操作的人之间，也可以是它们的结合。3.3微网站micro-site微网站指源于WebApp和网站的融合创新，兼容iOS、android、WP等各大操作系统，可以方便的与微信、微博等应用的链接，适应移动顾客端浏览市场对浏览体验与交互性能要求的新一代网站。24符号和缩略语RFID(RadioFrequencyIdentification)射频识别APP（application）移动应用软件ERP(EnterpriseResourcePlanning)企业资源计划ID（identity）身份标识号OA（OfficeAutomation）办公自动化URL（UniformResourceLocator）统一资源定位符POI(PointofInterest)兴趣点UUID（UniversallyUniqueIdentifier）通用唯一识别码PKI/CA（PublicKeyInfrastructure/CertificateAuthority）公钥基础设施/认证中心5信息交互接口剧院数字化服务系统接口设计要求包括了基础接口设计、ERP系统接口设计、顾客平安系统接口设计、微网站接口设计、会员卡管理系统接口设计、票务管理系统接口设计、智能泊车系统接口设计等。6基础接口设计6.1调用方式采用WebService调用方式。6.2获取6.2.1接口描述Token是访问外部服务系统接口的全局唯一凭证,通过WebService方式访问获取Token，客户端系统调用各接口时都需使用Token。6.2.2输入参数输入参数为：应用ID、时间戳。6.2.3输出参数输出参数为：状态码、错误信息、应用ID、时间戳、Token。6.3获取会员信息6.3.1接口描述根据会员编号、或者手机号码、或者身份证号查询会员信息。6.3.2输入参数输入参数为：会员编号、电话号码、会员登录名。6.3.3输出参数3输出参数为：状态码、错误信息、会员编号、会员名称、会员登录名、会员登录ID、昵称、电话、会员卡号、地址、身份证号、性别、出生日期、登记日期、邮箱、消费总额、车牌号、兴趣爱好、总积分、会员状态、会员等级、余额。6.4会员注册接口6.4.1接口描述调用外部服务系统提供的接口，将系统注册的会员信息实时推送到外部服务系统进行保存。6.4.2输入参数输入参数为：会员名称、会员密码、电话、身份证号、邮箱。6.4.3输出参数输出参数为：状态码、错误信息。6.5公司信息同步6.5.1接口描述当OA系统中，分部（公司）信息发生变化（新增、更新、删除等）后，调用外部服务系统提供的接口及时的将分部变化信息推送至外部服务系统进行同步更新。6.5.2输入参数输入参数为：操作类型、数据集、公司ID、公司名称、上级公司ID、排序号、状态。6.5.3输出参数输出参数为：状态码、错误信息。6.6部门信息同步6.6.1接口描述当OA系统中，部门信息发生变化（新增、更新、删除等）后，调用外部服务系统提供的接口及时的将部门变化信息推送至外部服务系统进行同步更新。6.6.2输入参数输入参数为：操作类型、数据集、部门ID、公司名称、上级部门ID、排序号、状态、公司ID。6.6.3输出参数输出参数为：状态码、错误信息。6.7人员信息同步6.7.1接口描述当OA系统中，人员信息发生变化（新增、更新、删除等）后，调用外部服务系统提供的接口及时的将人员变化信息推送至外部服务系统进行同步更新。46.7.2输入参数输入参数为：操作类型、数据集、分部、部门、员工工号、姓名、性别、岗位、直接上级、状态、办公电话、移动电话、其他电话、电子邮件、出生日期、籍贯、人员性质、更改日期、登录名、加密密码。6.7.3输出参数输出参数为：状态码、错误信息。6.8岗位信息同步6.8.1接口描述当OA系统中，岗位信息发生变化（新增、更新、删除等）后，调用外部服务系统提供的接口及时的将岗位变化信息推送至外部服务系统进行同步更新。6.8.2输入参数输入参数为：操作类型、数据集、岗位编码、岗位名称、部门编码、单位编码。6.8.3输出参数输出参数为：状态码、错误信息。7ERP系统接口设计7.1获取Token7.1.1接口描述Token是调用命令的全局唯一票据，接入系统调用各接口命令时都需使用Token。7.1.2输入参数输入参数为：应用ID、应用密钥。7.1.3输出参数输出参数为：状态码、错误信息、应用ID、时间戳、Token、过期状态。7.2商铺信息同步7.2.1接口描述当ERP系统中，商铺信息发生变化（新增、更新、删除等）后，调用外部服务系统提供的接口及时的将商铺变化信息推送至外部服务系统进行同步更新。7.2.2输入参数输入参数为：操作类型、数据集、商户编码、中文名称、英文名称、店招品牌、状态、商户地址、商户性质、商户图片、优惠信息、联系方式。7.2.3输出参数5输出参数为：状态码、错误信息。7.3商品类别信息同步7.3.1接口描述当ERP系统中商品类别信息发生变化（新增、更新、删除等）后，调用外部服务系统提供的接口及时的将商品类别变化信息推送至外部服务系统进行同步更新。7.3.2输入参数输入参数为：操作类型、数据集、编码、中文名称、英文名称、级次、最上级ID、父类ID、标签状态。7.3.3输出参数输出参数为：状态码、错误信息。7.4商品信息同步7.4.1接口描述当ERP系统中，商品信息发生变化（新增、更新、删除等）后，调用外部服务系统提供的接口及时的将商品变化信息推送至外部服务系统进行同步更新。7.4.2输入参数输入参数为：操作类型、数据集、商品编码、商品条码、商品中文名称、商品英文名称、商品门店、合同编号、商品状态、开始日期、结束日期、租户编码、商品类别。7.4.3输出参数输出参数为：状态码、错误信息。7.5消费记录信息同步7.5.1接口描述ERP系统将除了外部服务系统之外的消费记录信息通过数据接口及时推送到外部服务系统进行同步保存。7.5.2输入参数输入参数为：消费记录ID、租赁商户的店铺标号、商场统一提供POS机号、小票序号、销售日期、类别、系统中给定的每个商铺的商品代码、价格、数量、此小票总成交金额、付款方式、原收银机号、原交易流水号、现金信用卡、储值卡、促销券、手工、其他支付、会员编号、消费类别。7.5.3输出参数输出参数为：状态码、错误信息。7.6实时消费信息同步7.6.1接口描述6外部服务系统将用户实时消费记录通过接口推送到ERP系统保存。7.6.2输入参数输入参数为：消费记录ID、租赁商户的店铺标号、商场统一提供POS机号、小票序号、销售日期、类别、系统中给定的每个商铺的商品代码、价格、数量、此小票总成交金额、付款方式、原收银机号、原交易流水号、现金信用卡、储值卡、促销券、手工、其他支付、会员编号、消费类别。7.6.3输出参数输出参数为：状态码、错误信息。8顾客平安系统接口8.1获取高危预警事件信息接口8.1.1接口描述通过对各种环境、动能、温度、压力、火灾、高危气体（包括气体成份、烟雾）数据信息等数据的勘测和分析，当发生高危情况时，智慧剧院系统-外部服务系统通过调用接口的方式，及时获取预警信息，同时将预警信息发布给安保及其他外围系统，包括事件编号、事件名称、事件描述、事件等级、事件发生时间、事件发生地点、事件类型。8.1.2输入参数输入参数为：事件编号、事件名称、事件描述、事件等级、事件发生时间、事件发生地点、事件类8.1.3输出参数输出参数为：状态码、错误信息。8.2获取儿童走失告警信息接口8.2.1接口描述智慧剧院系统-外部服务系统通过调用接口的方式，及时获取儿童走失信息，当儿童接近剧院一些关键出口时，通过RFID设备获取儿童位置信息，包括时间、位置等信息。8.2.2输入参数输入参数为：编号、描述、时间、走失位置。8.2.3输出参数输出参数为：状态码、错误信息。8.3获取客流勘测信息接口8.3.1接口描述智慧剧院系统-外部服务系统通过调用接口的方式，获取客流信息，包括客流密度、位置等信息。78.3.2输入参数输入参数为：时间、位置。8.3.3输出参数输出参数为：状态码、返回信息、时间、位置、客流密度。9微网站接口9.1认证签名认证签名的算法为：（1）将需要参与认证的请求参数按参数名升序排序。（2）按请求参数名及参数值相互连接组成一个字符串：<paramName1><paramValue1><paramName2><paramValue2>…；（3）将应用密钥分别添加到以上请求参数串的头部和尾部：<secret><请求参数字符串><secret>。（4）对该字符串进行SHA1运算，得到一个二进制数组；（5）将该二进制数组转换为十六进制的字符串，该字符串即是这些请求参数对应的签名。9.2获取微网站首页信息接口9.2.1获取微网站的页面幻灯片信息9.2.1.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、模块ID、系统ID。9.2.1.2输出参数输出参数为：状态码、错误信息。9.2.2获取微网站的模块信息9.2.2.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、系统ID、是否发布。9.2.2.2输出参数输出参数为：状态码、错误信息。9.3微网站访问统计接口9.3.1接口描述记录商城访问。9.3.2输入参数输入参数为：认证签名、应用标识、手机唯一标识、系统ID、用户ID、类型（微官网或微信）。9.3.3输出参数8输出参数为：状态码、返回信息。9.4注册/登录9.4.1验证手机或发送验证码9.4.1.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、系统ID、接受验证码的手机号码。9.4.1.2输出参数输出参数为：状态码、返回信息。9.4.2重新获取验证码9.4.2.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、系统ID、接受验证码的手机号码。9.4.2.2输出参数输出参数为：状态码、返回信息。9.4.2登录9.4.2.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、系统ID、接受验证码的手机号码、验证码。9.4.2.2输出参数输出参数为：状态码、返回信息。9.4.3核对验证码9.4.3.1输入参数输入参数为：手机号码、验证码。9.4.3.2输出参数输出参数为：状态码、返回信息。9.4.4绑定会员卡9.4.4.1输入参数输入参数为：手机号码、会员卡号。9.4.4.2输出参数输出参数为：状态码、返回信息。9.4.5注册9.4.5.1输入参数9输入参数为：认证签名、应用标识、手机唯一标识、系统id、手机号码、用户名、生日。9.4.5.2输出参数输出参数为：状态码、返回信息。9.5剧院活动管理接口9.5.1获取活动列表9.5.1.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、系统ID、类型（1.热门活动、2.商品活动）、页码（默认第一页）、页长度（默认的记录条数）、时间戳。9.5.1.2输出参数输出参数为：状态码、返回信息。9.5.12获取活动详细信息9.5.2.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、系统ID、活动ID、用户ID。9.5.2.2输出参数输出参数为：状态码、返回信息。9.6剧院简介管理接口9.6.1获取剧院简介接口9.6.1.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、剧院简介ID、系统ID。9.6.1.2输出参数输出参数为：状态码、返回信息。9.6.2获取剧院内容接口9.6.2.1输入参数输入参数为：认证签名、应用标识、手机唯一标识、系统ID。9.6.2.2输出参数输出参数为：状态码、返回信息。10会员卡管理系统接口10.1会员卡信息同步接口当会员卡管理系统中，会员卡信息发生变化（新增、更新、注销等）后，调用外部服务系统提供的接口，及时将会员卡变化信息推送至外部服务系统进行同步更新。10.1.1输入参数输入参数为：操作类型、数据集、会员编号、会员名称、公司名称、电话地址、会员卡号、身份证号、性别、出生日期、登记日期、有效期限、总消费额、总折扣额、总积分、会员状态、会员等级、余额。10.1.2输出参数输出参数为：状态码、返回信息。10.2虚拟会员信息同步接口虚拟会员与实体会员卡进行绑定后，外部服务系统将变更的会员信息（积分、余额等）实时推送到会员卡管理系统进行同步保存更新。10.2.1输入参数输入参数为：会员编号、会员名称、公司名称、电话地址、会员卡号、身份证号、性别、出生日期、登记日期、有效期限、总消费额、总折扣额、总积分、会员状态、会员等级、余额。10.2.2输出参数输出参数为：状态码、返回信息。10.3会员消费记录接口会员卡管理系统调用外部服务系统提供的接口，将会员卡消费历史记录推送到外部服务系统。10.3.1输入参数输入参数为：消费门店号、流水号、消费时间、会员编号、商品编码、专柜商号、商品类别、消费类别、零售单价、零售数量、优惠金额、积分额、消费金额。10.3.2输出参数输出参数为：状态码、返回信息。10.4会员充值记录接口会员卡管理系统调用外部服务系统提供的接口，将会员卡的充值记录实时推送到外部服务系统。10.3.1输入参数输入参数为：充值专柜号、流水号、充值时间、充值金额、充值前金额、充值后金额、充值渠道、会员编号、积分额。10.3.2输出参数输出参数为：状态码、返回信息。11票务系统接口11.1剧院排期接口11.1.1接口描述票务系统提供中间表，外部服务系统通过中间表查询获取剧院排期数据。票务系统为外部服务系统提供剧院节目排期表结构信息，并为其创建一个数据库用户，分配该表的查询权限。11.1.2输入参数11.1.3输出参数输出参数：最低票价、最高票价、演出商品的编号、喜欢数、演出商品的编号、演出名称、项目状态（0售票中；1预售；2无效；3待定；4售完；5延期；6取消；7已结束(商品下架时自动变更为此状态)）、缩略图地址（并非全地址URL）、场馆编号、场馆名称、开始日期(格式：yyyy-MM-dd)、结束日期(格式：yyyy-MM-dd)、创建时间（date）、一级分类编号、一级分类名称、二级分类编号、二级分类名称；场馆流水ID、场馆名称、场馆地址、场馆推荐是否显示(0不显示，1显示)；商品大类别流水ID、商品大类别名称、商品大类别序号（排序）；商品子类别流水ID、商品子类别名称、商品大类别流水ID、商品大类别名称、商品子类别序号（排序）。11.2用户购票接口11.2.1接口描述外部服务系统与票务系统做界面集成，完成系统在线售票功能，票务系统提供售票访问的URL给外部服务系统。11.2.2输入参数11.2.3输出参数输出参数：节目编号11.3我的订单接口11.3.1接口描述票务系统提供中间表，外部服务系统通过中间表查询我的订单数据。票务系统为外部服务系统提供我的订单表结构信息，并为其创建一个数据库用户，分配该表的查询权限。11.3.2输入参数11.3.3输出参数输出参数：订单编号、会员编号、订单来源、订单创建时间、订单座位信息、订单状态、订单支付标记、演出商品编号、演出商品名称、演出商品图片、演出场馆编号、演出场馆名称、演出日期和时间、订单应收、订单实收、使用余额数、使用积分值、一级分类编号、一级分类名称、二级分类编号、二级分类名称。11.4会员信息修改11.4.1接口描述用户进行订单确认时需要输入用户收获地址，票务管理系统调用外部服务系统会员信息查询接口查询会员地址，若没有地址，用户需要输入新地址，此时票务管理系统调用外部服务系统会员信息修改接口将会员地址推送到外部服务系统进行保存。11.4.2输入参数输入参数：会员编号、身份证号、邮箱、地址。11.4.3输出参数输出参数为：状态码、返回信息。11.5消费余额同步11.5.1接口描述当会员支付成功后，票务系统将用户电子钱包支付扣减的金额同步到外部服务系统，同步扣减会员的余额。11.5.2输入参数输入参数：会员编号、产生时间、金额、备注。11.5.3输出参数输出参数为：状态码、返回信息。11.6电子钱包验证11.6.1接口描述会员支付订单选择用“电子钱包”支付时。需要验证“电子钱包”密码是否正确。如果正确则返回“成功”及实时余额，如果不正确则返回“失败”。11.6.2输入参数输入参数：会员编号、电子钱包密码。11.6.3输出参数输出参数为：状态码、返回信息、余额。12智能泊车系统接口12.1反向寻车接口12.1.1接口描述用户通过手机APP点击反向寻车功能，停车场系统根据顾客输入的车牌号，查询车辆停车位置信息，包含停车楼层、车辆停放区域（如A区、B区）、停车车位号等信息，与停车场地图POI信息对应，根据路线规划通过图聚提供的导航引擎进行导航，导航到停车位。12.1.2输入参数输入参数：车牌号。12.1.3输出参数输出参数为：状态码、返回信息、停车楼层、车辆停放区域、停车车位号余额。12.2查询空车位信息接口12.2.1接口描述用户通过手机APP点击空车位查询按钮，执行空车位查询操作，停车场管理系统将所有停车空位信息（包括空车位总数、每一层和每个区域的空车位数量以及空车位对应的地图上具体位置）查出，在地图上显示。12.2.2输入参数12.2.3输出参数输出参数为：空车位总数、某层空车位数、某区域空车位数。12.3空车位详细信息接口12.3.1接口描述用户通过手机APP点击空车位查询按钮，执行空车位查询操作，停车场管理系统将所有停车空位信息查出，在地图上显示。用户通过APP选定某个空车位，停车场管理系统返回该空车位具体位置信息，包括空车位的编号、坐标等信息。根据定位用户的位置及选定的空车位的坐标，导航到该空车位。外部服务系统通过传入选定的空车位编号，与停车场系统做应用集成。12.3.2输入参数车位编号。12.3.3输出参数输出参数为：状态码、返回信息、空车位编号、空车位坐标。12.4获取车辆失位接口12.4.1接口描述停车场管理系统判断车辆移位，将车辆失位告警信息，包括车牌号、车位号、停车区域、失位告警信息，通过调用外部服务系统提供的接口将车辆失位信息推送过来。12.4.2输入参数输入参数：车位编号、停车区域、停放车位、进入时间、告警信息。12.4.3输出参数输出参数为：状态码、返回信息。12.5获取无牌车接口12.5.1接口描述根据给定的时间段，获取该时间段内的所有无牌