接口文档

Posted

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了接口文档相关的知识，希望对你有一定的参考价值。

  模块 功能 接口 URL 功能代码 前端 后端 测试 调试情况 备注    
  运营活动 查询活动列表 活动列表查询接口（登陆区外） /btoa/portal/act/getActList 　 　 　 　 　 　    
  运营活动 查询活动产品内容 预约产品活动接口(登陆区外) /btoa/portal/act/getActAndProduct 　 　 　 　 　 　    
  运营活动 抽奖接口 抽奖接口（登录区内） /btoa/work/seckillact/seckillWinPrizeProc 　 　 　 　 　 　    
  运营活动 查询客户的中奖纪录 客户中奖纪录查询接口（登录区内） /btoa/work/act/getActPrizeUserInfoList 　 　 　 　 　 　    
  运营活动 查询客户是否参与抽奖 客户是否参与抽奖活动接口（登录区内） /btoa/work/act/checkPrizedStatus 　 　 　 　 　 　    
  运营活动 用于收集用户相关信息 客户信息采集接口（登录区内） /btoa/work/act/collectUserInfo 　 　 　 　 　 　    
  运营活动 用户事件查询接口 用户事件查询接口（登陆区内） /btoa/work/act/getUserEventList 　 　 　 　 　 　    
　 运营活动 ESA 用户事件新增接口（登陆区内） @ESA("ff.mc.base.addUserEvent") 　 　 　 　 　 　 　 　
  运营活动 推荐奖励查询接口[标准版] 推荐奖励查询接口（登陆区内）[标准版] /btoa/work/act/getRecomendReward 　 　 　 　 　 　    
                         
                         
                         
                         
                         
                         
                         
  模块 功能 接口 测试进度                
  运营活动 查询活动列表 活动列表查询接口（登陆区外） 　                
  运营活动 查询活动产品内容 预约产品活动接口(登陆区外)                
  运营活动 抽奖接口 抽奖接口（登录区内）                
  运营活动 查询客户的中奖纪录 客户中奖纪录查询接口（登录区内）                
  运营活动 查询客户是否参与抽奖 客户是否参与抽奖活动接口（登录区内）                
  运营活动 用于收集用户相关信息 客户信息采集接口（登录区内）                
  运营活动 用户事件查询接口 用户事件查询接口（登陆区内）                
  运营活动 ESA 用户事件新增接口（登陆区内）                
  运营活动 推荐奖励查询接口[标准版] 推荐奖励查询接口（登陆区内）[标准版]                
                       

 

 

 

    接口目录          
  序号 字段名称 字段类型 字段说明 是否必输 备注  
  活动列表查询接口（外）/btoa/portal/act/getActList  
  输入  
  1 　 　 　 　 　  
  输出 　 　 　 　 　  
  1 code String 返回码  　 000000表示成功，其他表示失败  
  2 msg String 返回消息 　 　  
  recommendList start  
  1 actTmplId String 活动编号 　 　  
  2 actSort String 活动类型 　 000-预约活动
001-红包活动
002-油卡活动
003-获客活动                                                                                                                                                                              		 秒杀活动
  3 bindEventFlag String 是否绑定事件 　 0-否，1-是 是否有绑卡，房，车
  4 addressOne String 地址一 　 url地址一  
  5 addressTwo String 地址二 　 url地址二  
  recommendList end  
               
  接口目录        
序号 字段名称 字段类型 字段说明 是否必输 备注
预约产品活动接口(外)/btoa/portal/act/getActAndProduct
输入
1 actTmplId String 活动编号 Y 　
输出 　 　 　 　 　
1 code String 返回码  　 000000表示成功，其他表示失败
2 msg String 返回消息 　 　
recommendList start
1 productId String 产品ID 　 　
2 actTmplId String 活动编号 　 　
3 incomeRate String 预期收益率 　 　
4 productSlogan String 宣传语 　 　
5 productName String 产品名称 　 　
6 productShortName String 产品简称 　 　
7 productLimit String 产品期限 　 　
8 currency String 理财币种 　 　
9 investmentAmount String 认购起点 　 （起点金额）
10 prospectusStartDate String 募集开始时间 yyyy-MM-dd HH:mm:ss 　
11 prospectusEndDate String 募集结束时间 yyyy-MM-dd HH:mm:ss （起点金额）
recommendList end
recommendBean start
2 actName String 活动名称 　 　
2 bgImgUrl String 背景图片链接 　 　
3 btnTxt String 活动首页背景颜色 　 　
4 shareTitle String 分享标题 　 　
5 shareRemark String 分享摘要 　 　
6 shareImgUrl String 分享图片链接 　 H5活动页面链接url
7 shareBtnImgUrl String 分享按钮图片链接 　 分享图片链接imageUrl
8 prizedBtnImgUrl String 抽奖按钮图片链接 　 　
9 periodDate String 阶段日期 　 新增:预约与购买阶段切换日(YYYYMMDD)
10 periodTime String 阶段时间 　 新增(HH:MI)
11 parActStartDate String 活动开始日期 　 YYYYMMDD
12 parActEndDate String 活动结束日期 　 YYYYMMDD
13 parActStartTime String 活动开始时间 　 HH:MI
14 parActEndTime String 活动结束时间 　 HH:MI
15 promWinningTxt String 中奖 　 　
16 promWinningedTxt String 已经中过奖 　 　
17 promWinningEndTxt String 已抢完奖 　 　
18 promNoWinningTxt1 String 没中奖提示1 　 　
19 promNoWinningTxt2 String 没中奖提示2 　 　
20 promNoWinningTxt3 String 没中奖提示3 　 　
21 promBeforeActdateTxt String 活动日期前 　 　
22 promAfterActdateTxt String 活动日期后 　 　
23 promBeforeActtimeTxt String 活动时间前 　 　
24 promAfterActtimeTxt String 活动时间后 　 　
25 promCustomBtnName String 自定义按钮名称 　 　
26 promCustomLinkUrl String 自定义链接 　 　
27 promDownloadLinkUrlFlg String 下载链接标识 　 　
28 promPublicnoPrizeMsg String 公众号中奖消息 　 　
29 promRefTxt String 引导文字 　 　
30 detailRules String 详细规则 　 　
31 shareImageCode String 分享图片加密编码 　 　
actTmplList end

 

序号 字段名称 字段类型 字段说明 是否必输 备注
抽奖接口（登陆区内）/btoa/work/seckillact/seckillWinPrizeProc
输入
1 actTmplId String 活动编号 Y 抽红包、抽油卡分别为不同活动编号 
输出 　 　 　 　 　
1 code String 返回码  　 000000表示成功，其他表示失败，用于判断抽奖是否成功
2 msg String 返回消息 　
recommendBean start
1 outRetCode  String 返回码  　 0表示成功，其他表示失败，用于判断是否中奖
2 outMessage  String 返回消息 　
3 prizeUserId  String 中奖记录编号 　 　
4 restPrizeTimes String 剩余抽奖次数 　 　
actPrizeDTO start
1 prizeName String 奖品名称 　 　
2 prizeImgurl String 奖品图片地址 　 　
3 prizeExchangeCodeFlgValue String 奖品是否为兑换码 　 　
4 itemValue String 奖项 　 　
5 prizeRemark  String 奖品备注 　 　
actPrizeDTO end
recommendBean end

 

序号 字段名称 字段类型 字段说明 是否必输 备注
客户中奖纪录查询接口（登陆区内）/btoa/work/act/getActPrizeUserInfoList
输入
2 actTmplId String 活动编号列表 Y id1,id2,…
输出 　 　 　 　 　
1 code String 返回码  　 000000表示成功，其他表示失败
2 msg String 返回消息 　 　
recommendList start
1 prizeUserId String 中奖记录编号 　 　
2 prizeId String 奖品id 　 　
3 prizeName String 奖品名称 　 　
4 itemValue String 奖项 　 　
5 takeEndDate String 兑奖截止日 　 yyyy-MM-dd
6 prizedTime String 兑奖时间 　 yyyy-MM-dd HH:mm:ss
7 collectflag String 信息采集状态 0-否;1-是 　
8 mobileNo String 手机号 　 　
recommendList end
           
{"code":"000000","data":{"recommendList":[{"itemValue":"三等奖","prizeId":"2957E09B406925CFE053C081140AB7C9","prizeName":"10元红包","prizedTime":1453203807000,"takeEndDate":1455811200000}]},"msg":"操作成功！"}

 

  接口目录        
序号 字段名称 字段类型 字段说明 是否必输 备注
客户是否参与抽奖活动接口（登陆区内）/btoa/work/act/checkPrizedStatus
输入
1 actTmplId String 活动编号 Y 　
输出 　 　 　 　 　
1 code String 返回码  　 000000表示成功，其他表示失败
2 msg String 返回消息 　 　
3 prizeflag String 抽奖状态 0-否;1-是 　
4 usedPrizeTimes String 已用抽奖次数 　 　
5 restPrizeTimes String 剩余抽奖次数 　 　
序号 字段名称 字段类型 字段说明 是否必输 备注
客户信息采集接口（登陆区内）/btoa/work/act/collectUserInfo
输入
1 inputMobileNo String 输入手机号 Y 　
2 userName String 用户名 Y 　
3 address String 地址 Y 　
4 actTmplId String 活动编号  Y 送抽油卡活动编号
5 prizeUserId String 中奖记录编号 Y 　
输出 　 　 　 　 　
1 code String 返回码  　 000000表示成功，其他表示失败
2 msg String 返回消息 　 　
           
{"code":"999999","data":{},"msg":"该中奖用户已经存在，增加中奖用户信息失败！"}
{"code":"000000","data":{},"msg":"数据添加成功"}

 

序号 字段名称 字段类型 字段说明 是否必输 备注
用户事件查询接口（登陆区内）/btoa/work/act/getUserEventList
输入
1 actTmplId String 活动编号 Y id1,id2……
输出 　 　 　 　 　
1 code String 返回码  　 000000表示成功，其他表示失败
2 msg String 返回消息 　 　
recommendList start
1 actTmplId String 活动编号 　 　
2 eventName String 事件名称 　 　
3 eventNo String 事件编号 　 　
4 eventType String 事件类型 　 0-大事件，1-小事件
5 prizeType String 奖励类型 　 　
6 prizeTimes String 奖励次数 　 　
7 imageUrl String 图标url 　 　
8 actionType String 行为类型 　 　
9 actionUrl String 行为Url 　 　
10 unoperatedImageUrl String 未操作行为图标URL 　 　
11 operatedImageUrl String 已操作行为图标URL 　 　
12 eventValidStartTime String 事件有效开始时间 　 yyyy-MM-dd hh:mm:ss
13 eventValidEndTime String 事件有效结束时间 　 yyyy-MM-dd hh:mm:ss
14 eventDealUrl String 事件处理Url 　 　
15 finishFlag String 是否已完成 　 0-否，1-是
recommendList end
序号 字段名称 字段类型 字段说明 是否必输 备注
用户事件新增ESA @ESA("ff.mc.base.addUserEvent")
输入
1 eventNo String 事件编号 Y 　
2 mobileNo String 手机号 Y 　
输出 　 　 　 　 　
1 code String 返回码  　 000000表示成功，其他表示失败
2 msg String 返回消息 　 　

 

  接口目录        
序号 字段名称 字段类型 字段说明 是否必输 备注
分享活动返回的人数和金额（登陆区内）/btoa/work/act/getRecomendReward
输入
1 actTmplId String 活动编号 Y 　
输出 　 　 　 　 　
1 code String 返回码  　 000000表示成功，其他表示失败
2 msg String 返回消息 　 　
3 peoples String 推荐人数 　 按规则数量类型对外显示推荐总数或激活总数
4 money String 奖励内容 　 　

以上是关于接口文档的主要内容，如果未能解决你的问题，请参考以下文章

Spring Boot - 自动生成接口文档

Restful接口文档规范

接口文档

接口文档

自动生成接口文档

Swagger接口文档