MTP20_ACCESS/docs/swagger.json

{
    "swagger": "2.0",
    "info": {
        "description": "新接入服务",
        "title": "Swagger Example API",
        "contact": {},
        "version": "0.0.1"
    },
    "paths": {
        "/Account/AddUser": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "账户服务"
                ],
                "summary": "实名认证添加用户",
                "parameters": [
                    {
                        "description": "入参",
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.AddUserReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "出参",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/Account/CreateContractAndAddSigner": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "账户服务"
                ],
                "summary": "上传待签署文件和添加签署方",
                "parameters": [
                    {
                        "description": "入参",
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.CreateContractAndAddSignerReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "出参",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "string"
                                        },
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/Account/Login": {
            "post": {
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "账户服务"
                ],
                "summary": "账户登录",
                "parameters": [
                    {
                        "description": "登录入参",
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.LoginReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "返回包括用户信息,token,过期时间",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "$ref": "#/definitions/response.LoginRsp"
                                        },
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/Account/Loginout": {
            "get": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "账户服务"
                ],
                "summary": "用户登出请求",
                "responses": {
                    "200": {
                        "description": "出参",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/Account/QueryUserESignRecord": {
            "get": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "账户服务"
                ],
                "summary": "查询用户电子签记录表",
                "responses": {
                    "200": {
                        "description": "出参",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/definitions/account.Useresignrecord"
                                            }
                                        },
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/Account/SignCompleted": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "账户服务"
                ],
                "summary": "提交实名认证",
                "responses": {
                    "200": {
                        "description": "出参",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/Account/TokenCheck": {
            "get": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "账户服务"
                ],
                "summary": "Token校验",
                "responses": {
                    "200": {
                        "description": "操作成功",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/Account/WillFace": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "账户服务"
                ],
                "summary": "个人意愿核身认证",
                "parameters": [
                    {
                        "description": "入参",
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.WillFaceReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "出参",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "type": "string"
                                        },
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/MQ/SendMsgToMQ": {
            "post": {
                "security": [
                    {
                        "ApiKeyAuth": []
                    }
                ],
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "总线业务"
                ],
                "summary": "总线业务",
                "parameters": [
                    {
                        "description": "入参",
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.MQBodyReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "出参",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "data": {
                                            "$ref": "#/definitions/response.MQBodyRsp"
                                        },
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "/MQ/SendNtfToMQ": {
            "post": {
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "tags": [
                    "总线业务"
                ],
                "summary": "总线通知",
                "parameters": [
                    {
                        "description": "入参",
                        "name": "data",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/request.MQNtfReq"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "出参",
                        "schema": {
                            "allOf": [
                                {
                                    "$ref": "#/definitions/response.Response"
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "msg": {
                                            "type": "string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "account.Useresignrecord": {
            "type": "object",
            "properties": {
                "authinfo": {
                    "description": "认证信息",
                    "type": "string"
                },
                "contractfileaddr": {
                    "description": "合同签署文件地址",
                    "type": "string"
                },
                "contractno": {
                    "description": "合同编号",
                    "type": "string"
                },
                "createtime": {
                    "description": "创建时间",
                    "type": "string"
                },
                "creatorid": {
                    "description": "创建人",
                    "type": "integer"
                },
                "orderindex": {
                    "description": "显示顺序",
                    "type": "integer"
                },
                "recordid": {
                    "description": "记录ID(SEQ_USERESIGNRECORD)",
                    "type": "integer"
                },
                "recordstatus": {
                    "description": "记录状态 - 1:未签署 2：签署中 3：已签署 4：签署拒绝",
                    "type": "integer"
                },
                "signremark": {
                    "description": "签署备注",
                    "type": "string"
                },
                "signurl": {
                    "description": "合同签署URL(三方URL)",
                    "type": "string"
                },
                "templateconfigid": {
                    "description": "模板配置ID",
                    "type": "integer"
                },
                "templatename": {
                    "description": "模板名称",
                    "type": "string"
                },
                "templateno": {
                    "description": "模板编号(电子签类型对应的模板编号)",
                    "type": "string"
                },
                "templatetype": {
                    "description": "模板类型 - 1:实名认证 2:开户协议",
                    "type": "integer"
                },
                "updatetime": {
                    "description": "更新时间",
                    "type": "string"
                },
                "userid": {
                    "description": "用户ID",
                    "type": "integer"
                }
            }
        },
        "request.AddUserReq": {
            "type": "object",
            "required": [
                "idCard",
                "name"
            ],
            "properties": {
                "idCard": {
                    "description": "证件号码",
                    "type": "string"
                },
                "idCardPhoto": {
                    "description": "证件照正面",
                    "type": "string"
                },
                "idCardPhotoBackURL": {
                    "description": "证件照背面",
                    "type": "string"
                },
                "idCardType": {
                    "description": "证件类型（默认1）：1-居民身份证 2-台湾居民来往内地通行证 3-港澳居民往来内地通行证 10-武装警察身份证 11-军人身份证 15-警察（警官）证 21-外国人永久居留证 23-护照",
                    "type": "integer"
                },
                "mobile": {
                    "description": "手机号码",
                    "type": "string"
                },
                "name": {
                    "description": "用户姓名",
                    "type": "string"
                }
            }
        },
        "request.CreateContractAndAddSignerReq": {
            "type": "object",
            "required": [
                "templateNo"
            ],
            "properties": {
                "templateNo": {
                    "description": "合同模板编号",
                    "type": "string"
                }
            }
        },
        "request.LoginReq": {
            "type": "object",
            "required": [
                "clientType",
                "password",
                "userName"
            ],
            "properties": {
                "clientType": {
                    "description": "客户端类型，2-PC交易端 3-手机客户端_安卓 4-网页客户端 5-微信客户端 6-手机客户端_苹果",
                    "type": "integer"
                },
                "password": {
                    "description": "密码",
                    "type": "string"
                },
                "userName": {
                    "description": "用户名，可以是LoginID/LoginCode/手机号码",
                    "type": "string"
                }
            }
        },
        "request.MQBodyReq": {
            "type": "object",
            "required": [
                "data",
                "funCodeReq",
                "isEncrypted"
            ],
            "properties": {
                "data": {
                    "description": "请求数据",
                    "type": "string"
                },
                "funCodeReq": {
                    "description": "请求功能码",
                    "type": "integer"
                },
                "funCodeRsp": {
                    "description": "回复功能码",
                    "type": "integer"
                },
                "isEncrypted": {
                    "description": "是否加密",
                    "type": "boolean"
                }
            }
        },
        "request.MQNtfReq": {
            "type": "object",
            "required": [
                "data",
                "funCode"
            ],
            "properties": {
                "data": {
                    "description": "数据",
                    "type": "string"
                },
                "funCode": {
                    "description": "功能码",
                    "type": "integer"
                },
                "topic": {
                    "description": "主题",
                    "type": "string"
                }
            }
        },
        "request.WillFaceReq": {
            "type": "object",
            "required": [
                "idCardNo",
                "realName"
            ],
            "properties": {
                "idCardNo": {
                    "description": "身份证号",
                    "type": "string"
                },
                "realName": {
                    "description": "真实姓名",
                    "type": "string"
                }
            }
        },
        "response.LoginRsp": {
            "type": "object",
            "properties": {
                "expiresAt": {
                    "description": "过期时间",
                    "type": "integer"
                },
                "loginId": {
                    "description": "登录ID",
                    "type": "integer"
                },
                "token": {
                    "description": "新服务Token",
                    "type": "string"
                },
                "userId": {
                    "description": "用户ID",
                    "type": "integer"
                }
            }
        },
        "response.MQBodyRsp": {
            "type": "object",
            "properties": {
                "data": {
                    "description": "请求数据",
                    "type": "string"
                },
                "funcode": {
                    "description": "回复功能码",
                    "type": "integer"
                },
                "isEncrypted": {
                    "description": "是否加密",
                    "type": "boolean"
                }
            }
        },
        "response.Response": {
            "type": "object",
            "properties": {
                "code": {
                    "type": "integer"
                },
                "data": {},
                "msg": {
                    "type": "string"
                }
            }
        }
    },
    "securityDefinitions": {
        "ApiKeyAuth": {
            "type": "apiKey",
            "name": "x-token",
            "in": "header"
        }
    }
}