菜单

31.绑定年卡参数配置说明

 

 

日期

版本

说明

作者

2021/4/8

V0.0.1

新增文档

张三

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

目录

文档简介

特别声明

阅读对象

产品说明

名词解释

接口工具测试

使用流程

全局参数列表

全局参数

目录参数列表

苏州乐园

绑定年卡

接口列表

苏州乐园

绑定年卡参数配置说明

生产环境资料

如何获取服务器地址

响应返回异常

接入导入

如何快速导入

参数转码无效的解决方案

附录

项目状态码字典

1 文档简介

1.1 特别声明

未得到本公司的书面许可,不得为任何目的、以任何形式或手段(包括但不限于机械的或电子的)复制或传播本文档的任何部分。对于本文档涉及的技术和产品,本公司拥有其专利(或正在申请专利)、商标、版权或其它知识产权。除非得到本公司的书面许可协议,本文档不授予这些专利、商标、版权或其它知识产权的许可。

本文档因产品功能示例和描述的需要,所使用的任何人名、企业名和数据都是虚构的,并仅限于本公司内部测试使用,不等于本公司有对任何第三方的承诺和宣传。

1.2 阅读对象

贵公司的技术部门的开发、维护及管理人员,应具备以下基本知识:

1. 了解HTTPS/HTTP协议等内容。

2. 了解信息安全的基本概念。

3. 了解计算机至少一种编程语言。

1.3 产品说明

本开发手册对该系统功能接口进行详细的描述,通过该指南可以对本系统有全面的了解,使技术人员尽快掌握本系统的接口,并能够在本系统上进行开发。

1.4 名词解释

 

名词缩写

名词定义

客户端

本文档中的客户端为ApiPost客户端。

服务端

本文档中的服务端为用户端。

环境变量

本系统中动态的KV参数。

 

1.5 接口工具测试

1. 测试工具推荐ApiPost接口测试工具。官方地址:https://www.apipost.cn

2. ApiPost测试工具使用方法如下:

①. 将网关地址或者接口地址正确输入url;

②. 将所有参数按照下面目录和接口定义中参数从上到下顺序填写;

③. 将目录的全局参数或者脚本正确写入;

④. 将接口的参数和自定义脚本内容填入到对应位置;

3. 自定义脚本支持请求报文加密的数据拼装。

2 使用流程

1. 准备阶段:

A. 申请测试号等信息;

B. 取得开发手册(本文档)等资料;

2. 开发阶段:

A. 根据提供的 DEMO 结合开发文档快速熟悉对接接口;

B. 根据本系统提供的接口,在自己的系统上进行开发,实现所需要的业务功能;

C. 对自己系统的业务功能进行全面测试;

D. 与测试环境进行联调。

3. 生产使用:

A. 使用系统提供的正式资料。

3 全局参数列表

3.1 全局参数

描述:暂无描述

请求参数说明:

参数名

参数值

参数描述

timestamp

{{$microTimestamp}}

暂无描述

 

目录参数列表

4.1 苏州乐园

目录描述:暂无描述

4.2 绑定年卡

目录描述:暂无描述

5 接口列表

5.1 苏州乐园

5.1.1 绑定年卡参数配置说明

 

#### 配置位置:

系统设置-》参数管理

#### 参数说明:

参数名称:CUSTOM_YEAR_CARD_RULES

参数值说明:

参数值为json字符串,例:

```js

{"startDate":"2024-07-31","endDate":"2025-12-31","sendPointRules":[{"cardProCode":"2025001","sendPoint":365,"pointValidDay":365},{"cardProCode":"2025002","sendPoint":598,"pointValidDay":365},{"cardProCode":"2025003","sendPoint":798,"pointValidDay":365},{"cardProCode":"2025004","sendPoint":1999,"pointValidDay":365},{"cardProCode":"2025005","sendPoint":488,"pointValidDay":365},{"cardProCode":"2025006","sendPoint":1999,"pointValidDay":365}]}

**如需修改规则,编辑参数值后重新保存即可。**

 

生产环境资料

6.1 如何获取服务器地址

以阿里云为例,登录阿里云后台找到 ECS 控制台,找到公网地址,复制保存即可。

6.2 响应返回异常

对比Postman和ApiPost实际发出的请求报文(curl、参数、body、header)是否完全吻合。

(关于密码的保管:贵公司一定要保证密码仅能被少数可靠的授权人知晓,严防密码被不可信的人获取,如密码泄露需立即进行修改同时替换程序中的密码。)

 

接入导入

7.1 如何快速导入

①. 获取 DEMO 压缩包:

②. 将请求地址改为测试环境请求地址;

③. 目前仅有 PHP 范例;

④. 将范例部署到您的应用服务器,并运行;

⑤. 在测试环境上请调通接口;

⑥. 请求和响应都调通后,便可在范例中加入您系统本身的业务逻辑,并再次在测试环境进行调试,直至通过;

⑦. 将您正式的密钥配置到程序中,并将请求地址改为正式环境请求地址后便可上线。

7.2 参数转码无效的解决方案

解决方法:

首先检查配置中的参数是否与系统上提供的参数一致,是否有中文。

其次处理中文转码问题,有两个需要正确转码的环节:

①. 涉及中文的参数在传入生成url的方法时,注意编码问题。

②. 生成请求参数后,涉及中文的参数的值不能是乱码,当前仅支持UTF-8的编码格式。

8 附录

8.1 项目状态码字典

 

状态码

描述

 

 

 

一机游后台配置位置:
系统设置-》参数管理

参数说明:
参数名称:CUSTOM_YEAR_CARD_RULES

参数值说明:

参数值为json字符串,例:

{"startDate":"2024-07-31","endDate":"2025-12-31","sendPointRules":[{"cardProCode":"2025001","sendPoint":365,"pointValidDay":365},{"cardProCode":"2025002","sendPoint":598,"pointValidDay":365},{"cardProCode":"2025003","sendPoint":798,"pointValidDay":365},{"cardProCode":"2025004","sendPoint":1999,"pointValidDay":365},{"cardProCode":"2025005","sendPoint":488,"pointValidDay":365},{"cardProCode":"2025006","sendPoint":1999,"pointValidDay":365}]}


如需修改规则,编辑参数值后重新保存即可。

上一个
12.快通票产品设置(流程版)
下一个
会员活动方案及手册
最近修改: 2025-01-08Powered by