客户经理行销app接口定义
宽带包年
接口清单
接口 | url path | 前端认可 | 后端认可 |
---|---|---|---|
生成内部串号 | /code/internal | Y | N |
获取手机资费套餐 | /products/mobile | N | Y |
获取固话资费套餐 | /products/fixed | Y | Y |
获取IPTV资费套餐 | /products/iptv | N | N |
获取手机套餐包
GET /products/mobile
响应范例
{
"products": [
"宽带包年890元50M(一年期)",
"宽带包年1580元50M(两年期)",
"宽带包年1190元1000M(一年期",
"宽带包年2080元100M(两年期",
"宽带包年2780元200M(两年期"
]
}
获取固话套餐包
GET /products/fixed
响应范例
{
"products": [
"固话(10元/月)",
"固话(15元/月)100分钟",
"固话(30元/月)300分钟",
"固话虚装0元"
]
}
刘冰接口
获取宽带空闲号码
描述:
获取空闲的宽带号码,BSS只返回1个,同时预占
请求:
{
"STAFF_ID": "TEST0032",
"EPARCHY_CODE": "0022",
"CITY_CODE": "0041"
}
响应:
{
"SERIAL_NUMBER": "02226308800"
}
获取固话空闲号码
描述:
获取空闲的固话号码,调用IOM接口返回号码列表
请求:
{
"STAFF_ID": "TEST0032",
"EPARCHY_CODE": "0022",
"CITY_CODE": "0041"
}
响应:
{
"SERIAL_NUMBER_LIST": [
{
"SERIAL_NUMBER": "02226308800"
},
{
"SERIAL_NUMBER": "02226308801"
}
]
}
获取可选产品信息
描述:
根据用户区域及网别获取可选产品列表
wo-esale获取,并控制产品ID和BSS产品及资费对应关系
NET_TYPE_CODE 30:固话产品;44:宽带产品:47:IPTV产品
请求:
{
"STAFF_ID": "TEST0032",
"EPARCHY_CODE": "0022",
"CITY_CODE": "0041",
"NET_TYPE_CODE":"44"
}
响应:
{
"PRODUCT_LIST": [
{
"PRODUCT_ID": "81010631",
"PRODUCT_NAME": "宽带包年890元50M(一年期)"
},
{
"PRODUCT_ID": "81010635",
"PRODUCT_NAME": "宽带包年1580元50M(两年期)"
}
]
}
用户资料信息查询接口
描述:
根据用户号码查询用户资料
补卡业务时,先进行读身份证,调用此接口时传入证件相关信息,用于和号码所属客户比对
SERVICE_TYPE 00:查询基本用户信息;01:换卡;02:用户资料返档
CUST_TYPE 01:个人客户;02:集团客户
请求:
{
"SERVICE_TYPE": "01",
"SERIAL_NUMBER": "15620009200",
"CUST_NAME": "",
"PSPT_ID": "",
"PSPT_TYPE_CODE": ""
}
响应:
{
"RSP_CODE": "0000",
"RSP_DESC": "",
"CUST_INFO": {
"CUST_ID": "9114110327900173",
"CUST_NAME": "朱玉超",
"PSPT_ID": "120223198610012017",
"PSPT_TYPE_CODE": "0",
"PSPT_ADDR": "河东区郑庄子月牙河南路30号",
"PSPT_END_DATE": "2050-12-31",
"CUST_TYPE": "01"
},
"USER_INFO": {
"USER_ID": "640288769",
"STATE_CODE": "0",
"STATE": "开通",
"OPEN_DATE": "2016-12-16 21:00:00",
"PRODUCT_ID": "99002138",
"PRODUCT_NAME": "WCDMA(3G)-96元基本套餐-A",
"SIM_CARD_NO": "8986010852022351900"
},
}
读/写SIM卡
沿用4G开户读/写SIM卡信息接口
发展人信息查询
沿用4G开户调用发展人接口
订购信息合法性验证与费用计算
描述:
根据app选择内容,wo-esale组织报文,提交到BSS进行合法性校验,包括产品模型校验
根据选择内容计算费用
预提交接口
描述:
订单预提交,提交信息包括:客户资料、产品信息、活动信息BSS生成订单,工单状态为未提交,并对请求报文中的内容进行全面校验。
请求:
{
"SERVICE_TYPE": "01",
"SERIAL_NUMBER": "15620009200",
"CUST_NAME": "",
"PSPT_ID": "",
"PSPT_TYPE_CODE": ""
}
正式提交
描述:
订单预提交、收款结束后正式提交订单
返回码:
应答编码 | 应答描述 | 描述 |
---|---|---|
0000 | 成功 | |
0001 | 该号码不存在 | |
0002 | 欠费号码 | |
0003 | 停机用户不允许受理 | |
0004 | 用户有未竣工工单 | |
0005 | 该用户在锁定期或充值期内 | |
0006 | 认证客户和号码所属客户不一致 | 过户业务 |
0007 | 该用户不是未返单用户,不能办理此业务 | 用户资料返档业务 |
为什么用 markdown 写前后分离 API
- 纯文本格式:体积小、编辑器任选;比二进制和xml文档格式方便
- 在线编辑,随时发布;持续更新,持续发布;迭代快速
- 容易书写,和 markup 相反,markdown 非常简单方便
- 方便转换成 html,配合各种css形成各种样式,可以添加内嵌代码的语法高亮
- 可以结合版本管理,比对任何两个时间点版本变化,看到每行文字何时最后由谁编写
- 简单的 diff 比较也很容易
API 接口描述编写的要点
- 组织划分
- 可以按前台功能页面作为 path 第一级
- 也可以按照别的方式
- 考虑一些不同的功能页面中公用的一些接口,有一致性要求的必须共享,没有一致性要求的拷贝即可
- 请求格式
- 数据获取的的请求通常比较简单,全部用 get + 查询串参数即可
- 数据获取的结果,一律封装到
{prop: value }
格式中,因为为了性能,一个请求可以返回原先多个原子请求的内容,由于有各自的根属性,融合比较简单 - 请求最终提交,采用 post,内容为完整的 json
- path 和 json 属性命名规则
- 业务术语统一一致
- 采用
part1_part2_part3
下划线格式,的看,容易按关键字搜索 - 和传统的 bss/cbss 的术语一致更方便
markdown 介绍
脚注
生成一个脚注1.
UML 图:
可以渲染序列图:
或者流程图:
离线写博客
即使用户在没有网络的情况下,也可以通过本编辑器离线写博客(直接在曾经使用过的浏览器中输入write.blog.csdn.net/mdeditor即可。Markdown编辑器使用浏览器离线存储将内容保存在本地。
用户写博客的过程中,内容实时保存在浏览器缓存中,在用户关闭浏览器或者其它异常情况下,内容不会丢失。用户再次打开浏览器时,会显示上次用户正在编辑的没有发表的内容。
博客发表后,本地缓存将被删除。
用户可以选择 把正在写的博客保存到服务器草稿箱,即使换浏览器或者清除缓存,内容也不会丢失。
注意:虽然浏览器存储大部分时候都比较可靠,但为了您的数据安全,在联网后,请务必及时发表或者保存到服务器草稿箱。
浏览器兼容
- 目前,本编辑器对Chrome浏览器支持最为完整。建议大家使用较新版本的Chrome。
- IE9以下不支持
- IE9,10,11存在以下问题
- 不支持离线功能
- IE9不支持文件导入导出
- IE10不支持拖拽文件导入
- 这里是 脚注 的 内容. ↩