swagger.yaml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  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. request.WillFaceReq:
  137. properties:
  138. idCardNo:
  139. description: 身份证号
  140. type: string
  141. realName:
  142. description: 真实姓名
  143. type: string
  144. required:
  145. - idCardNo
  146. - realName
  147. type: object
  148. response.LoginRsp:
  149. properties:
  150. expiresAt:
  151. description: 过期时间
  152. type: integer
  153. loginId:
  154. description: 登录ID
  155. type: integer
  156. token:
  157. description: 新服务Token
  158. type: string
  159. userId:
  160. description: 用户ID
  161. type: integer
  162. type: object
  163. response.MQBodyRsp:
  164. properties:
  165. data:
  166. description: 请求数据
  167. type: string
  168. funcode:
  169. description: 回复功能码
  170. type: integer
  171. isEncrypted:
  172. description: 是否加密
  173. type: boolean
  174. type: object
  175. response.Response:
  176. properties:
  177. code:
  178. type: integer
  179. data: {}
  180. msg:
  181. type: string
  182. type: object
  183. info:
  184. contact: {}
  185. description: 新接入服务
  186. title: Swagger Example API
  187. version: 0.0.1
  188. paths:
  189. /Account/AddUser:
  190. post:
  191. consumes:
  192. - application/json
  193. parameters:
  194. - description: 入参
  195. in: body
  196. name: data
  197. required: true
  198. schema:
  199. $ref: '#/definitions/request.AddUserReq'
  200. produces:
  201. - application/json
  202. responses:
  203. "200":
  204. description: 出参
  205. schema:
  206. allOf:
  207. - $ref: '#/definitions/response.Response'
  208. - properties:
  209. msg:
  210. type: string
  211. type: object
  212. security:
  213. - ApiKeyAuth: []
  214. summary: 实名认证添加用户
  215. tags:
  216. - 账户服务
  217. /Account/CreateContractAndAddSigner:
  218. post:
  219. consumes:
  220. - application/json
  221. parameters:
  222. - description: 入参
  223. in: body
  224. name: data
  225. required: true
  226. schema:
  227. $ref: '#/definitions/request.CreateContractAndAddSignerReq'
  228. produces:
  229. - application/json
  230. responses:
  231. "200":
  232. description: 出参
  233. schema:
  234. allOf:
  235. - $ref: '#/definitions/response.Response'
  236. - properties:
  237. data:
  238. type: string
  239. msg:
  240. type: string
  241. type: object
  242. security:
  243. - ApiKeyAuth: []
  244. summary: 上传待签署文件和添加签署方
  245. tags:
  246. - 账户服务
  247. /Account/Login:
  248. post:
  249. consumes:
  250. - application/json
  251. parameters:
  252. - description: 登录入参
  253. in: body
  254. name: data
  255. required: true
  256. schema:
  257. $ref: '#/definitions/request.LoginReq'
  258. produces:
  259. - application/json
  260. responses:
  261. "200":
  262. description: 返回包括用户信息,token,过期时间
  263. schema:
  264. allOf:
  265. - $ref: '#/definitions/response.Response'
  266. - properties:
  267. data:
  268. $ref: '#/definitions/response.LoginRsp'
  269. msg:
  270. type: string
  271. type: object
  272. summary: 账户登录
  273. tags:
  274. - 账户服务
  275. /Account/Loginout:
  276. get:
  277. consumes:
  278. - application/json
  279. produces:
  280. - application/json
  281. responses:
  282. "200":
  283. description: 出参
  284. schema:
  285. allOf:
  286. - $ref: '#/definitions/response.Response'
  287. - properties:
  288. msg:
  289. type: string
  290. type: object
  291. security:
  292. - ApiKeyAuth: []
  293. summary: 用户登出请求
  294. tags:
  295. - 账户服务
  296. /Account/QueryUserESignRecord:
  297. get:
  298. consumes:
  299. - application/json
  300. produces:
  301. - application/json
  302. responses:
  303. "200":
  304. description: 出参
  305. schema:
  306. allOf:
  307. - $ref: '#/definitions/response.Response'
  308. - properties:
  309. data:
  310. items:
  311. $ref: '#/definitions/account.Useresignrecord'
  312. type: array
  313. msg:
  314. type: string
  315. type: object
  316. security:
  317. - ApiKeyAuth: []
  318. summary: 查询用户电子签记录表
  319. tags:
  320. - 账户服务
  321. /Account/SignCompleted:
  322. post:
  323. consumes:
  324. - application/json
  325. produces:
  326. - application/json
  327. responses:
  328. "200":
  329. description: 出参
  330. schema:
  331. allOf:
  332. - $ref: '#/definitions/response.Response'
  333. - properties:
  334. msg:
  335. type: string
  336. type: object
  337. security:
  338. - ApiKeyAuth: []
  339. summary: 提交实名认证
  340. tags:
  341. - 账户服务
  342. /Account/TokenCheck:
  343. get:
  344. consumes:
  345. - application/json
  346. produces:
  347. - application/json
  348. responses:
  349. "200":
  350. description: 操作成功
  351. schema:
  352. allOf:
  353. - $ref: '#/definitions/response.Response'
  354. - properties:
  355. msg:
  356. type: string
  357. type: object
  358. security:
  359. - ApiKeyAuth: []
  360. summary: Token校验
  361. tags:
  362. - 账户服务
  363. /Account/WillFace:
  364. post:
  365. consumes:
  366. - application/json
  367. parameters:
  368. - description: 入参
  369. in: body
  370. name: data
  371. required: true
  372. schema:
  373. $ref: '#/definitions/request.WillFaceReq'
  374. produces:
  375. - application/json
  376. responses:
  377. "200":
  378. description: 出参
  379. schema:
  380. allOf:
  381. - $ref: '#/definitions/response.Response'
  382. - properties:
  383. data:
  384. type: string
  385. msg:
  386. type: string
  387. type: object
  388. security:
  389. - ApiKeyAuth: []
  390. summary: 个人意愿核身认证
  391. tags:
  392. - 账户服务
  393. /MQ/SendMsgToMQ:
  394. post:
  395. consumes:
  396. - application/json
  397. parameters:
  398. - description: 入参
  399. in: body
  400. name: data
  401. required: true
  402. schema:
  403. $ref: '#/definitions/request.MQBodyReq'
  404. produces:
  405. - application/json
  406. responses:
  407. "200":
  408. description: 出参
  409. schema:
  410. allOf:
  411. - $ref: '#/definitions/response.Response'
  412. - properties:
  413. data:
  414. $ref: '#/definitions/response.MQBodyRsp'
  415. msg:
  416. type: string
  417. type: object
  418. security:
  419. - ApiKeyAuth: []
  420. summary: 总线业务
  421. tags:
  422. - 总线业务
  423. /MQ/SendNtfToMQ:
  424. post:
  425. consumes:
  426. - application/json
  427. parameters:
  428. - description: 入参
  429. in: body
  430. name: data
  431. required: true
  432. schema:
  433. $ref: '#/definitions/request.MQNtfReq'
  434. produces:
  435. - application/json
  436. responses:
  437. "200":
  438. description: 出参
  439. schema:
  440. allOf:
  441. - $ref: '#/definitions/response.Response'
  442. - properties:
  443. msg:
  444. type: string
  445. type: object
  446. summary: 总线通知
  447. tags:
  448. - 总线业务
  449. securityDefinitions:
  450. ApiKeyAuth:
  451. in: header
  452. name: x-token
  453. type: apiKey
  454. swagger: "2.0"