swagger.yaml 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412
  1. definitions:
  2. account.Useresignrecord:
  3. properties:
  4. authinfo:
  5. description: 认证信息
  6. type: string
  7. contractfileaddr:
  8. description: 合同签署文件地址
  9. type: string
  10. contractno:
  11. description: 合同编号
  12. type: string
  13. createtime:
  14. description: 创建时间
  15. type: string
  16. creatorid:
  17. description: 创建人
  18. type: integer
  19. orderindex:
  20. description: 显示顺序
  21. type: integer
  22. recordid:
  23. description: 记录ID(SEQ_USERESIGNRECORD)
  24. type: integer
  25. recordstatus:
  26. description: 记录状态 - 1:未签署 2:签署中 3:已签署 4:签署拒绝
  27. type: integer
  28. signremark:
  29. description: 签署备注
  30. type: string
  31. signurl:
  32. description: 合同签署URL(三方URL)
  33. type: string
  34. templateconfigid:
  35. description: 模板配置ID
  36. type: integer
  37. templatename:
  38. description: 模板名称
  39. type: string
  40. templateno:
  41. description: 模板编号(电子签类型对应的模板编号)
  42. type: string
  43. templatetype:
  44. description: 模板类型 - 1:实名认证 2:开户协议
  45. type: integer
  46. updatetime:
  47. description: 更新时间
  48. type: string
  49. userid:
  50. description: 用户ID
  51. type: integer
  52. type: object
  53. request.AddUserReq:
  54. properties:
  55. idCard:
  56. description: 证件号码
  57. type: string
  58. idCardPhoto:
  59. description: 证件照正面
  60. type: string
  61. idCardPhotoBackURL:
  62. description: 证件照背面
  63. type: string
  64. idCardType:
  65. description: 证件类型(默认1):1-居民身份证 2-台湾居民来往内地通行证 3-港澳居民往来内地通行证 10-武装警察身份证 11-军人身份证
  66. 15-警察(警官)证 21-外国人永久居留证 23-护照
  67. type: integer
  68. mobile:
  69. description: 手机号码
  70. type: string
  71. name:
  72. description: 用户姓名
  73. type: string
  74. required:
  75. - idCard
  76. - name
  77. type: object
  78. request.CreateContractAndAddSignerReq:
  79. properties:
  80. templateNo:
  81. description: 合同模板编号
  82. type: string
  83. required:
  84. - templateNo
  85. type: object
  86. request.LoginReq:
  87. properties:
  88. clientType:
  89. description: 客户端类型,2-PC交易端 3-手机客户端_安卓 4-网页客户端 5-微信客户端 6-手机客户端_苹果
  90. type: integer
  91. password:
  92. description: 密码
  93. type: string
  94. userName:
  95. description: 用户名,可以是LoginID/LoginCode/手机号码
  96. type: string
  97. required:
  98. - clientType
  99. - password
  100. - userName
  101. type: object
  102. request.MQBodyReq:
  103. properties:
  104. data:
  105. description: 请求数据
  106. type: string
  107. funCodeReq:
  108. description: 请求功能码
  109. type: integer
  110. funCodeRsp:
  111. description: 回复功能码
  112. type: integer
  113. isEncrypted:
  114. description: 是否加密
  115. type: boolean
  116. required:
  117. - data
  118. - funCodeReq
  119. - isEncrypted
  120. type: object
  121. request.MQNtfReq:
  122. properties:
  123. data:
  124. description: 数据
  125. type: string
  126. funCode:
  127. description: 功能码
  128. type: integer
  129. topic:
  130. description: 主题
  131. type: string
  132. required:
  133. - data
  134. - funCode
  135. type: object
  136. response.LoginRsp:
  137. properties:
  138. expiresAt:
  139. description: 过期时间
  140. type: integer
  141. loginId:
  142. description: 登录ID
  143. type: integer
  144. token:
  145. description: 新服务Token
  146. type: string
  147. userId:
  148. description: 用户ID
  149. type: integer
  150. type: object
  151. response.MQBodyRsp:
  152. properties:
  153. data:
  154. description: 请求数据
  155. type: string
  156. funcode:
  157. description: 回复功能码
  158. type: integer
  159. isEncrypted:
  160. description: 是否加密
  161. type: boolean
  162. type: object
  163. response.Response:
  164. properties:
  165. code:
  166. type: integer
  167. data: {}
  168. msg:
  169. type: string
  170. type: object
  171. info:
  172. contact: {}
  173. description: 新接入服务
  174. title: Swagger Example API
  175. version: 0.0.1
  176. paths:
  177. /Account/AddUser:
  178. post:
  179. consumes:
  180. - application/json
  181. parameters:
  182. - description: 入参
  183. in: body
  184. name: data
  185. required: true
  186. schema:
  187. $ref: '#/definitions/request.AddUserReq'
  188. produces:
  189. - application/json
  190. responses:
  191. "200":
  192. description: 出参
  193. schema:
  194. allOf:
  195. - $ref: '#/definitions/response.Response'
  196. - properties:
  197. msg:
  198. type: string
  199. type: object
  200. security:
  201. - ApiKeyAuth: []
  202. summary: 实名认证添加用户
  203. tags:
  204. - 账户服务
  205. /Account/CreateContractAndAddSigner:
  206. post:
  207. consumes:
  208. - application/json
  209. parameters:
  210. - description: 入参
  211. in: body
  212. name: data
  213. required: true
  214. schema:
  215. $ref: '#/definitions/request.CreateContractAndAddSignerReq'
  216. produces:
  217. - application/json
  218. responses:
  219. "200":
  220. description: 出参
  221. schema:
  222. allOf:
  223. - $ref: '#/definitions/response.Response'
  224. - properties:
  225. data:
  226. type: string
  227. msg:
  228. type: string
  229. type: object
  230. security:
  231. - ApiKeyAuth: []
  232. summary: 上传待签署文件和添加签署方
  233. tags:
  234. - 账户服务
  235. /Account/Login:
  236. post:
  237. consumes:
  238. - application/json
  239. parameters:
  240. - description: 登录入参
  241. in: body
  242. name: data
  243. required: true
  244. schema:
  245. $ref: '#/definitions/request.LoginReq'
  246. produces:
  247. - application/json
  248. responses:
  249. "200":
  250. description: 返回包括用户信息,token,过期时间
  251. schema:
  252. allOf:
  253. - $ref: '#/definitions/response.Response'
  254. - properties:
  255. data:
  256. $ref: '#/definitions/response.LoginRsp'
  257. msg:
  258. type: string
  259. type: object
  260. summary: 账户登录
  261. tags:
  262. - 账户服务
  263. /Account/Loginout:
  264. get:
  265. consumes:
  266. - application/json
  267. produces:
  268. - application/json
  269. responses:
  270. "200":
  271. description: 出参
  272. schema:
  273. allOf:
  274. - $ref: '#/definitions/response.Response'
  275. - properties:
  276. msg:
  277. type: string
  278. type: object
  279. security:
  280. - ApiKeyAuth: []
  281. summary: 用户登出请求
  282. tags:
  283. - 账户服务
  284. /Account/QueryUserESignRecord:
  285. get:
  286. consumes:
  287. - application/json
  288. produces:
  289. - application/json
  290. responses:
  291. "200":
  292. description: 出参
  293. schema:
  294. allOf:
  295. - $ref: '#/definitions/response.Response'
  296. - properties:
  297. data:
  298. items:
  299. $ref: '#/definitions/account.Useresignrecord'
  300. type: array
  301. msg:
  302. type: string
  303. type: object
  304. security:
  305. - ApiKeyAuth: []
  306. summary: 查询用户电子签记录表
  307. tags:
  308. - 账户服务
  309. /Account/SignCompleted:
  310. post:
  311. consumes:
  312. - application/json
  313. produces:
  314. - application/json
  315. responses:
  316. "200":
  317. description: 出参
  318. schema:
  319. allOf:
  320. - $ref: '#/definitions/response.Response'
  321. - properties:
  322. msg:
  323. type: string
  324. type: object
  325. security:
  326. - ApiKeyAuth: []
  327. summary: 提交实名认证
  328. tags:
  329. - 账户服务
  330. /Account/TokenCheck:
  331. get:
  332. consumes:
  333. - application/json
  334. produces:
  335. - application/json
  336. responses:
  337. "200":
  338. description: 操作成功
  339. schema:
  340. allOf:
  341. - $ref: '#/definitions/response.Response'
  342. - properties:
  343. msg:
  344. type: string
  345. type: object
  346. security:
  347. - ApiKeyAuth: []
  348. summary: Token校验
  349. tags:
  350. - 账户服务
  351. /MQ/SendMsgToMQ:
  352. post:
  353. consumes:
  354. - application/json
  355. parameters:
  356. - description: 入参
  357. in: body
  358. name: data
  359. required: true
  360. schema:
  361. $ref: '#/definitions/request.MQBodyReq'
  362. produces:
  363. - application/json
  364. responses:
  365. "200":
  366. description: 出参
  367. schema:
  368. allOf:
  369. - $ref: '#/definitions/response.Response'
  370. - properties:
  371. data:
  372. $ref: '#/definitions/response.MQBodyRsp'
  373. msg:
  374. type: string
  375. type: object
  376. security:
  377. - ApiKeyAuth: []
  378. summary: 总线业务
  379. tags:
  380. - 总线业务
  381. /MQ/SendNtfToMQ:
  382. post:
  383. consumes:
  384. - application/json
  385. parameters:
  386. - description: 入参
  387. in: body
  388. name: data
  389. required: true
  390. schema:
  391. $ref: '#/definitions/request.MQNtfReq'
  392. produces:
  393. - application/json
  394. responses:
  395. "200":
  396. description: 出参
  397. schema:
  398. allOf:
  399. - $ref: '#/definitions/response.Response'
  400. - properties:
  401. msg:
  402. type: string
  403. type: object
  404. summary: 总线通知
  405. tags:
  406. - 总线业务
  407. securityDefinitions:
  408. ApiKeyAuth:
  409. in: header
  410. name: x-token
  411. type: apiKey
  412. swagger: "2.0"